Skip to contentSkip to conversation

qapi visitor cleanups (post-introspection cleanups subset E)

PATCH Superseded Eric Blake 5 participants 128 messages Jan 19, 2016 – Feb 17, 2016 Page 1 of 2

Subsystems (3)

v9 of 16 Superseded Latest is v16 →

lore
Share & tools
lore

Eric Blake

author
#0 lore raw

v9 cover qapi visitor cleanups (post-introspection cleanups subset E)

Based on qemu.git master. Pending prerequisites:
+ Not a strong dependency, but for qapi-tests to consistently pass, I needed a race fixed:
https://lists.gnu.org/archive/html/qemu-devel/2015-12/msg01827.html

Also available as a tag at this location:
git fetch git://repo.or.cz/qemu/ericb.git qapi-cleanupv9e

and will soon be part of my branch with the rest of the v5 series, at:
http://repo.or.cz/qemu/ericb.git/shortlog/refs/heads/qapi

v9 notes:
Rebase to master, incorporate findings from Marc-André.

001/37:[----] [--] 'qobject: Document more shortcomings in our number handling' 002/37:[----] [--] 'qapi: Avoid use of misnamed DO_UPCAST()' 003/37:[----] [--] 'qapi: Drop dead dealloc visitor variable' 004/37:[----] [--] 'hmp: Improve use of qapi visitor'
005/37:[----] [--] 'vl: Improve use of qapi visitor'
006/37:[----] [--] 'balloon: Improve use of qapi visitor'
007/37:[0002] [FC] 'qapi: Improve generated event use of qapi visitor' 008/37:[----] [--] 'qapi: Track all failures between visit_start/stop' 009/37:[0005] [FC] 'qapi: Prefer type_int64 over type_int in visitors' 010/37:[0009] [FC] 'qapi: Make all visitors supply uint64 callbacks' 011/37:[----] [--] 'qapi: Consolidate visitor small integer callbacks' 012/37:[----] [--] 'qapi: Don't cast Enum* to int*'
013/37:[----] [--] 'qom: Use typedef for Visitor'
014/37:[0004] [FC] 'qapi: Swap visit_* arguments for consistent 'name' placement' 015/37:[----] [-C] 'qom: Swap 'name' next to visitor in ObjectPropertyAccessor' 016/37:[----] [--] 'qapi: Swap 'name' in visit_* callbacks to match public API' 017/37:[----] [--] 'qapi: Drop unused 'kind' for struct/enum visit' 018/37:[----] [--] 'qapi: Drop unused error argument for list and implicit struct' 019/37:[----] [--] 'qmp: Fix reference-counting of qnull on empty output visit' 020/37:[----] [--] 'qmp: Don't abuse stack to track qmp-output root' 021/37:[----] [--] 'qapi: Document visitor interfaces, add assertions' 022/37:[----] [--] 'qapi: Add visit_type_null() visitor'
023/37:[down] 'qmp: Support explicit null during input visit' 024/37:[0015] [FC] 'qmp: Tighten output visitor rules'
025/37:[----] [--] 'spapr_drc: Expose 'null' in qom-get when there is no fdt' 026/37:[----] [--] 'qapi: Simplify excess input reporting in input visitors' 027/37:[----] [--] 'qapi: Add type.is_empty() helper'
028/37:[----] [--] 'qapi: Fix command with named empty argument type' 029/37:[----] [--] 'qapi: Eliminate empty visit_type_FOO_fields' 030/37:[0013] [FC] 'qapi: Canonicalize missing object to :empty' 031/37:[----] [--] 'qapi-visit: Unify struct and union visit' 032/37:[----] [--] 'qapi: Rework deallocation of partial struct' 033/37:[0003] [FC] 'qapi: Split visit_end_struct() into pieces' 034/37:[----] [--] 'qapi: Simplify semantics of visit_next_list()' 035/37:[0006] [FC] 'qapi: Change visit_type_FOO() to no longer return partial objects' 036/37:[----] [--] 'RFC: qapi: Adjust layout of FooList types' 037/37:[down] 'qapi: Update docs to match recent generator changes'

v8 notes:
https://lists.gnu.org/archive/html/qemu-devel/2015-12/msg03863.html
Four new patches (13-16/35), plus rebasing on top of them, so that the code base now consistently passes a 'v, name' pair anywhere a visitor needs a name, rather than putting other arguments in between
the pair. I got to have fun with Coccinelle Also fix a bug in my
changes to visit_next_list() (v7 29/31), so that 'make check' and qemu-iotests now pass at all points in the series.

The parameter ordering changes have the potential to be a rebase magnet, so I'm hoping this series can go in relatively soon after Markus returns from break.

I made good on my threat in v7 of writing a qapi-to-JSON output visitor, but that will remain a separate series based on this one (the only posting of that series so far now needs rebasing:
https://lists.gnu.org/archive/html/qemu-devel/2015-12/msg01760.html)

v7 notes:
https://lists.gnu.org/archive/html/qemu-devel/2015-12/msg01181.html

v6 notes:
https://lists.gnu.org/archive/html/qemu-devel/2015-11/msg05793.html

v5 and earlier - look in the mail archives

Eric Blake (37):
qobject: Document more shortcomings in our number handling
qapi: Avoid use of misnamed DO_UPCAST()
qapi: Drop dead dealloc visitor variable
hmp: Improve use of qapi visitor
vl: Improve use of qapi visitor
balloon: Improve use of qapi visitor
qapi: Improve generated event use of qapi visitor
qapi: Track all failures between visit_start/stop
qapi: Prefer type_int64 over type_int in visitors
qapi: Make all visitors supply uint64 callbacks
qapi: Consolidate visitor small integer callbacks
qapi: Don't cast Enum* to int*
qom: Use typedef for Visitor
qapi: Swap visit_* arguments for consistent 'name' placement
qom: Swap 'name' next to visitor in ObjectPropertyAccessor
qapi: Swap 'name' in visit_* callbacks to match public API
qapi: Drop unused 'kind' for struct/enum visit
qapi: Drop unused error argument for list and implicit struct
qmp: Fix reference-counting of qnull on empty output visit
qmp: Don't abuse stack to track qmp-output root
qapi: Document visitor interfaces, add assertions
qapi: Add visit_type_null() visitor
qmp: Support explicit null during input visit
qmp: Tighten output visitor rules
spapr_drc: Expose 'null' in qom-get when there is no fdt
qapi: Simplify excess input reporting in input visitors
qapi: Add type.is_empty() helper
qapi: Fix command with named empty argument type
qapi: Eliminate empty visit_type_FOO_fields
qapi: Canonicalize missing object to :empty
qapi-visit: Unify struct and union visit
qapi: Rework deallocation of partial struct
qapi: Split visit_end_struct() into pieces
qapi: Simplify semantics of visit_next_list()
qapi: Change visit_type_FOO() to no longer return partial objects
RFC: qapi: Adjust layout of FooList types
qapi: Update docs to match recent generator changes

 backends/hostmem.c                      |  24 +--
 block/qapi.c                            |   2 +-
 blockdev.c                              |   4 +-
 bootdevice.c                            |  12 +-
 docs/qapi-code-gen.txt                  | 130 +++++++-----
 hmp.c                                   |  23 ++-
 hw/acpi/core.c                          |   4 +-
 hw/acpi/ich9.c                          |  49 ++---
 hw/block/nvme.c                         |  12 +-
 hw/core/machine.c                       |  24 +--
 hw/core/qdev-properties-system.c        |  44 ++--
 hw/core/qdev-properties.c               | 180 ++++++++--------
 hw/core/qdev.c                          |   7 +-
 hw/i386/pc.c                            |  43 ++--
 hw/ide/qdev.c                           |  12 +-
 hw/intc/xics.c                          |  20 +-
 hw/isa/lpc_ich9.c                       |   7 +-
 hw/mem/pc-dimm.c                        |   6 +-
 hw/misc/edu.c                           |   6 +-
 hw/misc/tmp105.c                        |  12 +-
 hw/net/ne2000-isa.c                     |  14 +-
 hw/pci-host/piix.c                      |  18 +-
 hw/pci-host/q35.c                       |  23 +--
 hw/ppc/spapr_drc.c                      |  43 ++--
 hw/usb/dev-storage.c                    |  12 +-
 hw/virtio/virtio-balloon.c              |  43 ++--
 include/qapi/qmp-output-visitor.h       |   1 +
 include/qapi/visitor-impl.h             | 106 ++++++----
 include/qapi/visitor.h                  | 298 ++++++++++++++++++++++++---
 include/qom/object.h                    |  13 +-
 memory.c                                |  26 +--
 net/dump.c                              |  12 +-
 net/filter-buffer.c                     |  14 +-
 net/net.c                               |   4 +-
 numa.c                                  |   6 +-
 qapi/opts-visitor.c                     | 121 ++++++-----
 qapi/qapi-dealloc-visitor.c             | 108 ++++------
 qapi/qapi-visit-core.c                  | 352 +++++++++++++++++---------------
 qapi/qmp-input-visitor.c                | 188 ++++++++++-------
 qapi/qmp-output-visitor.c               | 166 +++++++--------
 qapi/string-input-visitor.c             |  93 +++++----
 qapi/string-output-visitor.c            |  88 ++++----
 qemu-img.c                              |  11 +-
 qobject/json-parser.c                   |   4 +-
 qobject/qjson.c                         |   8 +-
 qom/object.c                            | 129 ++++++------
 replay/replay-input.c                   |   4 +-
 scripts/qapi-commands.py                |  21 +-
 scripts/qapi-event.py                   |  22 +-
 scripts/qapi-types.py                   |  13 +-
 scripts/qapi-visit.py                   | 264 ++++++++++++------------
 scripts/qapi.py                         |  37 ++--
 target-i386/cpu.c                       |  96 ++++-----
 target-ppc/translate_init.c             |  12 +-
 tests/qapi-schema/event-case.out        |   2 +-
 tests/qapi-schema/flat-union-empty.out  |   1 +
 tests/qapi-schema/ident-with-escape.out |   1 +
 tests/qapi-schema/indented-expr.out     |   4 +-
 tests/qapi-schema/qapi-schema-test.json |   2 +
 tests/qapi-schema/qapi-schema-test.out  |  47 ++++-
 tests/qapi-schema/union-clash-data.out  |   2 +
 tests/qapi-schema/union-empty.out       |   1 +
 tests/test-opts-visitor.c               |   6 +-
 tests/test-qdev-global-props.c          |  18 +-
 tests/test-qmp-commands.c               |  20 +-
 tests/test-qmp-input-strict.c           |  47 ++---
 tests/test-qmp-input-visitor.c          | 117 ++++++-----
 tests/test-qmp-output-visitor.c         |  38 ++--
 tests/test-string-input-visitor.c       |  34 +--
 tests/test-string-output-visitor.c      |  16 +-
 tests/test-visitor-serialization.c      |  54 ++---
 util/qemu-sockets.c                     |   4 +-
 vl.c                                    |  29 +--
 73 files changed, 1920 insertions(+), 1514 deletions(-)
Signature · 1 line
2.5.0
author
#1 lore raw

PATCH v9 1/37 qobject: Document more shortcomings in our number handling

We've already documented that our JSON parsing is locale dependent; but we should also document that our JSON output has the same problem. Additionally, JSON requires finite values (you have to upgrade to JSON5 to get support for Inf or NaN), and our output risks truncating floating point numbers to the point of losing significant precision.

Sadly, this series is not going to be the one that addresses these problems.

Fix some trailing whitespace I noticed in the vicinity.

---
v9: no change
v8: no change
v7: new patch

---
 qobject/json-parser.c | 4 +++-
 qobject/qjson.c       | 8 +++++++-
 2 files changed, 10 insertions(+), 2 deletions(-)
qobject/json-parser.c +3 -1
index 3c5d35d..6ab98a7 100644
@@ -1,5 +1,5 @@
 /*
- * JSON Parser 
+ * JSON Parser
  *
  * Copyright IBM, Corp. 2009
  *
@@ -519,6 +519,8 @@ static QObject *parse_literal(JSONParserContext *ctxt)
     }
     case JSON_FLOAT:
         /* FIXME dependent on locale */
+        /* FIXME our lexer matches RFC7159 in forbidding Inf or NaN,
+         * but those might be useful extensions beyond JSON */
         return QOBJECT(qfloat_from_double(strtod(token->str, NULL)));
     default:
         abort();
qobject/qjson.c +7 -1
index a3e6a7c..41d9d65 100644
@@ -237,6 +237,12 @@ static void to_json(const QObject *obj, QString *str, int pretty, int indent)
         char buffer[1024];
         int len;
 
+        /* FIXME: snprintf() is locale dependent; but JSON requires
+         * numbers to be formatted as if in the C locale. */
+        /* FIXME: This risks printing Inf or NaN, which are not valid
+         * JSON values. */
+        /* FIXME: the default precision of %f may be insufficient to
+         * tell this number apart from others. */
         len = snprintf(buffer, sizeof(buffer), "%f", qfloat_get_double(val));
         while (len > 0 && buffer[len - 1] == '0') {
             len--;
@@ -247,7 +253,7 @@ static void to_json(const QObject *obj, QString *str, int pretty, int indent)
         } else {
             buffer[len] = 0;
         }
-        
+
         qstring_append(str, buffer);
         break;
     }
Signature · 1 line
2.5.0
#2 lore raw

Re: [Qemu-devel] [PATCH v9 01/37] qobject: Document more shortcomings in our number handling

Quoted 36 lines · Eric Blake

We've already documented that our JSON parsing is locale dependent; but we should also document that our JSON output has the same problem. Additionally, JSON requires finite values (you have to upgrade to JSON5 to get support for Inf or NaN), and our output risks truncating floating point numbers to the point of losing significant precision.

Sadly, this series is not going to be the one that addresses these problems.

Fix some trailing whitespace I noticed in the vicinity.

---
v9: no change
v8: no change
v7: new patch

---
 qobject/json-parser.c | 4 +++-
 qobject/qjson.c       | 8 +++++++-
 2 files changed, 10 insertions(+), 2 deletions(-)
qobject/json-parser.c +1 -1
index 3c5d35d..6ab98a7 100644
@@ -1,5 +1,5 @@
 /*
- * JSON Parser 
+ * JSON Parser
  *
  * Copyright IBM, Corp. 2009
  *

qobject/json-parser.c static QObject *parse_literal(JSONParserContext *ctxt) · line 522

Quoted 4 lines
qobject/json-parser.c +1 -0
@@ -519,6 +519,8 @@ static QObject *parse_literal(JSONParserContext *ctxt)
     }
     case JSON_FLOAT:
         /* FIXME dependent on locale */
+        /* FIXME our lexer matches RFC7159 in forbidding Inf or NaN,

For what it's worth, the RFC spells this "RFC 7159".

Quoted 9 lines
qobject/json-parser.c +1 -0
+         * but those might be useful extensions beyond JSON */
         return QOBJECT(qfloat_from_double(strtod(token->str, NULL)));
     default:
         abort();
qobject/qjson.c +0 -0
index a3e6a7c..41d9d65 100644

qobject/qjson.c static void to_json(const QObject *obj, QString *str, int pretty, int indent) · line 241

Quoted 5 lines
qobject/qjson.c +2 -0
@@ -237,6 +237,12 @@ static void to_json(const QObject *obj, QString *str, int pretty, int indent)
         char buffer[1024];
         int len;
 
+        /* FIXME: snprintf() is locale dependent; but JSON requires
+         * numbers to be formatted as if in the C locale. */

The new FIXME matches the existing one in parse_literal(), visible above.

However, dependence on C locale is a pervasive issue in QEMU. These two comments could give readers the idea that it's an issue just here. Suggest to add something like "Dependence on C locale is a pervasive issue in QEMU."

qobject/qjson.c static void to_json(const QObject *obj, QString *str, int pretty, int indent) · line 245

Quoted 4 lines
qobject/qjson.c +4 -0
+        /* FIXME: This risks printing Inf or NaN, which are not valid
+         * JSON values. */
+        /* FIXME: the default precision of %f may be insufficient to
+         * tell this number apart from others. */

Yup.

The easy way to avoid loss of precision is %a, but of course that's way too much sophistication for JSON.

Avoiding loss of precision with a decimal format is non-trivial; see Steele, Jr., Guy L., and White, Jon L. How to print floating-point numbers accurately, SIGPLAN ’90, and later improvements collected here:
http://stackoverflow.com/questions/7153979/algorithm-to-convert-an-ieee-754-double-to-a-string

Quoted 12 lines
qobject/qjson.c +1 -1
         len = snprintf(buffer, sizeof(buffer), "%f", qfloat_get_double(val));
         while (len > 0 && buffer[len - 1] == '0') {
             len--;
@@ -247,7 +253,7 @@ static void to_json(const QObject *obj, QString *str, int pretty, int indent)
         } else {
             buffer[len] = 0;
         }
-        
+
         qstring_append(str, buffer);
         break;
     }
author
#3 lore raw

Re: [Qemu-devel] [PATCH v9 01/37] qobject: Document more shortcomings in our number handling

Quoted 7 lines · Markus Armbruster

qobject/json-parser.c static QObject *parse_literal(JSONParserContext *ctxt) · line 522

Quoted 5 lines
qobject/json-parser.c +1 -0
@@ -519,6 +519,8 @@ static QObject *parse_literal(JSONParserContext *ctxt)
     }
     case JSON_FLOAT:
         /* FIXME dependent on locale */
+        /* FIXME our lexer matches RFC7159 in forbidding Inf or NaN,

For what it's worth, the RFC spells this "RFC 7159".

Looks like we use space more often than not, but that we're inconsistent. For example:

slirp/tcp.h: * Per RFC 793, September, 1981.
slirp/tcp.h: * Per RFC793, September, 1981.

Will fix if I need to respin, otherwise I assume you can do it.

Quoted 10 lines

qobject/qjson.c static void to_json(const QObject *obj, QString *str, int pretty, int indent) · line 241

Quoted 2 lines
qobject/qjson.c +2 -0
+        /* FIXME: snprintf() is locale dependent; but JSON requires
+         * numbers to be formatted as if in the C locale. */

The new FIXME matches the existing one in parse_literal(), visible above.

However, dependence on C locale is a pervasive issue in QEMU. These two comments could give readers the idea that it's an issue just here. Suggest to add something like "Dependence on C locale is a pervasive issue in QEMU."

Good idea.

Quoted 8 lines

qobject/qjson.c static void to_json(const QObject *obj, QString *str, int pretty, int indent) · line 245

Quoted 5 lines
qobject/qjson.c +4 -0
+        /* FIXME: This risks printing Inf or NaN, which are not valid
+         * JSON values. */
+        /* FIXME: the default precision of %f may be insufficient to
+         * tell this number apart from others. */

Yup.

Quoted 7 lines

The easy way to avoid loss of precision is %a, but of course that's way too much sophistication for JSON.

Avoiding loss of precision with a decimal format is non-trivial; see Steele, Jr., Guy L., and White, Jon L. How to print floating-point numbers accurately, SIGPLAN ’90, and later improvements collected here:
http://stackoverflow.com/questions/7153979/algorithm-to-convert-an-ieee-754-double-to-a-string

Ah, memories. I read and implemented that paper when working on the jikes compiler for the Java language back in the late nineties, as it is the Java language specification which had the very neat property of requiring the shortest decimal string that will unambiguously round back to the same floating point pattern.

One alternative is to always output a guaranteed unambiguous decimal string (although not necessarily the shortest), by using %.17f, using <float.h> DBL_DECIMAL_DIG. (Note that DBL_DIG of 15 is NOT sufficient - it is the lower limit that says that a decimal->float->decimal will not change the decimal; but we want the converse where a float->decimal->float will not change the float. There are stretches of numbers where the pigeonhole principle applies; you can think of it this
way: there is no way to map all possible 2^10 (1024) binary values inside 2^3 (1000) decimal digits without at least 24 of them needing one more decimal digit. But by the same arguments, DBL_DECIMAL_DIG is an upper limit and usually more than you need.)

So, the question is whether we want to always output 17 digits, or whether we want to do the poor-man's truncation scheme (easy to understand, but not optimal use of the processor), or go all the way to the algorithm of that paper (faster but lots harder to understand). For reference, here's the poor-man's algorithm in pseudocode:

if 0, inf, nan:
special case
else:
Obtain the DBL_DECIMAL_DIG string via sprintf %.17f i = 17;
do {
truncate the original string to i-1 decimal characters parse that with strtod()
if the bit pattern differs:
break;
} while (--i);
assert(i)
use i digits of the string

As a separate patch, of course, but I have a pending patch that provides a single place where we could drop in such an improvement:
https://lists.gnu.org/archive/html/qemu-devel/2015-12/msg03932.html

Signature · 2 lines
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org
#4 lore raw

Re: [Qemu-devel] [PATCH v9 01/37] qobject: Document more shortcomings in our number handling

Quoted 10 lines · Eric Blake
Quoted 7 lines · Markus Armbruster

qobject/json-parser.c static QObject *parse_literal(JSONParserContext *ctxt) · line 522

Quoted 5 lines
qobject/json-parser.c +1 -0
@@ -519,6 +519,8 @@ static QObject *parse_literal(JSONParserContext *ctxt)
     }
     case JSON_FLOAT:
         /* FIXME dependent on locale */
+        /* FIXME our lexer matches RFC7159 in forbidding Inf or NaN,

For what it's worth, the RFC spells this "RFC 7159".

Quoted 7 lines

Looks like we use space more often than not, but that we're inconsistent. For example:

slirp/tcp.h: * Per RFC 793, September, 1981.
slirp/tcp.h: * Per RFC793, September, 1981.

Will fix if I need to respin, otherwise I assume you can do it.

Okay.

Quoted 47 lines
Quoted 10 lines

qobject/qjson.c static void to_json(const QObject *obj, QString *str, int pretty, int indent) · line 241

Quoted 2 lines
qobject/qjson.c +2 -0
+        /* FIXME: snprintf() is locale dependent; but JSON requires
+         * numbers to be formatted as if in the C locale. */

The new FIXME matches the existing one in parse_literal(), visible above.

However, dependence on C locale is a pervasive issue in QEMU. These two comments could give readers the idea that it's an issue just here. Suggest to add something like "Dependence on C locale is a pervasive issue in QEMU."

Good idea.

Quoted 8 lines

qobject/qjson.c static void to_json(const QObject *obj, QString *str, int pretty, int indent) · line 245

Quoted 5 lines
qobject/qjson.c +4 -0
+        /* FIXME: This risks printing Inf or NaN, which are not valid
+         * JSON values. */
+        /* FIXME: the default precision of %f may be insufficient to
+         * tell this number apart from others. */

Yup.

Quoted 7 lines

The easy way to avoid loss of precision is %a, but of course that's way too much sophistication for JSON.

Avoiding loss of precision with a decimal format is non-trivial; see Steele, Jr., Guy L., and White, Jon L. How to print floating-point numbers accurately, SIGPLAN ’90, and later improvements collected here:
http://stackoverflow.com/questions/7153979/algorithm-to-convert-an-ieee-754-double-to-a-string

Ah, memories. I read and implemented that paper when working on the jikes compiler for the Java language back in the late nineties, as it is the Java language specification which had the very neat property of requiring the shortest decimal string that will unambiguously round back to the same floating point pattern.

One alternative is to always output a guaranteed unambiguous decimal string (although not necessarily the shortest), by using %.17f, using <float.h> DBL_DECIMAL_DIG. (Note that DBL_DIG of 15 is NOT sufficient - it is the lower limit that says that a decimal->float->decimal will not change the decimal; but we want the converse where a float->decimal->float will not change the float. There are stretches of numbers where the pigeonhole principle applies; you can think of it this
way: there is no way to map all possible 2^10 (1024) binary values inside 2^3 (1000) decimal digits without at least 24 of them needing one more decimal digit. But by the same arguments, DBL_DECIMAL_DIG is an upper limit and usually more than you need.)

Quoted 5 lines

So, the question is whether we want to always output 17 digits, or whether we want to do the poor-man's truncation scheme (easy to understand, but not optimal use of the processor), or go all the way to the algorithm of that paper (faster but lots harder to understand). For reference, here's the poor-man's algorithm in pseudocode:

I don't think we want to implement floating-point formatting ourselves.

Quoted 5 lines

if 0, inf, nan:
special case
else:
Obtain the DBL_DECIMAL_DIG string via sprintf %.17f i = 17;

Quoted 8 lines

do {
truncate the original string to i-1 decimal characters parse that with strtod()
if the bit pattern differs:
break;
} while (--i);
assert(i)
use i digits of the string

That's a lot of strtod()... May not be noticable if we write the result to a slowish sink. Binary search could save a few.

Naive idea: chop off trailing '0'?

Quoted 3 lines

As a separate patch, of course, but I have a pending patch that provides a single place where we could drop in such an improvement:
https://lists.gnu.org/archive/html/qemu-devel/2015-12/msg03932.html

Definitely separate.

author
#5 lore raw

Re: [Qemu-devel] [PATCH v9 01/37] qobject: Document more shortcomings in our number handling

Quoted 12 lines · Markus Armbruster
Quoted 12 lines

One alternative is to always output a guaranteed unambiguous decimal string (although not necessarily the shortest), by using %.17f, using <float.h> DBL_DECIMAL_DIG. (Note that DBL_DIG of 15 is NOT sufficient - it is the lower limit that says that a decimal->float->decimal will not change the decimal; but we want the converse where a float->decimal->float will not change the float. There are stretches of numbers where the pigeonhole principle applies; you can think of it this
way: there is no way to map all possible 2^10 (1024) binary values inside 2^3 (1000) decimal digits without at least 24 of them needing one more decimal digit. But by the same arguments, DBL_DECIMAL_DIG is an upper limit and usually more than you need.)

Quoted 7 lines
Quoted 5 lines

So, the question is whether we want to always output 17 digits, or whether we want to do the poor-man's truncation scheme (easy to understand, but not optimal use of the processor), or go all the way to the algorithm of that paper (faster but lots harder to understand). For reference, here's the poor-man's algorithm in pseudocode:

I don't think we want to implement floating-point formatting ourselves.

Well, we already have _some_ level of floating-point support built in for TCG emulation of floating point on various architectures. I don't know how much would be easily reusable for this case, though.

Quoted 15 lines
Quoted 14 lines

if 0, inf, nan:
special case
else:
Obtain the DBL_DECIMAL_DIG string via sprintf %.17f i = 17;
do {
truncate the original string to i-1 decimal characters parse that with strtod()
if the bit pattern differs:
break;
} while (--i);
assert(i)
use i digits of the string

Quoted 4 lines

That's a lot of strtod()... May not be noticable if we write the result to a slowish sink. Binary search could save a few.

Naive idea: chop off trailing '0'?

That, and rounding trailing '9'. Any other digits in positions 1-16 are significant (other digits in position 17 might not matter, though), so I guess a full 17 iterations is probably not strictly necessary. Our current code DOES chop trailing '0', but starting from the flawed premise that 6 digits was enough precision.

Quoted 6 lines
Quoted 4 lines

As a separate patch, of course, but I have a pending patch that provides a single place where we could drop in such an improvement:
https://lists.gnu.org/archive/html/qemu-devel/2015-12/msg03932.html

Definitely separate.

Okay, all thoughts for a later day :)

Signature · 2 lines
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org
#6 lore raw

Re: [Qemu-devel] [PATCH v9 01/37] qobject: Document more shortcomings in our number handling

In reply to Markus Armbruster
Quoted 69 lines · Markus Armbruster
Quoted 10 lines · Eric Blake
Quoted 7 lines · Markus Armbruster

qobject/json-parser.c static QObject *parse_literal(JSONParserContext *ctxt) · line 522

Quoted 5 lines
qobject/json-parser.c +1 -0
@@ -519,6 +519,8 @@ static QObject *parse_literal(JSONParserContext *ctxt)
     }
     case JSON_FLOAT:
         /* FIXME dependent on locale */
+        /* FIXME our lexer matches RFC7159 in forbidding Inf or NaN,

For what it's worth, the RFC spells this "RFC 7159".

Quoted 7 lines

Looks like we use space more often than not, but that we're inconsistent. For example:

slirp/tcp.h: * Per RFC 793, September, 1981.
slirp/tcp.h: * Per RFC793, September, 1981.

Will fix if I need to respin, otherwise I assume you can do it.

Okay.

Quoted 47 lines
Quoted 10 lines

qobject/qjson.c static void to_json(const QObject *obj, QString *str, int pretty, int indent) · line 241

Quoted 2 lines
qobject/qjson.c +2 -0
+        /* FIXME: snprintf() is locale dependent; but JSON requires
+         * numbers to be formatted as if in the C locale. */

The new FIXME matches the existing one in parse_literal(), visible above.

However, dependence on C locale is a pervasive issue in QEMU. These two comments could give readers the idea that it's an issue just here. Suggest to add something like "Dependence on C locale is a pervasive issue in QEMU."

Good idea.

Quoted 8 lines

qobject/qjson.c static void to_json(const QObject *obj, QString *str, int pretty, int indent) · line 245

Quoted 5 lines
qobject/qjson.c +4 -0
+        /* FIXME: This risks printing Inf or NaN, which are not valid
+         * JSON values. */
+        /* FIXME: the default precision of %f may be insufficient to
+         * tell this number apart from others. */

Yup.

Quoted 7 lines

The easy way to avoid loss of precision is %a, but of course that's way too much sophistication for JSON.

Avoiding loss of precision with a decimal format is non-trivial; see Steele, Jr., Guy L., and White, Jon L. How to print floating-point numbers accurately, SIGPLAN ’90, and later improvements collected here:
http://stackoverflow.com/questions/7153979/algorithm-to-convert-an-ieee-754-double-to-a-string

Ah, memories. I read and implemented that paper when working on the jikes compiler for the Java language back in the late nineties, as it is the Java language specification which had the very neat property of requiring the shortest decimal string that will unambiguously round back to the same floating point pattern.

One alternative is to always output a guaranteed unambiguous decimal string (although not necessarily the shortest), by using %.17f, using <float.h> DBL_DECIMAL_DIG. (Note that DBL_DIG of 15 is NOT sufficient - it is the lower limit that says that a decimal->float->decimal will not change the decimal; but we want the converse where a float->decimal->float will not change the float. There are stretches of numbers where the pigeonhole principle applies; you can think of it this
way: there is no way to map all possible 2^10 (1024) binary values inside 2^3 (1000) decimal digits without at least 24 of them needing one more decimal digit. But by the same arguments, DBL_DECIMAL_DIG is an upper limit and usually more than you need.)

Quoted 7 lines
Quoted 5 lines

So, the question is whether we want to always output 17 digits, or whether we want to do the poor-man's truncation scheme (easy to understand, but not optimal use of the processor), or go all the way to the algorithm of that paper (faster but lots harder to understand). For reference, here's the poor-man's algorithm in pseudocode:

I don't think we want to implement floating-point formatting ourselves.

FWIW in libvirt we use per-thread locale switching, so that we can flip into the C locale temporarily when formatting doubles. If those are not available we have a bit of a nasty hack to post-process the locale dependant string back into what we (hope) is C-locale formatting. We don't do anything aobut the Inf/NaN problem though.

http://libvirt.org/git/?p=libvirt.git;a=blob;f=src/util/virutil.c;h=bb9604a0c1ffb9c99e454e84878a8c376f773046;hb=HEAD#l454

Regards,
Daniel

Signature · 4 lines
|: http://berrange.com      -o-    http://www.flickr.com/photos/dberrange/ :|
|: http://libvirt.org              -o-             http://virt-manager.org :|
|: http://autobuild.org       -o-         http://search.cpan.org/~danberr/ :|
|: http://entangle-photo.org       -o-       http://live.gnome.org/gtk-vnc :|
author
#7 lore raw

PATCH v9 2/37 qapi: Avoid use of misnamed DO_UPCAST()

In reply to Eric Blake

The macro DO_UPCAST() is incorrectly named: it converts from a parent class to a derived class (which is a downcast). Better, and more consistent with some of the other qapi visitors, is to use the container_of() macro through a to_FOO() helper.

Our current definition of container_of() is weaker than DO_UPCAST(), in that it does not require the derived class to have Visitor as its first member, but this does not hurt our usage patterns in qapi visitors.

---
v9: no change
v8: no change
v7: new patch

---
 qapi/opts-visitor.c          | 28 +++++++++++++++++-----------
 qapi/string-input-visitor.c  | 23 ++++++++++++++---------
 qapi/string-output-visitor.c | 21 +++++++++++++--------
 3 files changed, 44 insertions(+), 28 deletions(-)
qapi/opts-visitor.c +17 -11
index ef5fb8b..dd4094c 100644
@@ -89,6 +89,12 @@ struct OptsVisitor
 };
 
 
+static OptsVisitor *to_ov(Visitor *v)
+{
+    return container_of(v, OptsVisitor, visitor);
+}
+
+
 static void
 destroy_list(gpointer list)
 {
@@ -121,7 +127,7 @@ static void
 opts_start_struct(Visitor *v, void **obj, const char *kind,
                   const char *name, size_t size, Error **errp)
 {
-    OptsVisitor *ov = DO_UPCAST(OptsVisitor, visitor, v);
+    OptsVisitor *ov = to_ov(v);
     const QemuOpt *opt;
 
     if (obj) {
@@ -160,7 +166,7 @@ ghr_true(gpointer ign_key, gpointer ign_value, gpointer ign_user_data)
 static void
 opts_end_struct(Visitor *v, Error **errp)
 {
-    OptsVisitor *ov = DO_UPCAST(OptsVisitor, visitor, v);
+    OptsVisitor *ov = to_ov(v);
     GQueue *any;
 
     if (--ov->depth > 0) {
@@ -202,7 +208,7 @@ lookup_distinct(const OptsVisitor *ov, const char *name, Error **errp)
 static void
 opts_start_list(Visitor *v, const char *name, Error **errp)
 {
-    OptsVisitor *ov = DO_UPCAST(OptsVisitor, visitor, v);
+    OptsVisitor *ov = to_ov(v);
 
     /* we can't traverse a list in a list */
     assert(ov->list_mode == LM_NONE);
@@ -216,7 +222,7 @@ opts_start_list(Visitor *v, const char *name, Error **errp)
 static GenericList *
 opts_next_list(Visitor *v, GenericList **list, Error **errp)
 {
-    OptsVisitor *ov = DO_UPCAST(OptsVisitor, visitor, v);
+    OptsVisitor *ov = to_ov(v);
     GenericList **link;
 
     switch (ov->list_mode) {
@@ -265,7 +271,7 @@ opts_next_list(Visitor *v, GenericList **list, Error **errp)
 static void
 opts_end_list(Visitor *v, Error **errp)
 {
-    OptsVisitor *ov = DO_UPCAST(OptsVisitor, visitor, v);
+    OptsVisitor *ov = to_ov(v);
 
     assert(ov->list_mode == LM_STARTED ||
            ov->list_mode == LM_IN_PROGRESS ||
@@ -307,7 +313,7 @@ processed(OptsVisitor *ov, const char *name)
 static void
 opts_type_str(Visitor *v, char **obj, const char *name, Error **errp)
 {
-    OptsVisitor *ov = DO_UPCAST(OptsVisitor, visitor, v);
+    OptsVisitor *ov = to_ov(v);
     const QemuOpt *opt;
 
     opt = lookup_scalar(ov, name, errp);
@@ -323,7 +329,7 @@ opts_type_str(Visitor *v, char **obj, const char *name, Error **errp)
 static void
 opts_type_bool(Visitor *v, bool *obj, const char *name, Error **errp)
 {
-    OptsVisitor *ov = DO_UPCAST(OptsVisitor, visitor, v);
+    OptsVisitor *ov = to_ov(v);
     const QemuOpt *opt;
 
     opt = lookup_scalar(ov, name, errp);
@@ -356,7 +362,7 @@ opts_type_bool(Visitor *v, bool *obj, const char *name, Error **errp)
 static void
 opts_type_int(Visitor *v, int64_t *obj, const char *name, Error **errp)
 {
-    OptsVisitor *ov = DO_UPCAST(OptsVisitor, visitor, v);
+    OptsVisitor *ov = to_ov(v);
     const QemuOpt *opt;
     const char *str;
     long long val;
@@ -412,7 +418,7 @@ opts_type_int(Visitor *v, int64_t *obj, const char *name, Error **errp)
 static void
 opts_type_uint64(Visitor *v, uint64_t *obj, const char *name, Error **errp)
 {
-    OptsVisitor *ov = DO_UPCAST(OptsVisitor, visitor, v);
+    OptsVisitor *ov = to_ov(v);
     const QemuOpt *opt;
     const char *str;
     unsigned long long val;
@@ -464,7 +470,7 @@ opts_type_uint64(Visitor *v, uint64_t *obj, const char *name, Error **errp)
 static void
 opts_type_size(Visitor *v, uint64_t *obj, const char *name, Error **errp)
 {
-    OptsVisitor *ov = DO_UPCAST(OptsVisitor, visitor, v);
+    OptsVisitor *ov = to_ov(v);
     const QemuOpt *opt;
     int64_t val;
     char *endptr;
@@ -490,7 +496,7 @@ opts_type_size(Visitor *v, uint64_t *obj, const char *name, Error **errp)
 static void
 opts_optional(Visitor *v, bool *present, const char *name)
 {
-    OptsVisitor *ov = DO_UPCAST(OptsVisitor, visitor, v);
+    OptsVisitor *ov = to_ov(v);
 
     /* we only support a single mandatory scalar field in a list node */
     assert(ov->list_mode == LM_NONE);
qapi/string-input-visitor.c +14 -9
index dee780a..7f5645b 100644
@@ -32,6 +32,11 @@ struct StringInputVisitor
     const char *string;
 };
 
+static StringInputVisitor *to_siv(Visitor *v)
+{
+    return container_of(v, StringInputVisitor, visitor);
+}
+
 static void free_range(void *range, void *dummy)
 {
     g_free(range);
@@ -120,7 +125,7 @@ error:
 static void
 start_list(Visitor *v, const char *name, Error **errp)
 {
-    StringInputVisitor *siv = DO_UPCAST(StringInputVisitor, visitor, v);
+    StringInputVisitor *siv = to_siv(v);
 
     parse_str(siv, errp);
 
@@ -136,7 +141,7 @@ start_list(Visitor *v, const char *name, Error **errp)
 static GenericList *
 next_list(Visitor *v, GenericList **list, Error **errp)
 {
-    StringInputVisitor *siv = DO_UPCAST(StringInputVisitor, visitor, v);
+    StringInputVisitor *siv = to_siv(v);
     GenericList **link;
     Range *r;
 
@@ -175,14 +180,14 @@ next_list(Visitor *v, GenericList **list, Error **errp)
 static void
 end_list(Visitor *v, Error **errp)
 {
-    StringInputVisitor *siv = DO_UPCAST(StringInputVisitor, visitor, v);
+    StringInputVisitor *siv = to_siv(v);
     siv->head = true;
 }
 
 static void parse_type_int(Visitor *v, int64_t *obj, const char *name,
                            Error **errp)
 {
-    StringInputVisitor *siv = DO_UPCAST(StringInputVisitor, visitor, v);
+    StringInputVisitor *siv = to_siv(v);
 
     if (!siv->string) {
         error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
@@ -224,7 +229,7 @@ error:
 static void parse_type_size(Visitor *v, uint64_t *obj, const char *name,
                             Error **errp)
 {
-    StringInputVisitor *siv = DO_UPCAST(StringInputVisitor, visitor, v);
+    StringInputVisitor *siv = to_siv(v);
     Error *err = NULL;
     uint64_t val;
 
@@ -246,7 +251,7 @@ static void parse_type_size(Visitor *v, uint64_t *obj, const char *name,
 static void parse_type_bool(Visitor *v, bool *obj, const char *name,
                             Error **errp)
 {
-    StringInputVisitor *siv = DO_UPCAST(StringInputVisitor, visitor, v);
+    StringInputVisitor *siv = to_siv(v);
 
     if (siv->string) {
         if (!strcasecmp(siv->string, "on") ||
@@ -270,7 +275,7 @@ static void parse_type_bool(Visitor *v, bool *obj, const char *name,
 static void parse_type_str(Visitor *v, char **obj, const char *name,
                            Error **errp)
 {
-    StringInputVisitor *siv = DO_UPCAST(StringInputVisitor, visitor, v);
+    StringInputVisitor *siv = to_siv(v);
     if (siv->string) {
         *obj = g_strdup(siv->string);
     } else {
@@ -282,7 +287,7 @@ static void parse_type_str(Visitor *v, char **obj, const char *name,
 static void parse_type_number(Visitor *v, double *obj, const char *name,
                               Error **errp)
 {
-    StringInputVisitor *siv = DO_UPCAST(StringInputVisitor, visitor, v);
+    StringInputVisitor *siv = to_siv(v);
     char *endp = (char *) siv->string;
     double val;
 
@@ -301,7 +306,7 @@ static void parse_type_number(Visitor *v, double *obj, const char *name,
 
 static void parse_optional(Visitor *v, bool *present, const char *name)
 {
-    StringInputVisitor *siv = DO_UPCAST(StringInputVisitor, visitor, v);
+    StringInputVisitor *siv = to_siv(v);
 
     if (!siv->string) {
         *present = false;
qapi/string-output-visitor.c +13 -8
index b86ce2c..202764c 100644
@@ -66,6 +66,11 @@ struct StringOutputVisitor
     GList *ranges;
 };
 
+static StringOutputVisitor *to_sov(Visitor *v)
+{
+    return container_of(v, StringOutputVisitor, visitor);
+}
+
 static void string_output_set(StringOutputVisitor *sov, char *string)
 {
     if (sov->string) {
@@ -119,7 +124,7 @@ static void format_string(StringOutputVisitor *sov, Range *r, bool next,
 static void print_type_int(Visitor *v, int64_t *obj, const char *name,
                            Error **errp)
 {
-    StringOutputVisitor *sov = DO_UPCAST(StringOutputVisitor, visitor, v);
+    StringOutputVisitor *sov = to_sov(v);
     GList *l;
 
     switch (sov->list_mode) {
@@ -195,7 +200,7 @@ static void print_type_int(Visitor *v, int64_t *obj, const char *name,
 static void print_type_size(Visitor *v, uint64_t *obj, const char *name,
                            Error **errp)
 {
-    StringOutputVisitor *sov = DO_UPCAST(StringOutputVisitor, visitor, v);
+    StringOutputVisitor *sov = to_sov(v);
     static const char suffixes[] = { 'B', 'K', 'M', 'G', 'T', 'P', 'E' };
     uint64_t div, val;
     char *out;
@@ -226,14 +231,14 @@ static void print_type_size(Visitor *v, uint64_t *obj, const char *name,
 static void print_type_bool(Visitor *v, bool *obj, const char *name,
                             Error **errp)
 {
-    StringOutputVisitor *sov = DO_UPCAST(StringOutputVisitor, visitor, v);
+    StringOutputVisitor *sov = to_sov(v);
     string_output_set(sov, g_strdup(*obj ? "true" : "false"));
 }
 
 static void print_type_str(Visitor *v, char **obj, const char *name,
                            Error **errp)
 {
-    StringOutputVisitor *sov = DO_UPCAST(StringOutputVisitor, visitor, v);
+    StringOutputVisitor *sov = to_sov(v);
     char *out;
 
     if (sov->human) {
@@ -247,14 +252,14 @@ static void print_type_str(Visitor *v, char **obj, const char *name,
 static void print_type_number(Visitor *v, double *obj, const char *name,
                               Error **errp)
 {
-    StringOutputVisitor *sov = DO_UPCAST(StringOutputVisitor, visitor, v);
+    StringOutputVisitor *sov = to_sov(v);
     string_output_set(sov, g_strdup_printf("%f", *obj));
 }
 
 static void
 start_list(Visitor *v, const char *name, Error **errp)
 {
-    StringOutputVisitor *sov = DO_UPCAST(StringOutputVisitor, visitor, v);
+    StringOutputVisitor *sov = to_sov(v);
 
     /* we can't traverse a list in a list */
     assert(sov->list_mode == LM_NONE);
@@ -265,7 +270,7 @@ start_list(Visitor *v, const char *name, Error **errp)
 static GenericList *
 next_list(Visitor *v, GenericList **list, Error **errp)
 {
-    StringOutputVisitor *sov = DO_UPCAST(StringOutputVisitor, visitor, v);
+    StringOutputVisitor *sov = to_sov(v);
     GenericList *ret = NULL;
     if (*list) {
         if (sov->head) {
@@ -292,7 +297,7 @@ next_list(Visitor *v, GenericList **list, Error **errp)
 static void
 end_list(Visitor *v, Error **errp)
 {
-    StringOutputVisitor *sov = DO_UPCAST(StringOutputVisitor, visitor, v);
+    StringOutputVisitor *sov = to_sov(v);
 
     assert(sov->list_mode == LM_STARTED ||
            sov->list_mode == LM_END ||
Signature · 1 line
2.5.0
#8 lore raw

Re: [Qemu-devel] [PATCH v9 02/37] qapi: Avoid use of misnamed DO_UPCAST()

Quoted 28 lines · Eric Blake

The macro DO_UPCAST() is incorrectly named: it converts from a parent class to a derived class (which is a downcast). Better, and more consistent with some of the other qapi visitors, is to use the container_of() macro through a to_FOO() helper.

Our current definition of container_of() is weaker than DO_UPCAST(), in that it does not require the derived class to have Visitor as its first member, but this does not hurt our usage patterns in qapi visitors.

---
v9: no change
v8: no change
v7: new patch

---
 qapi/opts-visitor.c          | 28 +++++++++++++++++-----------
 qapi/string-input-visitor.c  | 23 ++++++++++++++---------
 qapi/string-output-visitor.c | 21 +++++++++++++--------
 3 files changed, 44 insertions(+), 28 deletions(-)
qapi/opts-visitor.c +0 -0
index ef5fb8b..dd4094c 100644

qapi/opts-visitor.c struct OptsVisitor · line 97

Quoted 9 lines
qapi/opts-visitor.c +6 -0
@@ -89,6 +89,12 @@ struct OptsVisitor
 };
 
 
+static OptsVisitor *to_ov(Visitor *v)
+{
+    return container_of(v, OptsVisitor, visitor);
+}
+
+

The name to_ov() is rather laconic even for my taste. Tolerable, since it's static.

qapi/opts-visitor.c static void · line 133

Quoted 12 lines
qapi/opts-visitor.c +1 -1
 static void
 destroy_list(gpointer list)
 {
@@ -121,7 +127,7 @@ static void
 opts_start_struct(Visitor *v, void **obj, const char *kind,
                   const char *name, size_t size, Error **errp)
 {
-    OptsVisitor *ov = DO_UPCAST(OptsVisitor, visitor, v);
+    OptsVisitor *ov = to_ov(v);
     const QemuOpt *opt;
 
     if (obj) {

Much clearer!

[...]

Patch gets rid of all DO_UPCAST() in qapi/. PATCH 33 brings one back; it should use to_ov() instead.

author
#9 lore raw

Re: [Qemu-devel] [PATCH v9 02/37] qapi: Avoid use of misnamed DO_UPCAST()

Quoted 17 lines · Markus Armbruster
Quoted 15 lines · Eric Blake

The macro DO_UPCAST() is incorrectly named: it converts from a parent class to a derived class (which is a downcast). Better, and more consistent with some of the other qapi visitors, is to use the container_of() macro through a to_FOO() helper.

Our current definition of container_of() is weaker than DO_UPCAST(), in that it does not require the derived class to have Visitor as its first member, but this does not hurt our usage patterns in qapi visitors.

Quoted 9 lines

qapi/opts-visitor.c struct OptsVisitor · line 97

Quoted 6 lines
qapi/opts-visitor.c +6 -0
+static OptsVisitor *to_ov(Visitor *v)
+{
+    return container_of(v, OptsVisitor, visitor);
+}
+
+

The name to_ov() is rather laconic even for my taste. Tolerable, since it's static.

And matches existing practice pre-patch:

qapi/qapi-dealloc-visitor.c:static QapiDeallocVisitor *to_qov(Visitor *v) qapi/qmp-input-visitor.c:static QmpInputVisitor *to_qiv(Visitor *v) qapi/qmp-output-visitor.c:static QmpOutputVisitor *to_qov(Visitor *v)

Quoted 3 lines

Patch gets rid of all DO_UPCAST() in qapi/. PATCH 33 brings one back; it should use to_ov() instead.

D'oh. You can tell what order I wrote the patches in :)

If I need to respin, I'll fix it; otherwise, I assume you can handle it.

Signature · 2 lines
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org
#10 lore raw

Re: [Qemu-devel] [PATCH v9 02/37] qapi: Avoid use of misnamed DO_UPCAST()

Quoted 36 lines · Eric Blake
Quoted 17 lines · Markus Armbruster
Quoted 15 lines · Eric Blake

The macro DO_UPCAST() is incorrectly named: it converts from a parent class to a derived class (which is a downcast). Better, and more consistent with some of the other qapi visitors, is to use the container_of() macro through a to_FOO() helper.

Our current definition of container_of() is weaker than DO_UPCAST(), in that it does not require the derived class to have Visitor as its first member, but this does not hurt our usage patterns in qapi visitors.

Quoted 9 lines

qapi/opts-visitor.c struct OptsVisitor · line 97

Quoted 6 lines
qapi/opts-visitor.c +6 -0
+static OptsVisitor *to_ov(Visitor *v)
+{
+    return container_of(v, OptsVisitor, visitor);
+}
+
+

The name to_ov() is rather laconic even for my taste. Tolerable, since it's static.

And matches existing practice pre-patch:

qapi/qapi-dealloc-visitor.c:static QapiDeallocVisitor *to_qov(Visitor *v) qapi/qmp-input-visitor.c:static QmpInputVisitor *to_qiv(Visitor *v) qapi/qmp-output-visitor.c:static QmpOutputVisitor *to_qov(Visitor *v)

Quoted 1 line
Quoted 6 lines
Quoted 2 lines

Patch gets rid of all DO_UPCAST() in qapi/. PATCH 33 brings one back; it should use to_ov() instead.

D'oh. You can tell what order I wrote the patches in :)

If I need to respin, I'll fix it; otherwise, I assume you can handle it.

Yes.

author
#11 lore raw

PATCH v9 3/37 qapi: Drop dead dealloc visitor variable

In reply to Eric Blake

Commit 0b9d8542 added StackEntry.is_list_head, but forgot to delete the now-unused QapiDeallocVisitor.is_list_head.

---
v9: no change
v8: no change
v7: new patch

---
 qapi/qapi-dealloc-visitor.c | 1 -
 1 file changed, 1 deletion(-)
qapi/qapi-dealloc-visitor.c +0 -1
index 737deab..204de8f 100644
@@ -28,7 +28,6 @@ struct QapiDeallocVisitor
 {
     Visitor visitor;
     QTAILQ_HEAD(, StackEntry) stack;
-    bool is_list_head;
 };
 
 static QapiDeallocVisitor *to_qov(Visitor *v)
Signature · 1 line
2.5.0
author
#12 lore raw

PATCH v9 4/37 hmp: Improve use of qapi visitor

In reply to Eric Blake

Cache the visitor in a local variable instead of repeatedly calling the accessor. Pass NULL for the visit_start_struct() object (which matches the fact that we were already passing 0 for the size argument, because we aren't using the visit to allocate a qapi struct).

---
v9: no change
v8: no change
v7: place earlier in series, drop attempts to provide a 'kind' string, drop bogus avoidance of qmp_object_del() on error
v6: new patch, split from RFC on v5 7/46

---
 hmp.c | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)
hmp.c +7 -7
index 54f2620..6d67f9b 100644
@@ -1656,9 +1656,9 @@ void hmp_object_add(Monitor *mon, const QDict *qdict)
     QemuOpts *opts;
     char *type = NULL;
     char *id = NULL;
-    void *dummy = NULL;
     OptsVisitor *ov;
     QDict *pdict;
+    Visitor *v;
 
     opts = qemu_opts_from_qdict(qemu_find_opts("object"), qdict, &err);
     if (err) {
@@ -1667,28 +1667,29 @@ void hmp_object_add(Monitor *mon, const QDict *qdict)
 
     ov = opts_visitor_new(opts);
     pdict = qdict_clone_shallow(qdict);
+    v = opts_get_visitor(ov);
 
-    visit_start_struct(opts_get_visitor(ov), &dummy, NULL, NULL, 0, &err);
+    visit_start_struct(v, NULL, NULL, NULL, 0, &err);
     if (err) {
         goto out_clean;
     }
 
     qdict_del(pdict, "qom-type");
-    visit_type_str(opts_get_visitor(ov), &type, "qom-type", &err);
+    visit_type_str(v, &type, "qom-type", &err);
     if (err) {
         goto out_end;
     }
 
     qdict_del(pdict, "id");
-    visit_type_str(opts_get_visitor(ov), &id, "id", &err);
+    visit_type_str(v, &id, "id", &err);
     if (err) {
         goto out_end;
     }
 
-    object_add(type, id, pdict, opts_get_visitor(ov), &err);
+    object_add(type, id, pdict, v, &err);
 
 out_end:
-    visit_end_struct(opts_get_visitor(ov), &err_end);
+    visit_end_struct(v, &err_end);
     if (!err && err_end) {
         qmp_object_del(id, NULL);
     }
@@ -1700,7 +1701,6 @@ out_clean:
     qemu_opts_del(opts);
     g_free(id);
     g_free(type);
-    g_free(dummy);
 
 out:
     hmp_handle_error(mon, &err);
Signature · 1 line
2.5.0
#13 lore raw

Re: [Qemu-devel] [PATCH v9 04/37] hmp: Improve use of qapi visitor

Quoted 5 lines · Eric Blake

Cache the visitor in a local variable instead of repeatedly calling the accessor. Pass NULL for the visit_start_struct() object (which matches the fact that we were already passing 0 for the size argument, because we aren't using the visit to allocate a qapi struct).

Two separate things. Doing them both in a single patch is okay because the resulting patch is short enough to be easily reviewable anyway.

Quoted 29 lines

---
v9: no change
v8: no change
v7: place earlier in series, drop attempts to provide a 'kind' string, drop bogus avoidance of qmp_object_del() on error
v6: new patch, split from RFC on v5 7/46

---
 hmp.c | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)
hmp.c +1 -1
index 54f2620..6d67f9b 100644
@@ -1656,9 +1656,9 @@ void hmp_object_add(Monitor *mon, const QDict *qdict)
     QemuOpts *opts;
     char *type = NULL;
     char *id = NULL;
-    void *dummy = NULL;
     OptsVisitor *ov;
     QDict *pdict;
+    Visitor *v;
 
     opts = qemu_opts_from_qdict(qemu_find_opts("object"), qdict, &err);
     if (err) {

hmp.c void hmp_object_add(Monitor *mon, const QDict *qdict) · line 1672

Quoted 7 lines
hmp.c +2 -1
@@ -1667,28 +1667,29 @@ void hmp_object_add(Monitor *mon, const QDict *qdict)
 
     ov = opts_visitor_new(opts);
     pdict = qdict_clone_shallow(qdict);
+    v = opts_get_visitor(ov);
 
-    visit_start_struct(opts_get_visitor(ov), &dummy, NULL, NULL, 0, &err);
+    visit_start_struct(v, NULL, NULL, NULL, 0, &err);

The only callers that can allocate are the generated visit_type_FOO() for struct or union FOO.

The non-allocating callers mostly look like

    visit_start_struct(v, NULL, NULL, NULL, 0, &err);

Some pass a non-null @kind (third argument), but that's rubbish anyway (see PATCH 17).

Some pass a non-null @name (fourth argument). QMP visitors need that, others don't care.

This caller is the only one that passes a non-null @obj (second argument). Makes visitors capable of allocating allocate @size bytes (fifth argument). Except opts-visitor allocates one byte instead of zero to avoid a null object, for unclear reasons. Whatever gets allocated we free (see last hunk) without using. The patch avoids this pointless allocation. Good. Suggest to explain this more clearly in the commit message:

Pass NULL for the visit_start_struct() parameter @obj to suppress unwanted allocation, like we do elsewhere.

Quoted 35 lines
hmp.c +4 -5
     if (err) {
         goto out_clean;
     }
 
     qdict_del(pdict, "qom-type");
-    visit_type_str(opts_get_visitor(ov), &type, "qom-type", &err);
+    visit_type_str(v, &type, "qom-type", &err);
     if (err) {
         goto out_end;
     }
 
     qdict_del(pdict, "id");
-    visit_type_str(opts_get_visitor(ov), &id, "id", &err);
+    visit_type_str(v, &id, "id", &err);
     if (err) {
         goto out_end;
     }
 
-    object_add(type, id, pdict, opts_get_visitor(ov), &err);
+    object_add(type, id, pdict, v, &err);
 
 out_end:
-    visit_end_struct(opts_get_visitor(ov), &err_end);
+    visit_end_struct(v, &err_end);
     if (!err && err_end) {
         qmp_object_del(id, NULL);
     }
@@ -1700,7 +1701,6 @@ out_clean:
     qemu_opts_del(opts);
     g_free(id);
     g_free(type);
-    g_free(dummy);
 
 out:
     hmp_handle_error(mon, &err);
author
#14 lore raw

PATCH v9 5/37 vl: Improve use of qapi visitor

In reply to Eric Blake

Cache the visitor in a local variable instead of repeatedly calling the accessor. Pass NULL for the visit_start_struct() object (which matches the fact that we were already passing 0 for the size argument, because we aren't using the visit to allocate a qapi struct). Guarantee that visit_end_struct() is called if visit_start_struct() succeeded.

---
v9: no change
v8: no change
v7: place earlier in series, drop attempts to provide a 'kind' string, drop bogus avoidance of qmp_object_del() on error
v6: new patch, split from RFC on v5 7/46

---
 vl.c | 26 ++++++++++++++------------
 1 file changed, 14 insertions(+), 12 deletions(-)
vl.c +14 -12
index f043009..aaa5403 100644
@@ -2822,44 +2822,47 @@ static bool object_create_delayed(const char *type)
 static int object_create(void *opaque, QemuOpts *opts, Error **errp)
 {
     Error *err = NULL;
+    Error *err_end = NULL;
     char *type = NULL;
     char *id = NULL;
-    void *dummy = NULL;
     OptsVisitor *ov;
     QDict *pdict;
     bool (*type_predicate)(const char *) = opaque;
+    Visitor *v;
 
     ov = opts_visitor_new(opts);
     pdict = qemu_opts_to_qdict(opts, NULL);
+    v = opts_get_visitor(ov);
 
-    visit_start_struct(opts_get_visitor(ov), &dummy, NULL, NULL, 0, &err);
+    visit_start_struct(v, NULL, NULL, NULL, 0, &err);
     if (err) {
         goto out;
     }
 
     qdict_del(pdict, "qom-type");
-    visit_type_str(opts_get_visitor(ov), &type, "qom-type", &err);
+    visit_type_str(v, &type, "qom-type", &err);
     if (err) {
         goto out;
     }
     if (!type_predicate(type)) {
+        visit_end_struct(v, NULL);
         goto out;
     }
 
     qdict_del(pdict, "id");
-    visit_type_str(opts_get_visitor(ov), &id, "id", &err);
+    visit_type_str(v, &id, "id", &err);
     if (err) {
-        goto out;
+        goto out_end;
     }
 
-    object_add(type, id, pdict, opts_get_visitor(ov), &err);
-    if (err) {
-        goto out;
-    }
-    visit_end_struct(opts_get_visitor(ov), &err);
-    if (err) {
+    object_add(type, id, pdict, v, &err);
+
+out_end:
+    visit_end_struct(v, &err_end);
+    if (!err && err_end) {
         qmp_object_del(id, NULL);
     }
+    error_propagate(&err, err_end);
 
 out:
     opts_visitor_cleanup(ov);
@@ -2867,7 +2870,6 @@ out:
     QDECREF(pdict);
     g_free(id);
     g_free(type);
-    g_free(dummy);
     if (err) {
         error_report_err(err);
         return -1;
Signature · 1 line
2.5.0
#15 lore raw

Re: [Qemu-devel] [PATCH v9 05/37] vl: Improve use of qapi visitor

Quoted 6 lines · Eric Blake

Cache the visitor in a local variable instead of repeatedly calling the accessor. Pass NULL for the visit_start_struct() object (which matches the fact that we were already passing 0 for the size argument, because we aren't using the visit to allocate a qapi struct). Guarantee that visit_end_struct() is called if visit_start_struct() succeeded.

Three separate things --- you're pushing it now :)

Impact of not calling visit_end_struct()?

Quoted 26 lines

---
v9: no change
v8: no change
v7: place earlier in series, drop attempts to provide a 'kind' string, drop bogus avoidance of qmp_object_del() on error
v6: new patch, split from RFC on v5 7/46

---
 vl.c | 26 ++++++++++++++------------
 1 file changed, 14 insertions(+), 12 deletions(-)
vl.c +1 -1
index f043009..aaa5403 100644
@@ -2822,44 +2822,47 @@ static bool object_create_delayed(const char *type)
 static int object_create(void *opaque, QemuOpts *opts, Error **errp)
 {
     Error *err = NULL;
+    Error *err_end = NULL;
     char *type = NULL;
     char *id = NULL;
-    void *dummy = NULL;
     OptsVisitor *ov;

vl.c static bool object_create_delayed(const char *type) · line 2837

Quoted 10 lines
vl.c +3 -1
     QDict *pdict;
     bool (*type_predicate)(const char *) = opaque;
+    Visitor *v;
 
     ov = opts_visitor_new(opts);
     pdict = qemu_opts_to_qdict(opts, NULL);
+    v = opts_get_visitor(ov);
 
-    visit_start_struct(opts_get_visitor(ov), &dummy, NULL, NULL, 0, &err);
+    visit_start_struct(v, NULL, NULL, NULL, 0, &err);

Same argument as for the previous patch.

vl.c static bool object_create_delayed(const char *type) · line 2846

Quoted 10 lines
vl.c +1 -1
     if (err) {
         goto out;
     }
 
     qdict_del(pdict, "qom-type");
-    visit_type_str(opts_get_visitor(ov), &type, "qom-type", &err);
+    visit_type_str(v, &type, "qom-type", &err);
     if (err) {
         goto out;
     }

If we get here, we must call visit_end_struct().

vl.c static bool object_create_delayed(const char *type) · line 2848

Quoted 2 lines
vl.c +1 -0
     if (!type_predicate(type)) {
+        visit_end_struct(v, NULL);

Here, you add the previously missing visit_end_struct() to the error path.

vl.c static bool object_create_delayed(const char *type) · line 2855

Quoted 9 lines
vl.c +2 -2
         goto out;
     }
 
     qdict_del(pdict, "id");
-    visit_type_str(opts_get_visitor(ov), &id, "id", &err);
+    visit_type_str(v, &id, "id", &err);
     if (err) {
-        goto out;
+        goto out_end;

Here, you skip to the function's cleanup, which now includes visit_end_struct().

Such a mix is can be a sign the cleanup isn't quite in the right order.

When we take this error path to out_end, then:

   out_end:
       visit_end_struct(v, &err_end);   // called, as we must
       if (!err && err_end) {           // !err is false
           qmp_object_del(id, NULL);    // not called
       }
       error_propagate(&err, err_end);  // since err, this is
                                        // error_free(err_end)

vl.c static bool object_create_delayed(const char *type) · line 2861

Quoted 12 lines
vl.c +4 -6
     }
 
-    object_add(type, id, pdict, opts_get_visitor(ov), &err);
-    if (err) {
-        goto out;
-    }
-    visit_end_struct(opts_get_visitor(ov), &err);
-    if (err) {
+    object_add(type, id, pdict, v, &err);
+
+out_end:
+    visit_end_struct(v, &err_end);

visit_end_struct() must be called when visit_start_struct() succeeded. All error paths after that success pass through here, except for one, and that one calls visit_end_struct(). Okay.

vl.c static bool object_create_delayed(const char *type) · line 2864

Quoted 3 lines
vl.c +1 -0
+    if (!err && err_end) {
         qmp_object_del(id, NULL);
     }

qmp_object_del() must be called when we fail after object_add() succeeded. That's what the condition does.

vl.c static bool object_create_delayed(const char *type) · line 2867

Quoted 3 lines
vl.c +1 -0
+    error_propagate(&err, err_end);
 
 out:

Cleanup below here must be done always.

vl.c static bool object_create_delayed(const char *type) · line 2868

Quoted 1 line
vl.c +0 -0
     opts_visitor_cleanup(ov);

The only reason I'm not asking you to rewrite this mess is that you're already rewriting it later in this series.

vl.c out: · line 2875

Quoted 8 lines
vl.c +0 -1
@@ -2867,7 +2870,6 @@ out:
     QDECREF(pdict);
     g_free(id);
     g_free(type);
-    g_free(dummy);
     if (err) {
         error_report_err(err);
         return -1;

I wonder whether splitting this and the previous patch along the change rather than the file would come out nicer:

1. Cache the visitor

2. Suppress the pointless allocation

3. Fix to call visit_end_struct()

author
#16 lore raw

Re: [Qemu-devel] [PATCH v9 05/37] vl: Improve use of qapi visitor

Quoted 10 lines · Markus Armbruster
Quoted 6 lines · Eric Blake

Cache the visitor in a local variable instead of repeatedly calling the accessor. Pass NULL for the visit_start_struct() object (which matches the fact that we were already passing 0 for the size argument, because we aren't using the visit to allocate a qapi struct). Guarantee that visit_end_struct() is called if visit_start_struct() succeeded.

Three separate things --- you're pushing it now :)

Two of them the same as in 4/37.

So, among the five items, I did a split in two based on file. I could split in the other direction:

fix hmp and vl to cache their visitor
fix hmp and vl to pass NULL to avoid pointless allocation fix vl to guarantee visit_end_struct

Quoted 2 lines

Impact of not calling visit_end_struct()?

Assertion failures after patch 24. :)
Basically, I wanted to see whether the code base could get simpler if we always enforced visit start/end grouping, and there were only a couple of outliers that needed fixing (here, and in patch 7).

Quoted 33 lines

vl.c static bool object_create_delayed(const char *type) · line 2846

Quoted 7 lines
     qdict_del(pdict, "qom-type");
vl.c +1 -1
-    visit_type_str(opts_get_visitor(ov), &type, "qom-type", &err);
+    visit_type_str(v, &type, "qom-type", &err);
     if (err) {
         goto out;
     }

If we get here, we must call visit_end_struct().

Quoted 2 lines
     if (!type_predicate(type)) {

+ visit_end_struct(v, NULL);

Here, you add the previously missing visit_end_struct() to the error path.

vl.c static bool object_create_delayed(const char *type) · line 2855

Quoted 9 lines
         goto out;
     }

     qdict_del(pdict, "id");
vl.c +2 -2
-    visit_type_str(opts_get_visitor(ov), &id, "id", &err);
+    visit_type_str(v, &id, "id", &err);
     if (err) {
-        goto out;
+        goto out_end;

Here, you skip to the function's cleanup, which now includes visit_end_struct().

Such a mix is can be a sign the cleanup isn't quite in the right order.

When we take this error path to out_end, then:

Quoted 7 lines
   out_end:
       visit_end_struct(v, &err_end);   // called, as we must
       if (!err && err_end) {           // !err is false
           qmp_object_del(id, NULL);    // not called
       }
       error_propagate(&err, err_end);  // since err, this is
                                        // error_free(err_end)

Correct. And it gets simpler later on, when visit_end_struct() loses the errp argument (patch 33).

Quoted 27 lines

vl.c static bool object_create_delayed(const char *type) · line 2861

Quoted 13 lines
     }
vl.c +4 -6
-    object_add(type, id, pdict, opts_get_visitor(ov), &err);
-    if (err) {
-        goto out;
-    }
-    visit_end_struct(opts_get_visitor(ov), &err);
-    if (err) {
+    object_add(type, id, pdict, v, &err);
+
+out_end:
+    visit_end_struct(v, &err_end);

visit_end_struct() must be called when visit_start_struct() succeeded. All error paths after that success pass through here, except for one, and that one calls visit_end_struct(). Okay.

Quoted 3 lines
+    if (!err && err_end) {
         qmp_object_del(id, NULL);
     }

qmp_object_del() must be called when we fail after object_add() succeeded. That's what the condition does.

Quoted 2 lines

+ error_propagate(&err, err_end);

Quoted 8 lines
Quoted 1 line

out:

Cleanup below here must be done always.

Quoted 1 line
     opts_visitor_cleanup(ov);

The only reason I'm not asking you to rewrite this mess is that you're already rewriting it later in this series.

So I think you found patch 33.

Quoted 13 lines

vl.c out: · line 2875

Quoted 9 lines
vl.c +0 -1
@@ -2867,7 +2870,6 @@ out:
     QDECREF(pdict);
     g_free(id);
     g_free(type);
-    g_free(dummy);
     if (err) {
         error_report_err(err);
         return -1;

I wonder whether splitting this and the previous patch along the change rather than the file would come out nicer:

Quoted 6 lines

1. Cache the visitor

2. Suppress the pointless allocation

3. Fix to call visit_end_struct()

What do you know - we're thinking on the same lines :) [And now you know I just replied to your email in the order that I read it, rather than reading the whole thing first]

Signature · 2 lines
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org
#17 lore raw

Re: [Qemu-devel] [PATCH v9 05/37] vl: Improve use of qapi visitor

Quoted 22 lines · Eric Blake
Quoted 10 lines · Markus Armbruster
Quoted 6 lines · Eric Blake

Cache the visitor in a local variable instead of repeatedly calling the accessor. Pass NULL for the visit_start_struct() object (which matches the fact that we were already passing 0 for the size argument, because we aren't using the visit to allocate a qapi struct). Guarantee that visit_end_struct() is called if visit_start_struct() succeeded.

Three separate things --- you're pushing it now :)

Two of them the same as in 4/37.

So, among the five items, I did a split in two based on file. I could split in the other direction:

fix hmp and vl to cache their visitor
fix hmp and vl to pass NULL to avoid pointless allocation fix vl to guarantee visit_end_struct

Quoted 1 line
Quoted 6 lines
Quoted 1 line

Impact of not calling visit_end_struct()?

Assertion failures after patch 24. :)
Basically, I wanted to see whether the code base could get simpler if we always enforced visit start/end grouping, and there were only a couple of outliers that needed fixing (here, and in patch 7).

Makes sense, although I wonder why things work without visit_end_struct(). Looking... I guess we skip visit_end_struct() only on error, and then we go straight to opts_visitor_cleanup(). Okay, that's sane enough to work.

But now I wonder whether requiring visit_end_struct() before visit_cleanup() is a good idea.

Quoted 97 lines
Quoted 33 lines

vl.c static bool object_create_delayed(const char *type) · line 2846

Quoted 7 lines
     qdict_del(pdict, "qom-type");
vl.c +1 -1
-    visit_type_str(opts_get_visitor(ov), &type, "qom-type", &err);
+    visit_type_str(v, &type, "qom-type", &err);
     if (err) {
         goto out;
     }

If we get here, we must call visit_end_struct().

Quoted 2 lines
     if (!type_predicate(type)) {

+ visit_end_struct(v, NULL);

Here, you add the previously missing visit_end_struct() to the error path.

vl.c static bool object_create_delayed(const char *type) · line 2855

Quoted 9 lines
         goto out;
     }

     qdict_del(pdict, "id");
vl.c +2 -2
-    visit_type_str(opts_get_visitor(ov), &id, "id", &err);
+    visit_type_str(v, &id, "id", &err);
     if (err) {
-        goto out;
+        goto out_end;

Here, you skip to the function's cleanup, which now includes visit_end_struct().

Such a mix is can be a sign the cleanup isn't quite in the right order.

When we take this error path to out_end, then:

Quoted 7 lines
   out_end:
       visit_end_struct(v, &err_end);   // called, as we must
       if (!err && err_end) {           // !err is false
           qmp_object_del(id, NULL);    // not called
       }
       error_propagate(&err, err_end);  // since err, this is
                                        // error_free(err_end)

Correct. And it gets simpler later on, when visit_end_struct() loses the errp argument (patch 33).

Quoted 27 lines

vl.c static bool object_create_delayed(const char *type) · line 2861

Quoted 13 lines
     }
vl.c +4 -6
-    object_add(type, id, pdict, opts_get_visitor(ov), &err);
-    if (err) {
-        goto out;
-    }
-    visit_end_struct(opts_get_visitor(ov), &err);
-    if (err) {
+    object_add(type, id, pdict, v, &err);
+
+out_end:
+    visit_end_struct(v, &err_end);

visit_end_struct() must be called when visit_start_struct() succeeded. All error paths after that success pass through here, except for one, and that one calls visit_end_struct(). Okay.

Quoted 3 lines
+    if (!err && err_end) {
         qmp_object_del(id, NULL);
     }

qmp_object_del() must be called when we fail after object_add() succeeded. That's what the condition does.

Quoted 2 lines

+ error_propagate(&err, err_end);

Quoted 8 lines
Quoted 1 line

out:

Cleanup below here must be done always.

Quoted 1 line
     opts_visitor_cleanup(ov);

The only reason I'm not asking you to rewrite this mess is that you're already rewriting it later in this series.

So I think you found patch 33.

Quoted 15 lines

vl.c out: · line 2875

Quoted 9 lines
vl.c +0 -1
@@ -2867,7 +2870,6 @@ out:
     QDECREF(pdict);
     g_free(id);
     g_free(type);
-    g_free(dummy);
     if (err) {
         error_report_err(err);
         return -1;

I wonder whether splitting this and the previous patch along the change rather than the file would come out nicer:

1. Cache the visitor

Quoted 8 lines
Quoted 4 lines

2. Suppress the pointless allocation

3. Fix to call visit_end_struct()

What do you know - we're thinking on the same lines :) [And now you know I just replied to your email in the order that I read it, rather than reading the whole thing first]

I do that all the time for long messages :)

author
#18 lore raw

PATCH v9 6/37 balloon: Improve use of qapi visitor

In reply to Eric Blake

Rework the control flow of balloon_stats_get_all() to make it easier for a later patch to split visit_end_struct(). Also switch to the uint64 visitor to match the data type.

---
v9: no change
v8: no change
v7: place earlier in series
v6: new patch, split from RFC on v5 7/46

---
 hw/virtio/virtio-balloon.c | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)
hw/virtio/virtio-balloon.c +6 -3
index 9671635..1ce987a 100644
@@ -130,10 +130,13 @@ static void balloon_stats_get_all(Object *obj, struct Visitor *v,
     if (err) {
         goto out_end;
     }
-    for (i = 0; !err && i < VIRTIO_BALLOON_S_NR; i++) {
-        visit_type_int64(v, (int64_t *) &s->stats[i], balloon_stat_names[i],
-                         &err);
+    for (i = 0; i < VIRTIO_BALLOON_S_NR; i++) {
+        visit_type_uint64(v, &s->stats[i], balloon_stat_names[i], &err);
+        if (err) {
+            goto out_nested;
+        }
     }
+out_nested:
     error_propagate(errp, err);
     err = NULL;
     visit_end_struct(v, &err);
Signature · 1 line
2.5.0
#19 lore raw

Re: [Qemu-devel] [PATCH v9 06/37] balloon: Improve use of qapi visitor

Quoted 27 lines · Eric Blake

Rework the control flow of balloon_stats_get_all() to make it easier for a later patch to split visit_end_struct(). Also switch to the uint64 visitor to match the data type.

---
v9: no change
v8: no change
v7: place earlier in series
v6: new patch, split from RFC on v5 7/46

---
 hw/virtio/virtio-balloon.c | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)
hw/virtio/virtio-balloon.c +0 -3
index 9671635..1ce987a 100644
@@ -130,10 +130,13 @@ static void balloon_stats_get_all(Object *obj, struct Visitor *v,
     if (err) {
         goto out_end;
     }
-    for (i = 0; !err && i < VIRTIO_BALLOON_S_NR; i++) {
-        visit_type_int64(v, (int64_t *) &s->stats[i], balloon_stat_names[i],
-                         &err);

hw/virtio/virtio-balloon.c static void balloon_stats_get_all(Object *obj, struct Visitor *v, · line 142

Quoted 10 lines
hw/virtio/virtio-balloon.c +6 -0
+    for (i = 0; i < VIRTIO_BALLOON_S_NR; i++) {
+        visit_type_uint64(v, &s->stats[i], balloon_stat_names[i], &err);
+        if (err) {
+            goto out_nested;
+        }
     }
+out_nested:
     error_propagate(errp, err);
     err = NULL;
     visit_end_struct(v, &err);

What's wrong with plain break?

Hmm, PATCH 33 inserts something between the loop and the label. I would've used break here regardless of the extra churn, just to avoid review hiccups like this one. Too late now :)

author
#20 lore raw

PATCH v9 7/37 qapi: Improve generated event use of qapi visitor

In reply to Eric Blake

All other successful clients of visit_start_struct() were paired with an unconditional visit_end_struct(); but the generated code for events was relying on qmp_output_visitor_cleanup() to work on an incomplete visit. Alter the code to guarantee that the struct is completed, which will make a future patch to split visit_end_struct() easier to reason about. While at it, drop some assertions and comments that are not present in other uses of the qmp output visitor, and pass NULL rather than "" as the 'kind' parameter (matching most other uses where obj is NULL).

---
v9: save churn in declaration order for later series on boxed params, drop Marc-Andre's R-b
v8: no change
v7: place earlier in series, adjust handling of 'kind'
v6: new patch

If desired, I can defer the hunk re-ordering the declaration of obj to later in the series where it actually comes in handy.

---
 scripts/qapi-event.py | 12 +++++-------
 scripts/qapi.py       |  5 +++--
 2 files changed, 8 insertions(+), 9 deletions(-)
scripts/qapi-event.py +5 -7
index 720486f..761cda9 100644
@@ -61,25 +61,23 @@ def gen_event_send(name, arg_type):
     if arg_type and arg_type.members:
         ret += mcgen('''
     qov = qmp_output_visitor_new();
-    g_assert(qov);
-
     v = qmp_output_get_visitor(qov);
-    g_assert(v);
 
-    /* Fake visit, as if all members are under a structure */
-    visit_start_struct(v, NULL, "", "%(name)s", 0, &err);
+    visit_start_struct(v, NULL, NULL, "%(name)s", 0, &err);
 ''',
                      name=name)
         ret += gen_err_check()
-        ret += gen_visit_fields(arg_type.members, need_cast=True)
+        ret += gen_visit_fields(arg_type.members, need_cast=True,
+                                label='out_obj')
         ret += mcgen('''
+out_obj:
     visit_end_struct(v, &err);
     if (err) {
         goto out;
     }
 
     obj = qmp_output_get_qobject(qov);
-    g_assert(obj != NULL);
+    g_assert(obj);
 
     qdict_put_obj(qmp, "data", obj);
 ''')
scripts/qapi.py +3 -2
index 7dec611..497eaba 100644
@@ -1636,7 +1636,8 @@ def gen_err_check(label='out', skiperr=False):
                  label=label)
 
 
-def gen_visit_fields(members, prefix='', need_cast=False, skiperr=False):
+def gen_visit_fields(members, prefix='', need_cast=False, skiperr=False,
+                     label='out'):
     ret = ''
     if skiperr:
         errparg = 'NULL'
@@ -1664,7 +1665,7 @@ def gen_visit_fields(members, prefix='', need_cast=False, skiperr=False):
                      c_type=memb.type.c_name(), prefix=prefix, cast=cast,
                      c_name=c_name(memb.name), name=memb.name,
                      errp=errparg)
-        ret += gen_err_check(skiperr=skiperr)
+        ret += gen_err_check(skiperr=skiperr, label=label)
 
         if memb.optional:
             pop_indent()
Signature · 1 line
2.5.0
#21 lore raw

Re: [Qemu-devel] [PATCH v9 07/37] qapi: Improve generated event use of qapi visitor

Quoted 4 lines · Eric Blake

All other successful clients of visit_start_struct() were paired with an unconditional visit_end_struct(); but the generated code for events was relying on qmp_output_visitor_cleanup() to work on an incomplete visit.

Disgusting, isn't it? :)

Quoted 28 lines

Alter the code to guarantee that
the struct is completed, which will make a future patch to split visit_end_struct() easier to reason about. While at it, drop some assertions and comments that are not present in other uses of the qmp output visitor, and pass NULL rather than "" as the 'kind' parameter (matching most other uses where obj is NULL).

---
v9: save churn in declaration order for later series on boxed params, drop Marc-Andre's R-b
v8: no change
v7: place earlier in series, adjust handling of 'kind'
v6: new patch

If desired, I can defer the hunk re-ordering the declaration of obj to later in the series where it actually comes in handy.

---
 scripts/qapi-event.py | 12 +++++-------
 scripts/qapi.py       |  5 +++--
 2 files changed, 8 insertions(+), 9 deletions(-)
scripts/qapi-event.py +0 -0
index 720486f..761cda9 100644

scripts/qapi-event.py def gen_event_send(name, arg_type): · line 65

Quoted 5 lines
scripts/qapi-event.py +0 -2
@@ -61,25 +61,23 @@ def gen_event_send(name, arg_type):
     if arg_type and arg_type.members:
         ret += mcgen('''
     qov = qmp_output_visitor_new();
-    g_assert(qov);
-

Good riddance: qmp_output_visitor_new() can't fail. If that ever changes, qmp_output_get_visitor() will crash just fine.

scripts/qapi-event.py def gen_event_send(name, arg_type): · line 67

Quoted 2 lines
scripts/qapi-event.py +0 -1
     v = qmp_output_get_visitor(qov);
-    g_assert(v);

Good riddance^2: qmp_output_get_visitor() can't fail, either.

scripts/qapi-event.py def gen_event_send(name, arg_type): · line 71

Quoted 10 lines
scripts/qapi-event.py +3 -3
-    /* Fake visit, as if all members are under a structure */
-    visit_start_struct(v, NULL, "", "%(name)s", 0, &err);
+    visit_start_struct(v, NULL, NULL, "%(name)s", 0, &err);
 ''',
                      name=name)
         ret += gen_err_check()
-        ret += gen_visit_fields(arg_type.members, need_cast=True)
+        ret += gen_visit_fields(arg_type.members, need_cast=True,
+                                label='out_obj')

On error, we now go to out_obj rather than out. Some fields will be unvisited then (possibly all), and err will be set.

Now I get to figure out what this change changes.

scripts/qapi-event.py def gen_event_send(name, arg_type): · line 77

Quoted 6 lines
scripts/qapi-event.py +1 -0
         ret += mcgen('''
+out_obj:
     visit_end_struct(v, &err);
     if (err) {
         goto out;
     }

Good: we actually call visit_end_struct() as we should.

Not so good: if we get here via the error exit of gen_visit_fields(), err is set. If visit_end_struct() tries to set another error...

I guess the idea is to go from gen_visit_fields() failure through visit_end_struct() here to out. Correct?

scripts/qapi-event.py def gen_event_send(name, arg_type): · line 83

Quoted 7 lines
scripts/qapi-event.py +1 -1
     obj = qmp_output_get_qobject(qov);
-    g_assert(obj != NULL);
+    g_assert(obj);
 
     qdict_put_obj(qmp, "data", obj);
 ''')
       ret += mcgen('''
       emit(%(c_enum)s, qmp, &err);

''',
c_enum=c_enum_const(event_enum_name, name))

if arg_type and arg_type.members:
ret += mcgen('''
out:

       qmp_output_visitor_cleanup(qov);
   ''')
       ret += mcgen('''
       error_propagate(errp, err);
       QDECREF(qmp);

}

scripts/qapi.py def gen_err_check(label='out', skiperr=False): · line 1640

Quoted 11 lines
scripts/qapi.py +2 -1
index 7dec611..497eaba 100644
@@ -1636,7 +1636,8 @@ def gen_err_check(label='out', skiperr=False):
                  label=label)
 
 
-def gen_visit_fields(members, prefix='', need_cast=False, skiperr=False):
+def gen_visit_fields(members, prefix='', need_cast=False, skiperr=False,
+                     label='out'):

Probably clearer than label=None, but duplicates gen_err_check()'s default. Fine with me.

scripts/qapi.py def gen_err_check(label='out', skiperr=False): · line 1643

Quoted 3 lines
scripts/qapi.py +0 -0
     ret = ''
     if skiperr:
         errparg = 'NULL'

else:
errparg = '&err'

for memb in members:
if memb.optional:
ret += mcgen('''
if (visit_optional(v, "%(name)s", &%(prefix)shas_%(c_name)s)) {
''',
prefix=prefix, c_name=c_name(memb.name), name=memb.name, errp=errparg)
push_indent()

errp=errparg unused here. Not this patch's job to clean up.

Quoted 9 lines
scripts/qapi.py +1 -1
@@ -1664,7 +1665,7 @@ def gen_visit_fields(members, prefix='', need_cast=False, skiperr=False):
                      c_type=memb.type.c_name(), prefix=prefix, cast=cast,
                      c_name=c_name(memb.name), name=memb.name,
                      errp=errparg)
-        ret += gen_err_check(skiperr=skiperr)
+        ret += gen_err_check(skiperr=skiperr, label=label)
 
         if memb.optional:
             pop_indent()
author
#22 lore raw

Re: [Qemu-devel] [PATCH v9 07/37] qapi: Improve generated event use of qapi visitor

Quoted 8 lines · Markus Armbruster
Quoted 4 lines · Eric Blake

All other successful clients of visit_start_struct() were paired with an unconditional visit_end_struct(); but the generated code for events was relying on qmp_output_visitor_cleanup() to work on an incomplete visit.

Disgusting, isn't it? :)

This, along with the fix in 5/37, were the two places that had to be fixed to avoid assertions in patch 24, when I turned on stricter enforcing of cleanup only on an evenly matched visit.

Quoted 17 lines
Quoted 17 lines

Alter the code to guarantee that
the struct is completed, which will make a future patch to split visit_end_struct() easier to reason about. While at it, drop some assertions and comments that are not present in other uses of the qmp output visitor, and pass NULL rather than "" as the 'kind' parameter (matching most other uses where obj is NULL).

---
v9: save churn in declaration order for later series on boxed params, drop Marc-Andre's R-b
v8: no change
v7: place earlier in series, adjust handling of 'kind'
v6: new patch

Quoted 2 lines
Quoted 2 lines

If desired, I can defer the hunk re-ordering the declaration of obj to later in the series where it actually comes in handy.

Dead sentence leftover from v8; as mentioned above, I DID sink the declaration reordering to a later series for v9. But it's after the ---, so it gets trimmed automatically by 'git am'.

Quoted 17 lines

scripts/qapi-event.py def gen_event_send(name, arg_type): · line 71

Quoted 4 lines
         ret += gen_err_check()
scripts/qapi-event.py +2 -1
-        ret += gen_visit_fields(arg_type.members, need_cast=True)
+        ret += gen_visit_fields(arg_type.members, need_cast=True,
+                                label='out_obj')

On error, we now go to out_obj rather than out. Some fields will be unvisited then (possibly all), and err will be set.

Now I get to figure out what this change changes.

Quoted 6 lines
         ret += mcgen('''
+out_obj:
     visit_end_struct(v, &err);
     if (err) {
         goto out;
     }
Quoted 4 lines

Good: we actually call visit_end_struct() as we should.

Not so good: if we get here via the error exit of gen_visit_fields(), err is set. If visit_end_struct() tries to set another error...

Oops. It all gets cleaned up in 33 when visit_end_struct() loses the errp argument, but in the meantime, I think the most robust way to write this would be:

out_obj:

    visit_end_struct(v, err ? NULL : &err);
    if (err) {

...

Quoted 3 lines

I guess the idea is to go from gen_visit_fields() failure through visit_end_struct() here to out. Correct?

Yes.

Quoted 27 lines

scripts/qapi.py def gen_err_check(label='out', skiperr=False): · line 1640

Quoted 8 lines

+++ b/scripts/qapi.py

scripts/qapi.py +2 -1
@@ -1636,7 +1636,8 @@ def gen_err_check(label='out', skiperr=False):
                  label=label)
 
 
-def gen_visit_fields(members, prefix='', need_cast=False, skiperr=False):
+def gen_visit_fields(members, prefix='', need_cast=False, skiperr=False,
+                     label='out'):

Probably clearer than label=None, but duplicates gen_err_check()'s default. Fine with me.

scripts/qapi.py def gen_err_check(label='out', skiperr=False): · line 1643

Quoted 3 lines
scripts/qapi.py +0 -0
     ret = ''
     if skiperr:
         errparg = 'NULL'

else:
errparg = '&err'

for memb in members:
if memb.optional:
ret += mcgen('''
if (visit_optional(v, "%(name)s", &%(prefix)shas_%(c_name)s)) {
''',
prefix=prefix, c_name=c_name(memb.name), name=memb.name, errp=errparg)
push_indent()

Quoted 1 line

errp=errparg unused here. Not this patch's job to clean up.

Bah. Commit 5cdc8831 missed it, due to repeated refactoring. I'm a bit surprised that pep8 didn't complain. Okay, I'm adding it as a separate cleanup.

Signature · 2 lines
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org
#23 lore raw

Re: [Qemu-devel] [PATCH v9 07/37] qapi: Improve generated event use of qapi visitor

Quoted 61 lines · Eric Blake
Quoted 8 lines · Markus Armbruster
Quoted 4 lines · Eric Blake

All other successful clients of visit_start_struct() were paired with an unconditional visit_end_struct(); but the generated code for events was relying on qmp_output_visitor_cleanup() to work on an incomplete visit.

Disgusting, isn't it? :)

This, along with the fix in 5/37, were the two places that had to be fixed to avoid assertions in patch 24, when I turned on stricter enforcing of cleanup only on an evenly matched visit.

Quoted 17 lines
Quoted 17 lines

Alter the code to guarantee that
the struct is completed, which will make a future patch to split visit_end_struct() easier to reason about. While at it, drop some assertions and comments that are not present in other uses of the qmp output visitor, and pass NULL rather than "" as the 'kind' parameter (matching most other uses where obj is NULL).

---
v9: save churn in declaration order for later series on boxed params, drop Marc-Andre's R-b
v8: no change
v7: place earlier in series, adjust handling of 'kind'
v6: new patch

Quoted 2 lines
Quoted 2 lines

If desired, I can defer the hunk re-ordering the declaration of obj to later in the series where it actually comes in handy.

Dead sentence leftover from v8; as mentioned above, I DID sink the declaration reordering to a later series for v9. But it's after the ---, so it gets trimmed automatically by 'git am'.

Quoted 17 lines

scripts/qapi-event.py def gen_event_send(name, arg_type): · line 71

Quoted 4 lines
         ret += gen_err_check()
scripts/qapi-event.py +2 -1
-        ret += gen_visit_fields(arg_type.members, need_cast=True)
+        ret += gen_visit_fields(arg_type.members, need_cast=True,
+                                label='out_obj')

On error, we now go to out_obj rather than out. Some fields will be unvisited then (possibly all), and err will be set.

Now I get to figure out what this change changes.

Quoted 6 lines
         ret += mcgen('''
+out_obj:
     visit_end_struct(v, &err);
     if (err) {
         goto out;
     }
Quoted 4 lines

Good: we actually call visit_end_struct() as we should.

Not so good: if we get here via the error exit of gen_visit_fields(), err is set. If visit_end_struct() tries to set another error...

Quoted 8 lines

Oops. It all gets cleaned up in 33 when visit_end_struct() loses the errp argument, but in the meantime, I think the most robust way to write this would be:

out_obj:

    visit_end_struct(v, err ? NULL : &err);
    if (err) {

...

Works. I don't like it much, because it doesn't conform to the usual error handling patterns, but since it's only temporary, I'm fine with it.

Quoted 4 lines
Quoted 2 lines

I guess the idea is to go from gen_visit_fields() failure through visit_end_struct() here to out. Correct?

Yes.

Rather complex control flow. At the end of the series, it looks like this:

        visit_start_struct(v, "%(name)s", NULL, 0, &err);
        if (err) {
            goto out;
        }
        [visit the fields, on error goto out_obj...]
        visit_check_struct(v, &err);
    out_obj:
        visit_end_struct(v);
        if (err) {
            goto out;
        }

The error check after visit_end_struct() sees either an error from a field visit, or from the visit_end_struct().

Tolerable.

Quoted 27 lines
Quoted 27 lines

scripts/qapi.py def gen_err_check(label='out', skiperr=False): · line 1640

Quoted 8 lines

+++ b/scripts/qapi.py

scripts/qapi.py +2 -1
@@ -1636,7 +1636,8 @@ def gen_err_check(label='out', skiperr=False):
                  label=label)
 
 
-def gen_visit_fields(members, prefix='', need_cast=False, skiperr=False):
+def gen_visit_fields(members, prefix='', need_cast=False, skiperr=False,
+                     label='out'):

Probably clearer than label=None, but duplicates gen_err_check()'s default. Fine with me.

scripts/qapi.py def gen_err_check(label='out', skiperr=False): · line 1643

Quoted 3 lines
scripts/qapi.py +0 -0
     ret = ''
     if skiperr:
         errparg = 'NULL'

else:
errparg = '&err'

for memb in members:
if memb.optional:
ret += mcgen('''
if (visit_optional(v, "%(name)s", &%(prefix)shas_%(c_name)s)) {
''',
prefix=prefix, c_name=c_name(memb.name), name=memb.name, errp=errparg)
push_indent()

Quoted 5 lines
Quoted 1 line

errp=errparg unused here. Not this patch's job to clean up.

Bah. Commit 5cdc8831 missed it, due to repeated refactoring. I'm a bit surprised that pep8 didn't complain. Okay, I'm adding it as a separate cleanup.

Thanks!

author
#24 lore raw

Re: [Qemu-devel] [PATCH v9 07/37] qapi: Improve generated event use of qapi visitor

In reply to Eric Blake
Quoted 7 lines · Eric Blake

Oops. It all gets cleaned up in 33 when visit_end_struct() loses the errp argument, but in the meantime, I think the most robust way to write this would be:

out_obj:

    visit_end_struct(v, err ? NULL : &err);
    if (err) {
Quoted 7 lines

...

Quoted 3 lines

I guess the idea is to go from gen_visit_fields() failure through visit_end_struct() here to out. Correct?

Yes.

Technically, visit_end_struct() for QMP output visitor never sets errp, but it's not nice to have to audit multiple files just to find that out.
I'll stick to the ternary until patch 33 cleans it back up.

Signature · 2 lines
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org
author
#25 lore raw

Re: [Qemu-devel] [PATCH v9 07/37] qapi: Improve generated event use of qapi visitor

In reply to Markus Armbruster
Quoted 13 lines · Markus Armbruster
Quoted 11 lines · Eric Blake

All other successful clients of visit_start_struct() were paired with an unconditional visit_end_struct(); but the generated code for events was relying on qmp_output_visitor_cleanup() to work on an incomplete visit.

+++ b/scripts/qapi.py

scripts/qapi.py +0 -0
@@ -1636,7 +1636,8 @@ def gen_err_check(label='out', skiperr=False):
                  label=label)
 
 
Quoted 6 lines

scripts/qapi.py def gen_err_check(label='out', skiperr=False): · line 1640

Quoted 3 lines
scripts/qapi.py +2 -1
-def gen_visit_fields(members, prefix='', need_cast=False, skiperr=False):
+def gen_visit_fields(members, prefix='', need_cast=False, skiperr=False,
+                     label='out'):

Probably clearer than label=None, but duplicates gen_err_check()'s default. Fine with me.

Use of label=None resulted in literal "goto None;" in the generated file (Python stringized it, rather than treating it as a hint to behave as if the argument were not supplied). So yes, I had to duplicate the default value in both methods, to avoid having to do 'if label:' within the implementations.

Signature · 2 lines
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org
author
#26 lore raw

PATCH v9 8/37 qapi: Track all failures between visit_start/stop

In reply to Eric Blake

Inside the generated code between visit_start_struct() and visit_end_struct(), we were blindly setting the error into the caller's errp parameter. But a future patch to split visit_end_struct() will require that we take action based on whether an error has occurred, which requires us to track all actions through a local err. Rewrite the visits to be more in line with the other generated calls.

Generated code changes look like:

|@@ -42,12 +42,18 @@ void visit_type_GuestAgentCommandInfo(Vi
|     Error *err = NULL;
|
|     visit_start_struct(v, (void **)obj, "GuestAgentCommandInfo", name, sizeof(GuestAgentCommandInfo), &err);
|-    if (!err) {
|-        if (*obj) {
|-            visit_type_GuestAgentCommandInfo_fields(v, obj, errp);
|-        }
|-        visit_end_struct(v, &err);
|+    if (err) {
|+        goto out;
|     }
|+    if (!*obj) {
|+        goto out_obj;
|+    }
|+    visit_type_GuestAgentCommandInfo_fields(v, obj, &err);
|+out_obj:
|+    error_propagate(errp, err);
|+    err = NULL;
|+    visit_end_struct(v, &err);
|+out:
|     error_propagate(errp, err);
| }

---
v9: enhance commit message
v8: no change
v7: place earlier in series
v6: based loosely on v5 7/46, but mostly a rewrite to get the last generated code in the same form as all the others, so that the later conversion to split visit_check_struct() will be easier

---
 scripts/qapi-visit.py | 16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)
scripts/qapi-visit.py +11 -5
index b93690b..4a4f67d 100644
@@ -123,12 +123,18 @@ void visit_type_%(c_name)s(Visitor *v, %(c_name)s **obj, const char *name, Error
     Error *err = NULL;
 
     visit_start_struct(v, (void **)obj, "%(name)s", name, sizeof(%(c_name)s), &err);
-    if (!err) {
-        if (*obj) {
-            visit_type_%(c_name)s_fields(v, obj, errp);
-        }
-        visit_end_struct(v, &err);
+    if (err) {
+        goto out;
     }
+    if (!*obj) {
+        goto out_obj;
+    }
+    visit_type_%(c_name)s_fields(v, obj, &err);
+out_obj:
+    error_propagate(errp, err);
+    err = NULL;
+    visit_end_struct(v, &err);
+out:
     error_propagate(errp, err);
 }
 ''',
Signature · 1 line
2.5.0
#27 lore raw

Re: [Qemu-devel] [PATCH v9 08/37] qapi: Track all failures between visit_start/stop

Quoted 11 lines · Eric Blake

Inside the generated code between visit_start_struct() and visit_end_struct(), we were blindly setting the error into the caller's errp parameter. But a future patch to split visit_end_struct() will require that we take action based on whether an error has occurred, which requires us to track all actions through a local err. Rewrite the visits to be more in line with the other generated calls.

Generated code changes look like:

|@@ -42,12 +42,18 @@ void visit_type_GuestAgentCommandInfo(Vi

I'd drop this line.

Quoted 4 lines
|     Error *err = NULL;
|
|     visit_start_struct(v, (void **)obj, "GuestAgentCommandInfo", name, sizeof(GuestAgentCommandInfo), &err);
|-    if (!err) {
Quoted 8 lines
|-        if (*obj) {
|-            visit_type_GuestAgentCommandInfo_fields(v, obj, errp);
|-        }
|-        visit_end_struct(v, &err);
|+    if (err) {
|+        goto out;
|     }
|+    if (!*obj) {

err is clear here.

Quoted 6 lines
|+        goto out_obj;
|+    }
|+    visit_type_GuestAgentCommandInfo_fields(v, obj, &err);
|+out_obj:
|+    error_propagate(errp, err);
|+    err = NULL;

If we come from goto out_obj, these two lines are no-ops.

Quoted 37 lines
|+    visit_end_struct(v, &err);
|+out:
|     error_propagate(errp, err);
| }

---
v9: enhance commit message
v8: no change
v7: place earlier in series
v6: based loosely on v5 7/46, but mostly a rewrite to get the last generated code in the same form as all the others, so that the later conversion to split visit_check_struct() will be easier

---
 scripts/qapi-visit.py | 16 +++++++++++-----
 1 file changed, 11 insertions(+), 5 deletions(-)
scripts/qapi-visit.py +4 -5
index b93690b..4a4f67d 100644
@@ -123,12 +123,18 @@ void visit_type_%(c_name)s(Visitor *v, %(c_name)s **obj, const char *name, Error
     Error *err = NULL;
 
     visit_start_struct(v, (void **)obj, "%(name)s", name, sizeof(%(c_name)s), &err);
-    if (!err) {
-        if (*obj) {
-            visit_type_%(c_name)s_fields(v, obj, errp);
-        }
-        visit_end_struct(v, &err);
+    if (err) {
+        goto out;
     }
+    if (!*obj) {
+        goto out_obj;

scripts/qapi-visit.py void visit_type_%(c_name)s(Visitor *v, %(c_name)s **obj, const char *name, Error · line 140

Quoted 10 lines
scripts/qapi-visit.py +7 -0
+    }
+    visit_type_%(c_name)s_fields(v, obj, &err);
+out_obj:
+    error_propagate(errp, err);
+    err = NULL;
+    visit_end_struct(v, &err);
+out:
     error_propagate(errp, err);
 }
 ''',

gen_visit_union(), the other generator of visit_start_struct(), already does it this way. It generates additional goto out_obj, so the placement of out_obj makes more sense there. I guess we want to place it in the same spot here to facilitate unifying the two.

author
#28 lore raw

Re: [Qemu-devel] [PATCH v9 08/37] qapi: Track all failures between visit_start/stop

Quoted 15 lines · Markus Armbruster
Quoted 10 lines · Eric Blake

Inside the generated code between visit_start_struct() and visit_end_struct(), we were blindly setting the error into the caller's errp parameter. But a future patch to split visit_end_struct() will require that we take action based on whether an error has occurred, which requires us to track all actions through a local err. Rewrite the visits to be more in line with the other generated calls.

|+ if (!*obj) {

err is clear here.

Quoted 8 lines
Quoted 6 lines
|+        goto out_obj;
|+    }
|+    visit_type_GuestAgentCommandInfo_fields(v, obj, &err);
|+out_obj:
|+    error_propagate(errp, err);
|+    err = NULL;

If we come from goto out_obj, these two lines are no-ops.

I could move the label, if desired...

Quoted 11 lines
Quoted 5 lines
|+    visit_end_struct(v, &err);
|+out:
|     error_propagate(errp, err);
| }

gen_visit_union(), the other generator of visit_start_struct(), already does it this way. It generates additional goto out_obj, so the placement of out_obj makes more sense there. I guess we want to place it in the same spot here to facilitate unifying the two.

...but as you observed, the unification in 31 is a bit easier with it placed identically. Maybe a commit message comment is in order.

Signature · 2 lines
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org
#29 lore raw

Re: [Qemu-devel] [PATCH v9 08/37] qapi: Track all failures between visit_start/stop

Quoted 34 lines · Eric Blake
Quoted 15 lines · Markus Armbruster
Quoted 10 lines · Eric Blake

Inside the generated code between visit_start_struct() and visit_end_struct(), we were blindly setting the error into the caller's errp parameter. But a future patch to split visit_end_struct() will require that we take action based on whether an error has occurred, which requires us to track all actions through a local err. Rewrite the visits to be more in line with the other generated calls.

|+ if (!*obj) {

err is clear here.

Quoted 8 lines
Quoted 6 lines
|+        goto out_obj;
|+    }
|+    visit_type_GuestAgentCommandInfo_fields(v, obj, &err);
|+out_obj:
|+    error_propagate(errp, err);
|+    err = NULL;

If we come from goto out_obj, these two lines are no-ops.

I could move the label, if desired...

Quoted 7 lines
Quoted 5 lines
|+    visit_end_struct(v, &err);
|+out:
|     error_propagate(errp, err);
| }
Quoted 7 lines
Quoted 4 lines

gen_visit_union(), the other generator of visit_start_struct(), already does it this way. It generates additional goto out_obj, so the placement of out_obj makes more sense there. I guess we want to place it in the same spot here to facilitate unifying the two.

...but as you observed, the unification in 31 is a bit easier with it placed identically. Maybe a commit message comment is in order.

Or perhaps move it forward now, and move it back when you actually need it back.

Reviewers appreciate miminal patch churn, but they also appreciate patches making sense on their own. Reviewer are looking at your patch with precious little context in general, and next to zero visibility into later patches in particular.

author
#30 lore raw

PATCH v9 9/37 qapi: Prefer type_int64 over type_int in visitors

In reply to Eric Blake

The qapi builtin type 'int' is basically shorthand for the type 'int64'. In fact, since no visitor was providing the optional type_int64() callback, visit_type_int64() was just always falling back to type_int(), cementing the equivalence between the types.

However, some visitors are providing a type_uint64() callback. For purposes of code consistency, it is nicer if all visitors use the paired type_int64/type_uint64 names rather than the mismatched type_int/type_uint64. So this patch just renames the signed int callbacks in place, dropping the type_int() callback as redundant, and a later patch will focus on the unsigned int callbacks.

Add some FIXMEs to questionable reuse of errp in code touched by the rename, while at it (the reuse works as long as the callbacks don't modify value when setting an error, but it's not a good example to set) - a later patch will then fix those.

No change in functionality here, although further cleanups are in the pipeline.

---
v9: improve commit message, hoist in part of 11/35, drop Marc-Andre's R-b
v8: no change
v7: split off of 1/23 and 2/23 for easier-to-read diffs

---
 include/qapi/visitor-impl.h  |  6 ++++--
 qapi/opts-visitor.c          |  4 ++--
 qapi/qapi-dealloc-visitor.c  |  6 +++---
 qapi/qapi-visit-core.c       | 36 ++++++++++++++++++++++--------------
 qapi/qmp-input-visitor.c     |  6 +++---
 qapi/qmp-output-visitor.c    |  6 +++---
 qapi/string-input-visitor.c  |  6 +++---
 qapi/string-output-visitor.c |  6 +++---
 8 files changed, 43 insertions(+), 33 deletions(-)
include/qapi/visitor-impl.h +4 -2
index 44a21b7..c263a26 100644
@@ -36,7 +36,10 @@ struct Visitor
     void (*get_next_type)(Visitor *v, QType *type, bool promote_int,
                           const char *name, Error **errp);
 
-    void (*type_int)(Visitor *v, int64_t *obj, const char *name, Error **errp);
+    /* Must be set. */
+    void (*type_int64)(Visitor *v, int64_t *obj, const char *name,
+                       Error **errp);
+    /* Must be set. */
     void (*type_bool)(Visitor *v, bool *obj, const char *name, Error **errp);
     void (*type_str)(Visitor *v, char **obj, const char *name, Error **errp);
     void (*type_number)(Visitor *v, double *obj, const char *name,
@@ -54,7 +57,6 @@ struct Visitor
     void (*type_int8)(Visitor *v, int8_t *obj, const char *name, Error **errp);
     void (*type_int16)(Visitor *v, int16_t *obj, const char *name, Error **errp);
     void (*type_int32)(Visitor *v, int32_t *obj, const char *name, Error **errp);
-    void (*type_int64)(Visitor *v, int64_t *obj, const char *name, Error **errp);
     /* visit_type_size() falls back to (*type_uint64)() if type_size is unset */
     void (*type_size)(Visitor *v, uint64_t *obj, const char *name, Error **errp);
     bool (*start_union)(Visitor *v, bool data_present, Error **errp);
qapi/opts-visitor.c +2 -2
index dd4094c..56c798f 100644
@@ -360,7 +360,7 @@ opts_type_bool(Visitor *v, bool *obj, const char *name, Error **errp)
 
 
 static void
-opts_type_int(Visitor *v, int64_t *obj, const char *name, Error **errp)
+opts_type_int64(Visitor *v, int64_t *obj, const char *name, Error **errp)
 {
     OptsVisitor *ov = to_ov(v);
     const QemuOpt *opt;
@@ -528,7 +528,7 @@ opts_visitor_new(const QemuOpts *opts)
      */
     ov->visitor.type_enum = &input_type_enum;
 
-    ov->visitor.type_int    = &opts_type_int;
+    ov->visitor.type_int64  = &opts_type_int64;
     ov->visitor.type_uint64 = &opts_type_uint64;
     ov->visitor.type_size   = &opts_type_size;
     ov->visitor.type_bool   = &opts_type_bool;
qapi/qapi-dealloc-visitor.c +3 -3
index 204de8f..e9b9f3f 100644
@@ -135,8 +135,8 @@ static void qapi_dealloc_type_str(Visitor *v, char **obj, const char *name,
     }
 }
 
-static void qapi_dealloc_type_int(Visitor *v, int64_t *obj, const char *name,
-                                  Error **errp)
+static void qapi_dealloc_type_int64(Visitor *v, int64_t *obj, const char *name,
+                                    Error **errp)
 {
 }
 
@@ -219,7 +219,7 @@ QapiDeallocVisitor *qapi_dealloc_visitor_new(void)
     v->visitor.next_list = qapi_dealloc_next_list;
     v->visitor.end_list = qapi_dealloc_end_list;
     v->visitor.type_enum = qapi_dealloc_type_enum;
-    v->visitor.type_int = qapi_dealloc_type_int;
+    v->visitor.type_int64 = qapi_dealloc_type_int64;
     v->visitor.type_bool = qapi_dealloc_type_bool;
     v->visitor.type_str = qapi_dealloc_type_str;
     v->visitor.type_number = qapi_dealloc_type_number;
qapi/qapi-visit-core.c +22 -14
index 6d63e40..6295fa8 100644
@@ -97,7 +97,7 @@ void visit_type_enum(Visitor *v, int *obj, const char * const strings[],
 
 void visit_type_int(Visitor *v, int64_t *obj, const char *name, Error **errp)
 {
-    v->type_int(v, obj, name, errp);
+    v->type_int64(v, obj, name, errp);
 }
 
 void visit_type_uint8(Visitor *v, uint8_t *obj, const char *name, Error **errp)
@@ -108,8 +108,10 @@ void visit_type_uint8(Visitor *v, uint8_t *obj, const char *name, Error **errp)
         v->type_uint8(v, obj, name, errp);
     } else {
         value = *obj;
-        v->type_int(v, &value, name, errp);
+        v->type_int64(v, &value, name, errp);
         if (value < 0 || value > UINT8_MAX) {
+            /* FIXME questionable reuse of errp if type_int64() changes
+               value on error */
             error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
                        name ? name : "null", "uint8_t");
             return;
@@ -126,8 +128,10 @@ void visit_type_uint16(Visitor *v, uint16_t *obj, const char *name, Error **errp
         v->type_uint16(v, obj, name, errp);
     } else {
         value = *obj;
-        v->type_int(v, &value, name, errp);
+        v->type_int64(v, &value, name, errp);
         if (value < 0 || value > UINT16_MAX) {
+            /* FIXME questionable reuse of errp if type_int64() changes
+               value on error */
             error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
                        name ? name : "null", "uint16_t");
             return;
@@ -144,8 +148,10 @@ void visit_type_uint32(Visitor *v, uint32_t *obj, const char *name, Error **errp
         v->type_uint32(v, obj, name, errp);
     } else {
         value = *obj;
-        v->type_int(v, &value, name, errp);
+        v->type_int64(v, &value, name, errp);
         if (value < 0 || value > UINT32_MAX) {
+            /* FIXME questionable reuse of errp if type_int64() changes
+               value on error */
             error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
                        name ? name : "null", "uint32_t");
             return;
@@ -162,7 +168,7 @@ void visit_type_uint64(Visitor *v, uint64_t *obj, const char *name, Error **errp
         v->type_uint64(v, obj, name, errp);
     } else {
         value = *obj;
-        v->type_int(v, &value, name, errp);
+        v->type_int64(v, &value, name, errp);
         *obj = value;
     }
 }
@@ -175,8 +181,10 @@ void visit_type_int8(Visitor *v, int8_t *obj, const char *name, Error **errp)
         v->type_int8(v, obj, name, errp);
     } else {
         value = *obj;
-        v->type_int(v, &value, name, errp);
+        v->type_int64(v, &value, name, errp);
         if (value < INT8_MIN || value > INT8_MAX) {
+            /* FIXME questionable reuse of errp if type_int64() changes
+               value on error */
             error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
                        name ? name : "null", "int8_t");
             return;
@@ -193,8 +201,10 @@ void visit_type_int16(Visitor *v, int16_t *obj, const char *name, Error **errp)
         v->type_int16(v, obj, name, errp);
     } else {
         value = *obj;
-        v->type_int(v, &value, name, errp);
+        v->type_int64(v, &value, name, errp);
         if (value < INT16_MIN || value > INT16_MAX) {
+            /* FIXME questionable reuse of errp if type_int64() changes
+               value on error */
             error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
                        name ? name : "null", "int16_t");
             return;
@@ -211,8 +221,10 @@ void visit_type_int32(Visitor *v, int32_t *obj, const char *name, Error **errp)
         v->type_int32(v, obj, name, errp);
     } else {
         value = *obj;
-        v->type_int(v, &value, name, errp);
+        v->type_int64(v, &value, name, errp);
         if (value < INT32_MIN || value > INT32_MAX) {
+            /* FIXME questionable reuse of errp if type_int64() changes
+               value on error */
             error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
                        name ? name : "null", "int32_t");
             return;
@@ -223,11 +235,7 @@ void visit_type_int32(Visitor *v, int32_t *obj, const char *name, Error **errp)
 
 void visit_type_int64(Visitor *v, int64_t *obj, const char *name, Error **errp)
 {
-    if (v->type_int64) {
-        v->type_int64(v, obj, name, errp);
-    } else {
-        v->type_int(v, obj, name, errp);
-    }
+    v->type_int64(v, obj, name, errp);
 }
 
 void visit_type_size(Visitor *v, uint64_t *obj, const char *name, Error **errp)
@@ -240,7 +248,7 @@ void visit_type_size(Visitor *v, uint64_t *obj, const char *name, Error **errp)
         v->type_uint64(v, obj, name, errp);
     } else {
         value = *obj;
-        v->type_int(v, &value, name, errp);
+        v->type_int64(v, &value, name, errp);
         *obj = value;
     }
 }
qapi/qmp-input-visitor.c +3 -3
index 932b5f3..0d8a3c3 100644
@@ -224,8 +224,8 @@ static void qmp_input_get_next_type(Visitor *v, QType *type, bool promote_int,
     }
 }
 
-static void qmp_input_type_int(Visitor *v, int64_t *obj, const char *name,
-                               Error **errp)
+static void qmp_input_type_int64(Visitor *v, int64_t *obj, const char *name,
+                                 Error **errp)
 {
     QmpInputVisitor *qiv = to_qiv(v);
     QInt *qint = qobject_to_qint(qmp_input_get_object(qiv, name, true));
@@ -341,7 +341,7 @@ QmpInputVisitor *qmp_input_visitor_new(QObject *obj)
     v->visitor.next_list = qmp_input_next_list;
     v->visitor.end_list = qmp_input_end_list;
     v->visitor.type_enum = input_type_enum;
-    v->visitor.type_int = qmp_input_type_int;
+    v->visitor.type_int64 = qmp_input_type_int64;
     v->visitor.type_bool = qmp_input_type_bool;
     v->visitor.type_str = qmp_input_type_str;
     v->visitor.type_number = qmp_input_type_number;
qapi/qmp-output-visitor.c +3 -3
index 29899ac..3984011 100644
@@ -158,8 +158,8 @@ static void qmp_output_end_list(Visitor *v, Error **errp)
     qmp_output_pop(qov);
 }
 
-static void qmp_output_type_int(Visitor *v, int64_t *obj, const char *name,
-                                Error **errp)
+static void qmp_output_type_int64(Visitor *v, int64_t *obj, const char *name,
+                                  Error **errp)
 {
     QmpOutputVisitor *qov = to_qov(v);
     qmp_output_add(qov, name, qint_from_int(*obj));
@@ -241,7 +241,7 @@ QmpOutputVisitor *qmp_output_visitor_new(void)
     v->visitor.next_list = qmp_output_next_list;
     v->visitor.end_list = qmp_output_end_list;
     v->visitor.type_enum = output_type_enum;
-    v->visitor.type_int = qmp_output_type_int;
+    v->visitor.type_int64 = qmp_output_type_int64;
     v->visitor.type_bool = qmp_output_type_bool;
     v->visitor.type_str = qmp_output_type_str;
     v->visitor.type_number = qmp_output_type_number;
qapi/string-input-visitor.c +3 -3
index 7f5645b..2f422f0 100644
@@ -184,8 +184,8 @@ end_list(Visitor *v, Error **errp)
     siv->head = true;
 }
 
-static void parse_type_int(Visitor *v, int64_t *obj, const char *name,
-                           Error **errp)
+static void parse_type_int64(Visitor *v, int64_t *obj, const char *name,
+                             Error **errp)
 {
     StringInputVisitor *siv = to_siv(v);
 
@@ -335,7 +335,7 @@ StringInputVisitor *string_input_visitor_new(const char *str)
     v = g_malloc0(sizeof(*v));
 
     v->visitor.type_enum = input_type_enum;
-    v->visitor.type_int = parse_type_int;
+    v->visitor.type_int64 = parse_type_int64;
     v->visitor.type_size = parse_type_size;
     v->visitor.type_bool = parse_type_bool;
     v->visitor.type_str = parse_type_str;
qapi/string-output-visitor.c +3 -3
index 202764c..c0a9331 100644
@@ -121,8 +121,8 @@ static void format_string(StringOutputVisitor *sov, Range *r, bool next,
     }
 }
 
-static void print_type_int(Visitor *v, int64_t *obj, const char *name,
-                           Error **errp)
+static void print_type_int64(Visitor *v, int64_t *obj, const char *name,
+                             Error **errp)
 {
     StringOutputVisitor *sov = to_sov(v);
     GList *l;
@@ -345,7 +345,7 @@ StringOutputVisitor *string_output_visitor_new(bool human)
     v->string = g_string_new(NULL);
     v->human = human;
     v->visitor.type_enum = output_type_enum;
-    v->visitor.type_int = print_type_int;
+    v->visitor.type_int64 = print_type_int64;
     v->visitor.type_size = print_type_size;
     v->visitor.type_bool = print_type_bool;
     v->visitor.type_str = print_type_str;
Signature · 1 line
2.5.0
#31 lore raw

Re: [Qemu-devel] [PATCH v9 09/37] qapi: Prefer type_int64 over type_int in visitors

Quoted 22 lines · Eric Blake

The qapi builtin type 'int' is basically shorthand for the type 'int64'. In fact, since no visitor was providing the optional type_int64() callback, visit_type_int64() was just always falling back to type_int(), cementing the equivalence between the types.

However, some visitors are providing a type_uint64() callback. For purposes of code consistency, it is nicer if all visitors use the paired type_int64/type_uint64 names rather than the mismatched type_int/type_uint64. So this patch just renames the signed int callbacks in place, dropping the type_int() callback as redundant, and a later patch will focus on the unsigned int callbacks.

Add some FIXMEs to questionable reuse of errp in code touched by the rename, while at it (the reuse works as long as the callbacks don't modify value when setting an error, but it's not a good example to set) - a later patch will then fix those.

No change in functionality here, although further cleanups are in the pipeline.

[...]

Quoted 14 lines
qapi/qapi-visit-core.c +1 -1
index 6d63e40..6295fa8 100644
@@ -97,7 +97,7 @@ void visit_type_enum(Visitor *v, int *obj, const char * const strings[],
 
 void visit_type_int(Visitor *v, int64_t *obj, const char *name, Error **errp)
 {
-    v->type_int(v, obj, name, errp);
+    v->type_int64(v, obj, name, errp);
 }
 
 void visit_type_uint8(Visitor *v, uint8_t *obj, const char *name, Error **errp)

qapi/qapi-visit-core.c void visit_type_uint8(Visitor *v, uint8_t *obj, const char *name, Error **errp) · line 116

Quoted 10 lines
qapi/qapi-visit-core.c +3 -1
@@ -108,8 +108,10 @@ void visit_type_uint8(Visitor *v, uint8_t *obj, const char *name, Error **errp)
         v->type_uint8(v, obj, name, errp);
     } else {
         value = *obj;
-        v->type_int(v, &value, name, errp);
+        v->type_int64(v, &value, name, errp);
         if (value < 0 || value > UINT8_MAX) {
+            /* FIXME questionable reuse of errp if type_int64() changes
+               value on error */
             error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
                        name ? name : "null", "uint8_t");

Changing value on error would be in bad taste, and could be outlawed in the contract. But you demonstrate in PATCH 11 that there's no need to depend on it not being changed.

Quoted 1 line
qapi/qapi-visit-core.c +0 -0
             return;

[...]

author
#32 lore raw

PATCH v9 10/37 qapi: Make all visitors supply uint64 callbacks

In reply to Eric Blake

Our qapi visitor contract supports multiple integer visitors, but left the type_uint64 visitor as optional (falling back on type_int64); it also marks the type_size visitor as optional (falling back on type_uint64 or even type_int64).

Note that the default of falling back on type_int for unsigned visitors can cause confusing results for values larger than INT64_MAX (such as having to pass in a negative 2s complement value on input, and getting a negative result on output).

This patch does not fully address the disparity in handling large values as negatives, but does move towards a cleaner situation where EVERY visitor provides both type_int64 and type_uint64 variants as entry points; then each client can either implement sane differences between the two, or document in place with a FIXME that there is munging going on.

The dealloc visitor no longer needs a type_size callback, since that now safely falls back to the type_uint64 callback.

Then, in qapi-visit-core.c, we can now use the guaranteed type_uint64 callback as the fallback for all smaller unsigned int visits.

---
v9: hoist in part of 11/35, drop Marc-Andre's R-b
v8: no change
v7: split off int64 callbacks and retitle, add more FIXMEs in the code, hoist use of type_uint64 here from 3/23, improved commit message
v6: new patch, but stems from v5 23/46

---
 include/qapi/visitor-impl.h  |  9 ++++++---
 qapi/qapi-dealloc-visitor.c  | 12 ++++++------
 qapi/qapi-visit-core.c       | 42 ++++++++++++++----------------------------
 qapi/qmp-input-visitor.c     | 17 +++++++++++++++++
 qapi/qmp-output-visitor.c    |  9 +++++++++
 qapi/string-input-visitor.c  | 15 +++++++++++++++
 qapi/string-output-visitor.c |  9 +++++++++
 7 files changed, 76 insertions(+), 37 deletions(-)
include/qapi/visitor-impl.h +6 -3
index c263a26..45c1d3e 100644
@@ -40,6 +40,12 @@ struct Visitor
     void (*type_int64)(Visitor *v, int64_t *obj, const char *name,
                        Error **errp);
     /* Must be set. */
+    void (*type_uint64)(Visitor *v, uint64_t *obj, const char *name,
+                        Error **errp);
+    /* Optional; fallback is type_uint64().  */
+    void (*type_size)(Visitor *v, uint64_t *obj, const char *name,
+                      Error **errp);
+    /* Must be set. */
     void (*type_bool)(Visitor *v, bool *obj, const char *name, Error **errp);
     void (*type_str)(Visitor *v, char **obj, const char *name, Error **errp);
     void (*type_number)(Visitor *v, double *obj, const char *name,
@@ -53,12 +59,9 @@ struct Visitor
     void (*type_uint8)(Visitor *v, uint8_t *obj, const char *name, Error **errp);
     void (*type_uint16)(Visitor *v, uint16_t *obj, const char *name, Error **errp);
     void (*type_uint32)(Visitor *v, uint32_t *obj, const char *name, Error **errp);
-    void (*type_uint64)(Visitor *v, uint64_t *obj, const char *name, Error **errp);
     void (*type_int8)(Visitor *v, int8_t *obj, const char *name, Error **errp);
     void (*type_int16)(Visitor *v, int16_t *obj, const char *name, Error **errp);
     void (*type_int32)(Visitor *v, int32_t *obj, const char *name, Error **errp);
-    /* visit_type_size() falls back to (*type_uint64)() if type_size is unset */
-    void (*type_size)(Visitor *v, uint64_t *obj, const char *name, Error **errp);
     bool (*start_union)(Visitor *v, bool data_present, Error **errp);
     void (*end_union)(Visitor *v, bool data_present, Error **errp);
 };
qapi/qapi-dealloc-visitor.c +6 -6
index e9b9f3f..11eb828 100644
@@ -140,6 +140,11 @@ static void qapi_dealloc_type_int64(Visitor *v, int64_t *obj, const char *name,
 {
 }
 
+static void qapi_dealloc_type_uint64(Visitor *v, uint64_t *obj,
+                                     const char *name, Error **errp)
+{
+}
+
 static void qapi_dealloc_type_bool(Visitor *v, bool *obj, const char *name,
                                    Error **errp)
 {
@@ -158,11 +163,6 @@ static void qapi_dealloc_type_anything(Visitor *v, QObject **obj,
     }
 }
 
-static void qapi_dealloc_type_size(Visitor *v, uint64_t *obj, const char *name,
-                                   Error **errp)
-{
-}
-
 static void qapi_dealloc_type_enum(Visitor *v, int *obj,
                                    const char * const strings[],
                                    const char *kind, const char *name,
@@ -220,11 +220,11 @@ QapiDeallocVisitor *qapi_dealloc_visitor_new(void)
     v->visitor.end_list = qapi_dealloc_end_list;
     v->visitor.type_enum = qapi_dealloc_type_enum;
     v->visitor.type_int64 = qapi_dealloc_type_int64;
+    v->visitor.type_uint64 = qapi_dealloc_type_uint64;
     v->visitor.type_bool = qapi_dealloc_type_bool;
     v->visitor.type_str = qapi_dealloc_type_str;
     v->visitor.type_number = qapi_dealloc_type_number;
     v->visitor.type_any = qapi_dealloc_type_anything;
-    v->visitor.type_size = qapi_dealloc_type_size;
     v->visitor.start_union = qapi_dealloc_start_union;
 
     QTAILQ_INIT(&v->stack);
qapi/qapi-visit-core.c +14 -28

90 lines not on this page · raw message

qapi/qmp-input-visitor.c +17 -0
index 0d8a3c3..32b60bb 100644
@@ -239,6 +239,22 @@ static void qmp_input_type_int64(Visitor *v, int64_t *obj, const char *name,
     *obj = qint_get_int(qint);
 }
 
+static void qmp_input_type_uint64(Visitor *v, uint64_t *obj, const char *name,
+                                  Error **errp)
+{
+    /* FIXME: qobject_to_qint mishandles values over INT64_MAX */
+    QmpInputVisitor *qiv = to_qiv(v);
+    QInt *qint = qobject_to_qint(qmp_input_get_object(qiv, name, true));
+
+    if (!qint) {
+        error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
+                   "integer");
+        return;
+    }
+
+    *obj = qint_get_int(qint);
+}
+
 static void qmp_input_type_bool(Visitor *v, bool *obj, const char *name,
                                 Error **errp)
 {
@@ -342,6 +358,7 @@ QmpInputVisitor *qmp_input_visitor_new(QObject *obj)
     v->visitor.end_list = qmp_input_end_list;
     v->visitor.type_enum = input_type_enum;
     v->visitor.type_int64 = qmp_input_type_int64;
+    v->visitor.type_uint64 = qmp_input_type_uint64;
     v->visitor.type_bool = qmp_input_type_bool;
     v->visitor.type_str = qmp_input_type_str;
     v->visitor.type_number = qmp_input_type_number;
qapi/qmp-output-visitor.c +9 -0
index 3984011..f8eebaa 100644
@@ -165,6 +165,14 @@ static void qmp_output_type_int64(Visitor *v, int64_t *obj, const char *name,
     qmp_output_add(qov, name, qint_from_int(*obj));
 }
 
+static void qmp_output_type_uint64(Visitor *v, uint64_t *obj, const char *name,
+                                   Error **errp)
+{
+    /* FIXME: QMP outputs values larger than INT64_MAX as negative */
+    QmpOutputVisitor *qov = to_qov(v);
+    qmp_output_add(qov, name, qint_from_int(*obj));
+}
+
 static void qmp_output_type_bool(Visitor *v, bool *obj, const char *name,
                                  Error **errp)
 {
@@ -242,6 +250,7 @@ QmpOutputVisitor *qmp_output_visitor_new(void)
     v->visitor.end_list = qmp_output_end_list;
     v->visitor.type_enum = output_type_enum;
     v->visitor.type_int64 = qmp_output_type_int64;
+    v->visitor.type_uint64 = qmp_output_type_uint64;
     v->visitor.type_bool = qmp_output_type_bool;
     v->visitor.type_str = qmp_output_type_str;
     v->visitor.type_number = qmp_output_type_number;
qapi/string-input-visitor.c +15 -0
index 2f422f0..d7546b5 100644
@@ -226,6 +226,20 @@ error:
                "an int64 value or range");
 }
 
+static void parse_type_uint64(Visitor *v, uint64_t *obj, const char *name,
+                              Error **errp)
+{
+    /* FIXME: parse_type_int64 mishandles values over INT64_MAX */
+    int64_t i;
+    Error *err = NULL;
+    parse_type_int64(v, &i, name, &err);
+    if (err) {
+        error_propagate(errp, err);
+    } else {
+        *obj = i;
+    }
+}
+
 static void parse_type_size(Visitor *v, uint64_t *obj, const char *name,
                             Error **errp)
 {
@@ -336,6 +350,7 @@ StringInputVisitor *string_input_visitor_new(const char *str)
 
     v->visitor.type_enum = input_type_enum;
     v->visitor.type_int64 = parse_type_int64;
+    v->visitor.type_uint64 = parse_type_uint64;
     v->visitor.type_size = parse_type_size;
     v->visitor.type_bool = parse_type_bool;
     v->visitor.type_str = parse_type_str;
qapi/string-output-visitor.c +9 -0
index c0a9331..3ed2b2c 100644
@@ -197,6 +197,14 @@ static void print_type_int64(Visitor *v, int64_t *obj, const char *name,
     }
 }
 
+static void print_type_uint64(Visitor *v, uint64_t *obj, const char *name,
+                             Error **errp)
+{
+    /* FIXME: print_type_int64 mishandles values over INT64_MAX */
+    int64_t i = *obj;
+    print_type_int64(v, &i, name, errp);
+}
+
 static void print_type_size(Visitor *v, uint64_t *obj, const char *name,
                            Error **errp)
 {
@@ -346,6 +354,7 @@ StringOutputVisitor *string_output_visitor_new(bool human)
     v->human = human;
     v->visitor.type_enum = output_type_enum;
     v->visitor.type_int64 = print_type_int64;
+    v->visitor.type_uint64 = print_type_uint64;
     v->visitor.type_size = print_type_size;
     v->visitor.type_bool = print_type_bool;
     v->visitor.type_str = print_type_str;
Signature · 1 line
2.5.0
#33 lore raw

Re: [Qemu-devel] [PATCH v9 10/37] qapi: Make all visitors supply uint64 callbacks

Quoted 10 lines · Eric Blake

Our qapi visitor contract supports multiple integer visitors, but left the type_uint64 visitor as optional (falling back on type_int64); it also marks the type_size visitor as optional (falling back on type_uint64 or even type_int64).

Note that the default of falling back on type_int for unsigned visitors can cause confusing results for values larger than INT64_MAX (such as having to pass in a negative 2s complement value on input, and getting a negative result on output).

Quoted 6 lines

This patch does not fully address the disparity in handling large values as negatives, but does move towards a cleaner situation where EVERY visitor provides both type_int64 and type_uint64 variants as entry points; then each client can either implement sane differences between the two, or document in place with a FIXME that there is munging going on.

Before: nobody implements type_uint64(), and the core falls back to type_int64(), casting negative values to large positive ones. With an implementation of type_int64() that parses large positive values as negative, the two casts cancel out.

After: everybody implements type_uint64() incorrectly, by reusing type_int64() code. The problem moves from visitor core to visitor implementations, where we can actually fix it if we care.

Correct?

Quoted 2 lines

The dealloc visitor no longer needs a type_size callback, since that now safely falls back to the type_uint64 callback.

Did it need the callback before this patch?

Quoted 3 lines

Then, in qapi-visit-core.c, we can now use the guaranteed type_uint64 callback as the fallback for all smaller unsigned int visits.

The type_int64() callback works just fine for smaller unsigned ints, but I agree avoiding mixed signedness by using type_uint64() make sense once type_uint64() is mandatory.

Quoted 104 lines

---
v9: hoist in part of 11/35, drop Marc-Andre's R-b
v8: no change
v7: split off int64 callbacks and retitle, add more FIXMEs in the code, hoist use of type_uint64 here from 3/23, improved commit message
v6: new patch, but stems from v5 23/46

---
 include/qapi/visitor-impl.h  |  9 ++++++---
 qapi/qapi-dealloc-visitor.c  | 12 ++++++------
 qapi/qapi-visit-core.c       | 42 ++++++++++++++----------------------------
 qapi/qmp-input-visitor.c     | 17 +++++++++++++++++
 qapi/qmp-output-visitor.c    |  9 +++++++++
 qapi/string-input-visitor.c  | 15 +++++++++++++++
 qapi/string-output-visitor.c |  9 +++++++++
 7 files changed, 76 insertions(+), 37 deletions(-)
include/qapi/visitor-impl.h +6 -3
index c263a26..45c1d3e 100644
@@ -40,6 +40,12 @@ struct Visitor
     void (*type_int64)(Visitor *v, int64_t *obj, const char *name,
                        Error **errp);
     /* Must be set. */
+    void (*type_uint64)(Visitor *v, uint64_t *obj, const char *name,
+                        Error **errp);
+    /* Optional; fallback is type_uint64().  */
+    void (*type_size)(Visitor *v, uint64_t *obj, const char *name,
+                      Error **errp);
+    /* Must be set. */
     void (*type_bool)(Visitor *v, bool *obj, const char *name, Error **errp);
     void (*type_str)(Visitor *v, char **obj, const char *name, Error **errp);
     void (*type_number)(Visitor *v, double *obj, const char *name,
@@ -53,12 +59,9 @@ struct Visitor
     void (*type_uint8)(Visitor *v, uint8_t *obj, const char *name, Error **errp);
     void (*type_uint16)(Visitor *v, uint16_t *obj, const char *name, Error **errp);
     void (*type_uint32)(Visitor *v, uint32_t *obj, const char *name, Error **errp);
-    void (*type_uint64)(Visitor *v, uint64_t *obj, const char *name, Error **errp);
     void (*type_int8)(Visitor *v, int8_t *obj, const char *name, Error **errp);
     void (*type_int16)(Visitor *v, int16_t *obj, const char *name, Error **errp);
     void (*type_int32)(Visitor *v, int32_t *obj, const char *name, Error **errp);
-    /* visit_type_size() falls back to (*type_uint64)() if type_size is unset */
-    void (*type_size)(Visitor *v, uint64_t *obj, const char *name, Error **errp);
     bool (*start_union)(Visitor *v, bool data_present, Error **errp);
     void (*end_union)(Visitor *v, bool data_present, Error **errp);
 };
qapi/qapi-dealloc-visitor.c +6 -6
index e9b9f3f..11eb828 100644
@@ -140,6 +140,11 @@ static void qapi_dealloc_type_int64(Visitor *v, int64_t *obj, const char *name,
 {
 }
 
+static void qapi_dealloc_type_uint64(Visitor *v, uint64_t *obj,
+                                     const char *name, Error **errp)
+{
+}
+
 static void qapi_dealloc_type_bool(Visitor *v, bool *obj, const char *name,
                                    Error **errp)
 {
@@ -158,11 +163,6 @@ static void qapi_dealloc_type_anything(Visitor *v, QObject **obj,
     }
 }
 
-static void qapi_dealloc_type_size(Visitor *v, uint64_t *obj, const char *name,
-                                   Error **errp)
-{
-}
-
 static void qapi_dealloc_type_enum(Visitor *v, int *obj,
                                    const char * const strings[],
                                    const char *kind, const char *name,
@@ -220,11 +220,11 @@ QapiDeallocVisitor *qapi_dealloc_visitor_new(void)
     v->visitor.end_list = qapi_dealloc_end_list;
     v->visitor.type_enum = qapi_dealloc_type_enum;
     v->visitor.type_int64 = qapi_dealloc_type_int64;
+    v->visitor.type_uint64 = qapi_dealloc_type_uint64;
     v->visitor.type_bool = qapi_dealloc_type_bool;
     v->visitor.type_str = qapi_dealloc_type_str;
     v->visitor.type_number = qapi_dealloc_type_number;
     v->visitor.type_any = qapi_dealloc_type_anything;
-    v->visitor.type_size = qapi_dealloc_type_size;
     v->visitor.start_union = qapi_dealloc_start_union;
 
     QTAILQ_INIT(&v->stack);
qapi/qapi-visit-core.c +1 -1
index 6295fa8..4a8ad43 100644
@@ -102,15 +102,15 @@ void visit_type_int(Visitor *v, int64_t *obj, const char *name, Error **errp)
 
 void visit_type_uint8(Visitor *v, uint8_t *obj, const char *name, Error **errp)
 {
-    int64_t value;
+    uint64_t value;
 
     if (v->type_uint8) {
         v->type_uint8(v, obj, name, errp);
     } else {

qapi/qapi-visit-core.c void visit_type_int(Visitor *v, int64_t *obj, const char *name, Error **errp) · line 116

Quoted 10 lines
qapi/qapi-visit-core.c +3 -3
         value = *obj;
-        v->type_int64(v, &value, name, errp);
-        if (value < 0 || value > UINT8_MAX) {
-            /* FIXME questionable reuse of errp if type_int64() changes
+        v->type_uint64(v, &value, name, errp);
+        if (value > UINT8_MAX) {
+            /* FIXME questionable reuse of errp if type_uint64() changes
                value on error */
             error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
                        name ? name : "null", "uint8_t");

You could delay adding these FIXMEs until this patch, and reduce churn. Probably not worth the bother now.

[...]

author
#34 lore raw

Re: [Qemu-devel] [PATCH v9 10/37] qapi: Make all visitors supply uint64 callbacks

Quoted 24 lines · Markus Armbruster
Quoted 10 lines · Eric Blake

Our qapi visitor contract supports multiple integer visitors, but left the type_uint64 visitor as optional (falling back on type_int64); it also marks the type_size visitor as optional (falling back on type_uint64 or even type_int64).

Note that the default of falling back on type_int for unsigned visitors can cause confusing results for values larger than INT64_MAX (such as having to pass in a negative 2s complement value on input, and getting a negative result on output).

Quoted 6 lines

This patch does not fully address the disparity in handling large values as negatives, but does move towards a cleaner situation where EVERY visitor provides both type_int64 and type_uint64 variants as entry points; then each client can either implement sane differences between the two, or document in place with a FIXME that there is munging going on.

Before: nobody implements type_uint64(), and the core falls back to type_int64(), casting negative values to large positive ones. With an implementation of type_int64() that parses large positive values as negative, the two casts cancel out.

Quoted 5 lines

After: everybody implements type_uint64() incorrectly, by reusing type_int64() code. The problem moves from visitor core to visitor implementations, where we can actually fix it if we care.

Correct?

Close. opts-visitor.c already implemented type_uint64, but also has its known bugs (and Paolo has been pinged about his claim for fixes in that file...)

But otherwise, yes, in this patch, we are not fixing insanity so much as localizing and better documenting it.

I've given some thought about converting the QObject 'int' type to track a sign bit, making it effectively a superset covering 3*2^63 values in the range [INT64_MIN, UINT64_MAX], and then enhancing the parser to track if a negative value was parsed and the formatter to output negative if the sign bit is set, and then make the 'int64' and 'uint64' parsers stick to stricter 2*64 subsets of that range. But I haven't actually written a patch along those lines yet.

Quoted 5 lines
Quoted 3 lines

The dealloc visitor no longer needs a type_size callback, since that now safely falls back to the type_uint64 callback.

Did it need the callback before this patch?

Not really. Should I split out the deletion of that callback as a separate patch?

Quoted 18 lines
Quoted 4 lines

Then, in qapi-visit-core.c, we can now use the guaranteed type_uint64 callback as the fallback for all smaller unsigned int visits.

The type_int64() callback works just fine for smaller unsigned ints, but I agree avoiding mixed signedness by using type_uint64() make sense once type_uint64() is mandatory.

Quoted 8 lines

+++ b/qapi/qapi-visit-core.c

qapi/qapi-visit-core.c +1 -1
@@ -102,15 +102,15 @@ void visit_type_int(Visitor *v, int64_t *obj, const char *name, Error **errp)
 
 void visit_type_uint8(Visitor *v, uint8_t *obj, const char *name, Error **errp)
 {
-    int64_t value;
+    uint64_t value;
 
Quoted 16 lines

qapi/qapi-visit-core.c void visit_type_int(Visitor *v, int64_t *obj, const char *name, Error **errp) · line 116

Quoted 13 lines
qapi/qapi-visit-core.c +3 -3
     if (v->type_uint8) {
         v->type_uint8(v, obj, name, errp);
     } else {
         value = *obj;
-        v->type_int64(v, &value, name, errp);
-        if (value < 0 || value > UINT8_MAX) {
-            /* FIXME questionable reuse of errp if type_int64() changes
+        v->type_uint64(v, &value, name, errp);
+        if (value > UINT8_MAX) {
+            /* FIXME questionable reuse of errp if type_uint64() changes
                value on error */
             error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
                        name ? name : "null", "uint8_t");

You could delay adding these FIXMEs until this patch, and reduce churn. Probably not worth the bother now.

Yeah, I'll see how the rest of the series review goes.

Signature · 2 lines
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org
#35 lore raw

Re: [Qemu-devel] [PATCH v9 10/37] qapi: Make all visitors supply uint64 callbacks

Quoted 29 lines · Eric Blake
Quoted 28 lines · Markus Armbruster
Quoted 10 lines · Eric Blake

Our qapi visitor contract supports multiple integer visitors, but left the type_uint64 visitor as optional (falling back on type_int64); it also marks the type_size visitor as optional (falling back on type_uint64 or even type_int64).

Note that the default of falling back on type_int for unsigned visitors can cause confusing results for values larger than INT64_MAX (such as having to pass in a negative 2s complement value on input, and getting a negative result on output).

Quoted 6 lines

This patch does not fully address the disparity in handling large values as negatives, but does move towards a cleaner situation where EVERY visitor provides both type_int64 and type_uint64 variants as entry points; then each client can either implement sane differences between the two, or document in place with a FIXME that there is munging going on.

Before: nobody implements type_uint64(), and the core falls back to type_int64(), casting negative values to large positive ones. With an implementation of type_int64() that parses large positive values as negative, the two casts cancel out.

After: everybody implements type_uint64() incorrectly, by reusing type_int64() code. The problem moves from visitor core to visitor implementations, where we can actually fix it if we care.

Quoted 5 lines
Quoted 1 line

Correct?

Close. opts-visitor.c already implemented type_uint64, but also has its known bugs (and Paolo has been pinged about his claim for fixes in that file...)

Ah, yes. opts_type_uint64() doesn't reuse opts_type_int64(), but largely duplicates it. Potentially less wrong :)

Quoted 2 lines

But otherwise, yes, in this patch, we are not fixing insanity so much as localizing and better documenting it.

Let me try to clarify the commit message a bit:

This patch does not address the disparity in handling large values as negatives. It merely moves the fallback from uint64 to int64 from the visitor core to the visitors, where the issue can actually be fixed, by implementing the missing type_uint64() callbacks on top of the respective type_int64() callbacks, with a FIXME comment explaining why that's wrong.

Quoted 7 lines

I've given some thought about converting the QObject 'int' type to track a sign bit, making it effectively a superset covering 3*2^63 values in the range [INT64_MIN, UINT64_MAX], and then enhancing the parser to track if a negative value was parsed and the formatter to output negative if the sign bit is set, and then make the 'int64' and 'uint64' parsers stick to stricter 2*64 subsets of that range. But I haven't actually written a patch along those lines yet.

Yes, we'll want to get that right eventually, but it's not urgent.

Quoted 7 lines
Quoted 4 lines
Quoted 2 lines

The dealloc visitor no longer needs a type_size callback, since that now safely falls back to the type_uint64 callback.

Did it need the callback before this patch?

Not really. Should I split out the deletion of that callback as a separate patch?

Probably cleanest, but merely adjusting the commit message would also work for me:

The dealloc visitor doesn't actually need a type_size() callback, since the visitor core can safely fall back to the type_uint64() callback. Drop it.

Quoted 34 lines
Quoted 17 lines
Quoted 3 lines

Then, in qapi-visit-core.c, we can now use the guaranteed type_uint64 callback as the fallback for all smaller unsigned int visits.

The type_int64() callback works just fine for smaller unsigned ints, but I agree avoiding mixed signedness by using type_uint64() make sense once type_uint64() is mandatory.

Quoted 8 lines

+++ b/qapi/qapi-visit-core.c

qapi/qapi-visit-core.c +1 -1
@@ -102,15 +102,15 @@ void visit_type_int(Visitor *v, int64_t *obj, const char *name, Error **errp)
 
 void visit_type_uint8(Visitor *v, uint8_t *obj, const char *name, Error **errp)
 {
-    int64_t value;
+    uint64_t value;
 
Quoted 16 lines

qapi/qapi-visit-core.c void visit_type_int(Visitor *v, int64_t *obj, const char *name, Error **errp) · line 116

Quoted 13 lines
qapi/qapi-visit-core.c +3 -3
     if (v->type_uint8) {
         v->type_uint8(v, obj, name, errp);
     } else {
         value = *obj;
-        v->type_int64(v, &value, name, errp);
-        if (value < 0 || value > UINT8_MAX) {
-            /* FIXME questionable reuse of errp if type_int64() changes
+        v->type_uint64(v, &value, name, errp);
+        if (value > UINT8_MAX) {
+            /* FIXME questionable reuse of errp if type_uint64() changes
                value on error */
             error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
                        name ? name : "null", "uint8_t");

You could delay adding these FIXMEs until this patch, and reduce churn. Probably not worth the bother now.

Quoted 1 line

Yeah, I'll see how the rest of the series review goes.

Hope to make some more progress today.

author
#36 lore raw

Re: [Qemu-devel] [PATCH v9 10/37] qapi: Make all visitors supply uint64 callbacks

Quoted 21 lines · Markus Armbruster
Quoted 9 lines
Quoted 9 lines

Before: nobody implements type_uint64(), and the core falls back to type_int64(), casting negative values to large positive ones. With an implementation of type_int64() that parses large positive values as negative, the two casts cancel out.

After: everybody implements type_uint64() incorrectly, by reusing type_int64() code. The problem moves from visitor core to visitor implementations, where we can actually fix it if we care.

Quoted 5 lines
Quoted 1 line

Correct?

Close. opts-visitor.c already implemented type_uint64, but also has its known bugs (and Paolo has been pinged about his claim for fixes in that file...)

Ah, yes. opts_type_uint64() doesn't reuse opts_type_int64(), but largely duplicates it. Potentially less wrong :)

Quoted 2 lines

But otherwise, yes, in this patch, we are not fixing insanity so much as localizing and better documenting it.

Quoted 8 lines

Let me try to clarify the commit message a bit:

This patch does not address the disparity in handling large values as negatives. It merely moves the fallback from uint64 to int64 from the visitor core to the visitors, where the issue can actually be fixed, by implementing the missing type_uint64() callbacks on top of the respective type_int64() callbacks, with a FIXME comment explaining why that's wrong.

Looks good. I think we're starting to rack up enough tweaks to make it worth me posting a v10 respin to fold them all in.

Quoted 8 lines
Quoted 7 lines
Quoted 4 lines
Quoted 2 lines

The dealloc visitor no longer needs a type_size callback, since that now safely falls back to the type_uint64 callback.

Did it need the callback before this patch?

Not really. Should I split out the deletion of that callback as a separate patch?

Quoted 6 lines

Probably cleanest, but merely adjusting the commit message would also work for me:

The dealloc visitor doesn't actually need a type_size() callback, since the visitor core can safely fall back to the type_uint64() callback. Drop it.

Okay, I won't bother to split this one; the commit message tweak seems sufficient.

Signature · 2 lines
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org
author
#37 lore raw

PATCH v9 11/37 qapi: Consolidate visitor small integer callbacks

In reply to Eric Blake

Commit 4e27e819 introduced optional visitor callbacks for all sorts of int types, but no visitor has supplied any of the callbacks for sizes less than 64 bits. In other words, the generic implementation based on using type_[u]int64() followed by bounds-checking works just fine. In the interest of simplicity, it's easier to make the visitor callback interface not have to worry about the other sizes.

Adding some helper functions minimizes the boilerplate required to correct FIXMEs added earlier with regards to questionable reuse of errp, particularly now that we can guarantee from a single file audit that value is unchanged if an error is set.

---
v9: hoist some of visitor-impl.h changes into 9/35 and 10/35
v8: no change
v7: further factor out helper functions that eliminate the questionable errp reuse
v6: split off from v5 23/46
original version also appeared in v6-v9 of subset D

---
 include/qapi/visitor-impl.h |   8 +--
 qapi/qapi-visit-core.c      | 158 +++++++++++++++++---------------------------
 2 files changed, 60 insertions(+), 106 deletions(-)
include/qapi/visitor-impl.h +1 -7
index 45c1d3e..e6399d1 100644
@@ -1,7 +1,7 @@
 /*
  * Core Definitions for QAPI Visitor implementations
  *
- * Copyright (C) 2012 Red Hat, Inc.
+ * Copyright (C) 2012, 2015-2016 Red Hat, Inc.
  *
  * Author: Paolo Bonizni <[email protected]>
  *
@@ -56,12 +56,6 @@ struct Visitor
     /* May be NULL; most useful for input visitors. */
     void (*optional)(Visitor *v, bool *present, const char *name);
 
-    void (*type_uint8)(Visitor *v, uint8_t *obj, const char *name, Error **errp);
-    void (*type_uint16)(Visitor *v, uint16_t *obj, const char *name, Error **errp);
-    void (*type_uint32)(Visitor *v, uint32_t *obj, const char *name, Error **errp);
-    void (*type_int8)(Visitor *v, int8_t *obj, const char *name, Error **errp);
-    void (*type_int16)(Visitor *v, int16_t *obj, const char *name, Error **errp);
-    void (*type_int32)(Visitor *v, int32_t *obj, const char *name, Error **errp);
     bool (*start_union)(Visitor *v, bool data_present, Error **errp);
     void (*end_union)(Visitor *v, bool data_present, Error **errp);
 };
qapi/qapi-visit-core.c +59 -99

188 lines not on this page · raw message

Signature · 1 line
2.5.0
#38 lore raw

Re: [Qemu-devel] [PATCH v9 11/37] qapi: Consolidate visitor small integer callbacks

Quoted 23 lines · Eric Blake

Commit 4e27e819 introduced optional visitor callbacks for all sorts of int types, but no visitor has supplied any of the callbacks for sizes less than 64 bits. In other words, the generic implementation based on using type_[u]int64() followed by bounds-checking works just fine. In the interest of simplicity, it's easier to make the visitor callback interface not have to worry about the other sizes.

Adding some helper functions minimizes the boilerplate required to correct FIXMEs added earlier with regards to questionable reuse of errp, particularly now that we can guarantee from a single file audit that value is unchanged if an error is set.

---
v9: hoist some of visitor-impl.h changes into 9/35 and 10/35
v8: no change
v7: further factor out helper functions that eliminate the questionable errp reuse
v6: split off from v5 23/46
original version also appeared in v6-v9 of subset D

Quoted 4 lines
---
 include/qapi/visitor-impl.h |   8 +--
 qapi/qapi-visit-core.c      | 158 +++++++++++++++++---------------------------
 2 files changed, 60 insertions(+), 106 deletions(-)

Nice diffstat.

include/qapi/visitor-impl.h line 4

Quoted 11 lines
include/qapi/visitor-impl.h +1 -1
index 45c1d3e..e6399d1 100644
@@ -1,7 +1,7 @@
 /*
  * Core Definitions for QAPI Visitor implementations
  *
- * Copyright (C) 2012 Red Hat, Inc.
+ * Copyright (C) 2012, 2015-2016 Red Hat, Inc.

git-log has authors @redhat.com in 2013 and 2014 as well.

Quoted 26 lines
include/qapi/visitor-impl.h +0 -6
  *
  * Author: Paolo Bonizni <[email protected]>
  *
@@ -56,12 +56,6 @@ struct Visitor
     /* May be NULL; most useful for input visitors. */
     void (*optional)(Visitor *v, bool *present, const char *name);
 
-    void (*type_uint8)(Visitor *v, uint8_t *obj, const char *name, Error **errp);
-    void (*type_uint16)(Visitor *v, uint16_t *obj, const char *name, Error **errp);
-    void (*type_uint32)(Visitor *v, uint32_t *obj, const char *name, Error **errp);
-    void (*type_int8)(Visitor *v, int8_t *obj, const char *name, Error **errp);
-    void (*type_int16)(Visitor *v, int16_t *obj, const char *name, Error **errp);
-    void (*type_int32)(Visitor *v, int32_t *obj, const char *name, Error **errp);
     bool (*start_union)(Visitor *v, bool data_present, Error **errp);
     void (*end_union)(Visitor *v, bool data_present, Error **errp);
 };
qapi/qapi-visit-core.c +2 -0
index 4a8ad43..a48fd4e 100644
@@ -100,129 +100,89 @@ void visit_type_int(Visitor *v, int64_t *obj, const char *name, Error **errp)
     v->type_int64(v, obj, name, errp);
 }
 
+static void visit_type_uintN(Visitor *v, uint64_t *obj, const char *name,
+                             uint64_t max, const char *type, Error **errp)

qapi/qapi-visit-core.c void visit_type_int(Visitor *v, int64_t *obj, const char *name, Error **errp) · line 114

Quoted 10 lines
qapi/qapi-visit-core.c +10 -0
+{
+    Error *err = NULL;
+    uint64_t value = *obj;
+
+    v->type_uint64(v, &value, name, &err);
+    if (err) {
+        error_propagate(errp, err);
+    } else if (value > max) {
+        error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
+                   name ? name : "null", type);

We should clean up this name ? name : "null" nonsense some day.

Quoted 4 lines
qapi/qapi-visit-core.c +4 -0
+    } else {
+        *obj = value;
+    }
+}

[...]

author
#39 lore raw

Re: [Qemu-devel] [PATCH v9 11/37] qapi: Consolidate visitor small integer callbacks

Quoted 33 lines · Markus Armbruster
Quoted 23 lines · Eric Blake

Commit 4e27e819 introduced optional visitor callbacks for all sorts of int types, but no visitor has supplied any of the callbacks for sizes less than 64 bits. In other words, the generic implementation based on using type_[u]int64() followed by bounds-checking works just fine. In the interest of simplicity, it's easier to make the visitor callback interface not have to worry about the other sizes.

Adding some helper functions minimizes the boilerplate required to correct FIXMEs added earlier with regards to questionable reuse of errp, particularly now that we can guarantee from a single file audit that value is unchanged if an error is set.

---
v9: hoist some of visitor-impl.h changes into 9/35 and 10/35
v8: no change
v7: further factor out helper functions that eliminate the questionable errp reuse
v6: split off from v5 23/46
original version also appeared in v6-v9 of subset D

Quoted 4 lines
---
 include/qapi/visitor-impl.h |   8 +--
 qapi/qapi-visit-core.c      | 158 +++++++++++++++++---------------------------
 2 files changed, 60 insertions(+), 106 deletions(-)

Nice diffstat.

Quoted 1 line
Quoted 12 lines

include/qapi/visitor-impl.h line 4

Quoted 10 lines
include/qapi/visitor-impl.h +1 -1
index 45c1d3e..e6399d1 100644
@@ -1,7 +1,7 @@
 /*
  * Core Definitions for QAPI Visitor implementations
  *
- * Copyright (C) 2012 Red Hat, Inc.
+ * Copyright (C) 2012, 2015-2016 Red Hat, Inc.

git-log has authors @redhat.com in 2013 and 2014 as well.

I didn't bother to check whether those edits were complex enough to warrant claiming copyright additions; but I'm also amenable to shortening to '2012-2016' on a respin regardless of the sizes of those edits. As it is, I was not very careful about adding 2016 in the v9 spin, so I may be inconsistent on which years are claimed where, in comparison to where I felt I was adding new copyrightable content rather than just minor fixing of existing content.

[While it's nice that we DON'T have to assign copyright to a central organization to contribute to qemu, sometimes it is much nicer working on FSF code where a single copyright holder makes discussions like this moot.]

Quoted 5 lines

include/qapi/visitor-impl.h line 7

Quoted 3 lines
include/qapi/visitor-impl.h +3 -0
+    } else if (value > max) {
+        error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
+                   name ? name : "null", type);

We should clean up this name ? name : "null" nonsense some day.

It all stems from whether the visitor is locally visiting { 'name':value } vs. [ value ]; in an array visit, there is no direct name.

Maybe we could go a step higher; if we have:

{ 'name': [ value ] }

then we could require callers to parse value by passing in "[name]" or "name[0]" rather than NULL. Then audit the code to always pass in a sensible name at the top level of a parse. It would even extend to 2-D arrays, via "[[name]]" or "name[0][0]". But not in this series.

Signature · 2 lines
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org
#40 lore raw

Re: [Qemu-devel] [PATCH v9 11/37] qapi: Consolidate visitor small integer callbacks

Quoted 48 lines · Eric Blake
Quoted 34 lines · Markus Armbruster
Quoted 23 lines · Eric Blake

Commit 4e27e819 introduced optional visitor callbacks for all sorts of int types, but no visitor has supplied any of the callbacks for sizes less than 64 bits. In other words, the generic implementation based on using type_[u]int64() followed by bounds-checking works just fine. In the interest of simplicity, it's easier to make the visitor callback interface not have to worry about the other sizes.

Adding some helper functions minimizes the boilerplate required to correct FIXMEs added earlier with regards to questionable reuse of errp, particularly now that we can guarantee from a single file audit that value is unchanged if an error is set.

---
v9: hoist some of visitor-impl.h changes into 9/35 and 10/35
v8: no change
v7: further factor out helper functions that eliminate the questionable errp reuse
v6: split off from v5 23/46
original version also appeared in v6-v9 of subset D

Quoted 5 lines
---
 include/qapi/visitor-impl.h |   8 +--
 qapi/qapi-visit-core.c | 158
+++++++++++++++++---------------------------
 2 files changed, 60 insertions(+), 106 deletions(-)

Nice diffstat.

Quoted 1 line
Quoted 12 lines

include/qapi/visitor-impl.h line 4

Quoted 10 lines
include/qapi/visitor-impl.h +1 -1
index 45c1d3e..e6399d1 100644
@@ -1,7 +1,7 @@
 /*
  * Core Definitions for QAPI Visitor implementations
  *
- * Copyright (C) 2012 Red Hat, Inc.
+ * Copyright (C) 2012, 2015-2016 Red Hat, Inc.

git-log has authors @redhat.com in 2013 and 2014 as well.

Quoted 7 lines

I didn't bother to check whether those edits were complex enough to warrant claiming copyright additions; but I'm also amenable to shortening to '2012-2016' on a respin regardless of the sizes of those edits. As it is, I was not very careful about adding 2016 in the v9 spin, so I may be inconsistent on which years are claimed where, in comparison to where I felt I was adding new copyrightable content rather than just minor fixing of existing content.

IANAL, but I feel claiming 2012-2016 when some of the years in the middle saw only changes of debatable copyrightability is a pardonable sin.

Quoted 14 lines

[While it's nice that we DON'T have to assign copyright to a central organization to contribute to qemu, sometimes it is much nicer working on FSF code where a single copyright holder makes discussions like this moot.]

Quoted 5 lines

include/qapi/visitor-impl.h line 7

Quoted 3 lines
include/qapi/visitor-impl.h +3 -0
+    } else if (value > max) {
+        error_setg(errp, QERR_INVALID_PARAMETER_VALUE,
+                   name ? name : "null", type);

We should clean up this name ? name : "null" nonsense some day.

It all stems from whether the visitor is locally visiting { 'name':value } vs. [ value ]; in an array visit, there is no direct name.

Quoted 8 lines

Maybe we could go a step higher; if we have:

{ 'name': [ value ] }

then we could require callers to parse value by passing in "[name]" or "name[0]" rather than NULL. Then audit the code to always pass in a sensible name at the top level of a parse. It would even extend to 2-D arrays, via "[[name]]" or "name[0][0]". But not in this series.

"Parameter 'null' expects int32_t" is not an acceptable error message. It's better than crashing, but that's about it.

'null' is actively misleading. The thing we choked on isn't named 'null'. Even calling it a parameter is questionable.

A fix needs to identify the thing we choked on in a way that let's the user find it. '[[name]]' doesn't cut it, I'm afraid.

'expects int32_t' is below par, too. Sure, a programmer will understand it fine, but we need to explain things to the user in the user's term, not in C programming jargon.

author
#41 lore raw

PATCH v9 12/37 qapi: Don't cast Enum* to int*

In reply to Eric Blake

C compilers are allowed to represent enums as a smaller type than int, if all enum values fit in the smaller type. There are even compiler flags that force the use of this smaller representation, and using them changes the ABI of a binary. Therefore, our generated code for visit_type_ENUM() (for all qapi enums) was wrong for casting Enum* to int* when calling visit_type_enum().

It appears that no one has been doing this for qemu, because if they had, we are potentially dereferencing beyond bounds or even risking a SIGBUS on platforms where unaligned pointer dereferencing is fatal. Better is to avoid the practice entirely, and just use the correct types.

This matches the fix for alternate qapi types, done earlier in commit 0426d53 "qapi: Simplify visiting of alternate types", with generated code changing as:

| void visit_type_GuestDiskBusType(Visitor *v, GuestDiskBusType *obj, const char *name, Error **errp)
| {
|-    visit_type_enum(v, (int *)obj, GuestDiskBusType_lookup, "GuestDiskBusType", name, errp);
|+    int tmp = *obj;
|+    visit_type_enum(v, &tmp, GuestDiskBusType_lookup, "GuestDiskBusType", name, errp);
|+    *obj = tmp;
| }

---
v9: mention earlier commit id, enhance commit message
v8: no change
v7: rebase on typo fix
v6: new patch

---
 scripts/qapi-visit.py | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
scripts/qapi-visit.py +3 -2
index 4a4f67d..6bd188b 100644
@@ -178,12 +178,13 @@ out:
 
 
 def gen_visit_enum(name):
-    # FIXME cast from enum *obj to int * invalidly assumes enum is int
     return mcgen('''
 
 void visit_type_%(c_name)s(Visitor *v, %(c_name)s *obj, const char *name, Error **errp)
 {
-    visit_type_enum(v, (int *)obj, %(c_name)s_lookup, "%(name)s", name, errp);
+    int tmp = *obj;
+    visit_type_enum(v, &tmp, %(c_name)s_lookup, "%(name)s", name, errp);
+    *obj = tmp;
 }
 ''',
                  c_name=c_name(name), name=name)
Signature · 1 line
2.5.0
#42 lore raw

Re: [Qemu-devel] [PATCH v9 12/37] qapi: Don't cast Enum* to int*

Quoted 4 lines · Eric Blake

C compilers are allowed to represent enums as a smaller type than int, if all enum values fit in the smaller type. There are even compiler flags that force the use of this smaller representation, and using them changes the ABI of a binary.

Suggest "although using them".

Quoted 14 lines

Therefore, our generated code for visit_type_ENUM() (for all qapi enums) was wrong for casting Enum* to int* when calling visit_type_enum().

It appears that no one has been doing this for qemu, because if they had, we are potentially dereferencing beyond bounds or even risking a SIGBUS on platforms where unaligned pointer dereferencing is fatal. Better is to avoid the practice entirely, and just use the correct types.

This matches the fix for alternate qapi types, done earlier in commit 0426d53 "qapi: Simplify visiting of alternate types", with generated code changing as:

Quoted 7 lines
| void visit_type_GuestDiskBusType(Visitor *v, GuestDiskBusType *obj, const char *name, Error **errp)
| {
|-    visit_type_enum(v, (int *)obj, GuestDiskBusType_lookup, "GuestDiskBusType", name, errp);
|+    int tmp = *obj;
|+    visit_type_enum(v, &tmp, GuestDiskBusType_lookup, "GuestDiskBusType", name, errp);
|+    *obj = tmp;
| }

Long lines. Do we have an example with a shorter enum name handy?

Quoted 22 lines

---
v9: mention earlier commit id, enhance commit message
v8: no change
v7: rebase on typo fix
v6: new patch

---
 scripts/qapi-visit.py | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
scripts/qapi-visit.py +0 -1
index 4a4f67d..6bd188b 100644
@@ -178,12 +178,13 @@ out:
 
 
 def gen_visit_enum(name):
-    # FIXME cast from enum *obj to int * invalidly assumes enum is int
     return mcgen('''

scripts/qapi-visit.py out: · line 190

Quoted 10 lines
scripts/qapi-visit.py +3 -1
 
 void visit_type_%(c_name)s(Visitor *v, %(c_name)s *obj, const char *name, Error **errp)
 {
-    visit_type_enum(v, (int *)obj, %(c_name)s_lookup, "%(name)s", name, errp);
+    int tmp = *obj;
+    visit_type_enum(v, &tmp, %(c_name)s_lookup, "%(name)s", name, errp);
+    *obj = tmp;
 }
 ''',
                  c_name=c_name(name), name=name)

Same pattern in qapi-visit-core.c, except we name the variable @value there. Your choice.

author
#43 lore raw

Re: [Qemu-devel] [PATCH v9 12/37] qapi: Don't cast Enum* to int*

Quoted 9 lines · Markus Armbruster
Quoted 4 lines · Eric Blake

C compilers are allowed to represent enums as a smaller type than int, if all enum values fit in the smaller type. There are even compiler flags that force the use of this smaller representation, and using them changes the ABI of a binary.

Suggest "although using them".

Okay.

Quoted 11 lines
Quoted 9 lines

with generated code changing as:

| void visit_type_GuestDiskBusType(Visitor *v, GuestDiskBusType *obj, const char *name, Error **errp)
| {
|-    visit_type_enum(v, (int *)obj, GuestDiskBusType_lookup, "GuestDiskBusType", name, errp);
|+    int tmp = *obj;
|+    visit_type_enum(v, &tmp, GuestDiskBusType_lookup, "GuestDiskBusType", name, errp);
|+    *obj = tmp;
| }

Long lines. Do we have an example with a shorter enum name handy?

Shortest is QType; runner-ups RxState and TpmType.

Quoted 10 lines

scripts/qapi-visit.py out: · line 190

Quoted 9 lines

void visit_type_%(c_name)s(Visitor *v, %(c_name)s *obj, const char *name, Error **errp) {

scripts/qapi-visit.py +3 -1
-    visit_type_enum(v, (int *)obj, %(c_name)s_lookup, "%(name)s", name, errp);
+    int tmp = *obj;
+    visit_type_enum(v, &tmp, %(c_name)s_lookup, "%(name)s", name, errp);
+    *obj = tmp;
 }
 ''',
                  c_name=c_name(name), name=name)
Quoted 2 lines

Same pattern in qapi-visit-core.c, except we name the variable @value there. Your choice.

'value' sounds consistent. An easy swap on a respin.

Signature · 2 lines
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org
#44 lore raw

Re: [Qemu-devel] [PATCH v9 12/37] qapi: Don't cast Enum* to int*

Quoted 25 lines · Eric Blake
Quoted 9 lines · Markus Armbruster
Quoted 4 lines · Eric Blake

C compilers are allowed to represent enums as a smaller type than int, if all enum values fit in the smaller type. There are even compiler flags that force the use of this smaller representation, and using them changes the ABI of a binary.

Suggest "although using them".

Okay.

Quoted 11 lines
Quoted 10 lines

with generated code changing as:

| void visit_type_GuestDiskBusType(Visitor *v, GuestDiskBusType
| *obj, const char *name, Error **errp)
| {
|-    visit_type_enum(v, (int *)obj, GuestDiskBusType_lookup, "GuestDiskBusType", name, errp);
|+    int tmp = *obj;
|+    visit_type_enum(v, &tmp, GuestDiskBusType_lookup, "GuestDiskBusType", name, errp);
|+    *obj = tmp;
| }
Quoted 3 lines
Quoted 1 line

Long lines. Do we have an example with a shorter enum name handy?

Shortest is QType; runner-ups RxState and TpmType.

QType comes out okay:

| void visit_type_QType(Visitor *v, QType *obj, const char *name, Error **errp)
| {
|-    visit_type_enum(v, (int *)obj, QType_lookup, "QType", name, errp);
|+    int tmp = *obj;
|+     visit_type_enum(v, &tmp, QType_lookup, "QType", name, errp);
|+    *obj = tmp;
| }

Let's use it.

Quoted 10 lines
Quoted 10 lines
Quoted 9 lines

void visit_type_%(c_name)s(Visitor *v, %(c_name)s *obj, const char *name, Error **errp) {

scripts/qapi-visit.py +3 -1
-    visit_type_enum(v, (int *)obj, %(c_name)s_lookup, "%(name)s", name, errp);
+    int tmp = *obj;
+    visit_type_enum(v, &tmp, %(c_name)s_lookup, "%(name)s", name, errp);
+    *obj = tmp;
 }
 ''',
                  c_name=c_name(name), name=name)
Quoted 4 lines
Quoted 2 lines

Same pattern in qapi-visit-core.c, except we name the variable @value there. Your choice.

'value' sounds consistent. An easy swap on a respin.

Okay.

author
#45 lore raw

PATCH v9 13/37 qom: Use typedef for Visitor

In reply to Eric Blake

No need to repeat 'struct Visitor' when we already have it in typedefs.h. Omitting the redundant 'struct' also makes a later patch easier to search for all object property callbacks that are associated with a Visitor.

---
v9: no change
v8: new patch

---
 hw/misc/edu.c              | 4 ++--
 hw/virtio/virtio-balloon.c | 6 +++---
 include/qom/object.h       | 9 ++++-----
 qom/object.c               | 4 ++--
 target-i386/cpu.c          | 4 ++--
 5 files changed, 13 insertions(+), 14 deletions(-)
hw/misc/edu.c +2 -2
index 43d5b18..a7171eb 100644
@@ -362,8 +362,8 @@ static void pci_edu_uninit(PCIDevice *pdev)
     timer_del(&edu->dma_timer);
 }
 
-static void edu_obj_uint64(Object *obj, struct Visitor *v, void *opaque,
-                const char *name, Error **errp)
+static void edu_obj_uint64(Object *obj, Visitor *v, void *opaque,
+                           const char *name, Error **errp)
 {
     uint64_t *val = opaque;
 
hw/virtio/virtio-balloon.c +3 -3
index 1ce987a..9cc7cf9 100644
@@ -110,7 +110,7 @@ static void balloon_stats_poll_cb(void *opaque)
     virtio_notify(vdev, s->svq);
 }
 
-static void balloon_stats_get_all(Object *obj, struct Visitor *v,
+static void balloon_stats_get_all(Object *obj, Visitor *v,
                                   void *opaque, const char *name, Error **errp)
 {
     Error *err = NULL;
@@ -149,7 +149,7 @@ out:
     error_propagate(errp, err);
 }
 
-static void balloon_stats_get_poll_interval(Object *obj, struct Visitor *v,
+static void balloon_stats_get_poll_interval(Object *obj, Visitor *v,
                                             void *opaque, const char *name,
                                             Error **errp)
 {
@@ -157,7 +157,7 @@ static void balloon_stats_get_poll_interval(Object *obj, struct Visitor *v,
     visit_type_int(v, &s->stats_poll_interval, name, errp);
 }
 
-static void balloon_stats_set_poll_interval(Object *obj, struct Visitor *v,
+static void balloon_stats_set_poll_interval(Object *obj, Visitor *v,
                                             void *opaque, const char *name,
                                             Error **errp)
 {
include/qom/object.h +4 -5
index d0dafe9..3e7e99d 100644
@@ -18,10 +18,9 @@
 #include <stdint.h>
 #include <stdbool.h>
 #include "qemu/queue.h"
+#include "qemu/typedefs.h"
 #include "qapi/error.h"
 
-struct Visitor;
-
 struct TypeImpl;
 typedef struct TypeImpl *Type;
 
@@ -298,7 +297,7 @@ typedef struct InterfaceInfo InterfaceInfo;
  * Called when trying to get/set a property.
  */
 typedef void (ObjectPropertyAccessor)(Object *obj,
-                                      struct Visitor *v,
+                                      Visitor *v,
                                       void *opaque,
                                       const char *name,
                                       Error **errp);
@@ -1025,7 +1024,7 @@ void object_unparent(Object *obj);
  *
  * Reads a property from a object.
  */
-void object_property_get(Object *obj, struct Visitor *v, const char *name,
+void object_property_get(Object *obj, Visitor *v, const char *name,
                          Error **errp);
 
 /**
@@ -1161,7 +1160,7 @@ void object_property_get_uint16List(Object *obj, const char *name,
  *
  * Writes a property to a object.
  */
-void object_property_set(Object *obj, struct Visitor *v, const char *name,
+void object_property_set(Object *obj, Visitor *v, const char *name,
                          Error **errp);
 
 /**
qom/object.c +2 -2
index 5ff97ab..4d7d8c8 100644
@@ -2184,7 +2184,7 @@ typedef struct {
     char *target_name;
 } AliasProperty;
 
-static void property_get_alias(Object *obj, struct Visitor *v, void *opaque,
+static void property_get_alias(Object *obj, Visitor *v, void *opaque,
                                const char *name, Error **errp)
 {
     AliasProperty *prop = opaque;
@@ -2192,7 +2192,7 @@ static void property_get_alias(Object *obj, struct Visitor *v, void *opaque,
     object_property_get(prop->target_obj, v, prop->target_name, errp);
 }
 
-static void property_set_alias(Object *obj, struct Visitor *v, void *opaque,
+static void property_set_alias(Object *obj, Visitor *v, void *opaque,
                                const char *name, Error **errp)
 {
     AliasProperty *prop = opaque;
target-i386/cpu.c +2 -2
index 0d447b5..13c5b69 100644
@@ -2921,7 +2921,7 @@ typedef struct BitProperty {
 } BitProperty;
 
 static void x86_cpu_get_bit_prop(Object *obj,
-                                 struct Visitor *v,
+                                 Visitor *v,
                                  void *opaque,
                                  const char *name,
                                  Error **errp)
@@ -2932,7 +2932,7 @@ static void x86_cpu_get_bit_prop(Object *obj,
 }
 
 static void x86_cpu_set_bit_prop(Object *obj,
-                                 struct Visitor *v,
+                                 Visitor *v,
                                  void *opaque,
                                  const char *name,
                                  Error **errp)
Signature · 1 line
2.5.0
author
#46 lore raw

PATCH v9 14/37 qapi: Swap visit_* arguments for consistent 'name' placement

In reply to Eric Blake

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 reasons in favor of the swap: name is always an input parameter, while &value is sometimes an output parameter (depending on whether the caller is using an input visitor); and it is nicer to list input parameters first. Also, 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.

The next 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').
    // 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)
    )

---
v9: mention later docs cleanup in commit message, rebase to master
v8: new patch

---
 backends/hostmem.c                 |  8 ++--
 block/qapi.c                       |  2 +-
 blockdev.c                         |  4 +-
 bootdevice.c                       |  4 +-
 hmp.c                              |  8 ++--
 hw/acpi/core.c                     |  4 +-
 hw/acpi/ich9.c                     | 14 +++----
 hw/block/nvme.c                    |  4 +-
 hw/core/machine.c                  | 10 ++---
 hw/core/qdev-properties-system.c   | 12 +++---
 hw/core/qdev-properties.c          | 66 +++++++++++++++----------------
 hw/core/qdev.c                     |  2 +-
 hw/i386/pc.c                       | 14 +++----
 hw/ide/qdev.c                      |  4 +-
 hw/intc/xics.c                     |  8 ++--
 hw/isa/lpc_ich9.c                  |  2 +-
 hw/mem/pc-dimm.c                   |  2 +-
 hw/misc/edu.c                      |  2 +-
 hw/misc/tmp105.c                   |  4 +-
 hw/net/ne2000-isa.c                |  4 +-
 hw/pci-host/piix.c                 |  8 ++--
 hw/pci-host/q35.c                  | 10 ++---
 hw/ppc/spapr_drc.c                 | 12 +++---
 hw/usb/dev-storage.c               |  4 +-
 hw/virtio/virtio-balloon.c         | 12 +++---
 include/qapi/visitor.h             | 52 +++++++++++++++----------
 memory.c                           |  8 ++--
 net/dump.c                         |  4 +-
 net/filter-buffer.c                |  4 +-
 net/net.c                          |  4 +-
 numa.c                             |  6 +--
 qapi/qapi-visit-core.c             | 54 +++++++++++++------------
 qemu-img.c                         | 11 +++---
 qom/object.c                       | 49 ++++++++++++-----------
 replay/replay-input.c              |  4 +-
 scripts/qapi-commands.py           |  4 +-
 scripts/qapi-event.py              |  2 +-
 scripts/qapi-types.py              |  2 +-
 scripts/qapi-visit.py              | 28 ++++++-------
 scripts/qapi.py                    |  4 +-
 target-i386/cpu.c                  | 30 +++++++-------
 target-ppc/translate_init.c        |  4 +-
 tests/test-opts-visitor.c          |  6 +--
 tests/test-qdev-global-props.c     |  4 +-
 tests/test-qmp-commands.c          |  2 +-
 tests/test-qmp-input-strict.c      | 28 ++++++-------
 tests/test-qmp-input-visitor.c     | 80 +++++++++++++++++++-------------------
 tests/test-qmp-output-visitor.c    | 34 ++++++++--------
 tests/test-string-input-visitor.c  | 34 ++++++++--------
 tests/test-string-output-visitor.c | 16 ++++----
 tests/test-visitor-serialization.c | 54 ++++++++++++-------------
 util/qemu-sockets.c                |  4 +-
 vl.c                               |  4 +-
 53 files changed, 387 insertions(+), 373 deletions(-)
backends/hostmem.c +4 -4
index 1b4eb45..a9d30d8 100644
@@ -32,7 +32,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
@@ -48,7 +48,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;
     }
@@ -91,7 +91,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
@@ -102,7 +102,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
index 58d3975..4fe3ce2 100644
@@ -635,7 +635,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
index 1392fff..29f393c 100644
@@ -3816,8 +3816,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
index 3cdc0d7..d307cfc 100644
@@ -274,7 +274,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,
@@ -284,7 +284,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
index 6d67f9b..3beea3a 100644
@@ -1675,13 +1675,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;
     }
@@ -1949,8 +1949,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",
hw/acpi/core.c +2 -2
index 21e113d..ef1f037 100644
@@ -242,7 +242,7 @@ void acpi_table_add(const QemuOpts *opts, Error **errp)
         OptsVisitor *ov;
 
         ov = opts_visitor_new(opts);
-        visit_type_AcpiTableOptions(opts_get_visitor(ov), &hdrs, NULL, &err);
+        visit_type_AcpiTableOptions(opts_get_visitor(ov), NULL, &hdrs, &err);
         opts_visitor_cleanup(ov);
     }
 
@@ -301,7 +301,7 @@ out:
         QapiDeallocVisitor *dv;
 
         dv = qapi_dealloc_visitor_new();
-        visit_type_AcpiTableOptions(qapi_dealloc_get_visitor(dv), &hdrs, NULL,
+        visit_type_AcpiTableOptions(qapi_dealloc_get_visitor(dv), NULL, &hdrs,
                                     NULL);
         qapi_dealloc_visitor_cleanup(dv);
     }
hw/acpi/ich9.c +7 -7
index 1c7fcfa..0a486fb 100644
@@ -289,7 +289,7 @@ static void ich9_pm_get_gpe0_blk(Object *obj, Visitor *v,
     ICH9LPCPMRegs *pm = opaque;
     uint32_t value = pm->pm_io_base + ICH9_PMIO_GPE0_STS;
 
-    visit_type_uint32(v, &value, name, errp);
+    visit_type_uint32(v, name, &value, errp);
 }
 
 static bool ich9_pm_get_memory_hotplug_support(Object *obj, Error **errp)
@@ -314,7 +314,7 @@ static void ich9_pm_get_disable_s3(Object *obj, Visitor *v,
     ICH9LPCPMRegs *pm = opaque;
     uint8_t value = pm->disable_s3;
 
-    visit_type_uint8(v, &value, name, errp);
+    visit_type_uint8(v, name, &value, errp);
 }
 
 static void ich9_pm_set_disable_s3(Object *obj, Visitor *v,
@@ -325,7 +325,7 @@ static void ich9_pm_set_disable_s3(Object *obj, Visitor *v,
     Error *local_err = NULL;
     uint8_t value;
 
-    visit_type_uint8(v, &value, name, &local_err);
+    visit_type_uint8(v, name, &value, &local_err);
     if (local_err) {
         goto out;
     }
@@ -341,7 +341,7 @@ static void ich9_pm_get_disable_s4(Object *obj, Visitor *v,
     ICH9LPCPMRegs *pm = opaque;
     uint8_t value = pm->disable_s4;
 
-    visit_type_uint8(v, &value, name, errp);
+    visit_type_uint8(v, name, &value, errp);
 }
 
 static void ich9_pm_set_disable_s4(Object *obj, Visitor *v,
@@ -352,7 +352,7 @@ static void ich9_pm_set_disable_s4(Object *obj, Visitor *v,
     Error *local_err = NULL;
     uint8_t value;
 
-    visit_type_uint8(v, &value, name, &local_err);
+    visit_type_uint8(v, name, &value, &local_err);
     if (local_err) {
         goto out;
     }
@@ -368,7 +368,7 @@ static void ich9_pm_get_s4_val(Object *obj, Visitor *v,
     ICH9LPCPMRegs *pm = opaque;
     uint8_t value = pm->s4_val;
 
-    visit_type_uint8(v, &value, name, errp);
+    visit_type_uint8(v, name, &value, errp);
 }
 
 static void ich9_pm_set_s4_val(Object *obj, Visitor *v,
@@ -379,7 +379,7 @@ static void ich9_pm_set_s4_val(Object *obj, Visitor *v,
     Error *local_err = NULL;
     uint8_t value;
 
-    visit_type_uint8(v, &value, name, &local_err);
+    visit_type_uint8(v, name, &value, &local_err);
     if (local_err) {
         goto out;
     }
hw/block/nvme.c +2 -2
index 169e4fa..3676e2e 100644
@@ -920,7 +920,7 @@ static void nvme_get_bootindex(Object *obj, Visitor *v, void *opaque,
 {
     NvmeCtrl *s = NVME(obj);
 
-    visit_type_int32(v, &s->conf.bootindex, name, errp);
+    visit_type_int32(v, name, &s->conf.bootindex, errp);
 }
 
 static void nvme_set_bootindex(Object *obj, Visitor *v, void *opaque,
@@ -930,7 +930,7 @@ static void nvme_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;
     }
hw/core/machine.c +5 -5
index c46ddc7..0fd1e73 100644
@@ -40,7 +40,7 @@ static void machine_set_kernel_irqchip(Object *obj, Visitor *v,
     MachineState *ms = MACHINE(obj);
     OnOffSplit mode;
 
-    visit_type_OnOffSplit(v, &mode, name, &err);
+    visit_type_OnOffSplit(v, name, &mode, &err);
     if (err) {
         error_propagate(errp, err);
         return;
@@ -74,7 +74,7 @@ static void machine_get_kvm_shadow_mem(Object *obj, Visitor *v,
     MachineState *ms = MACHINE(obj);
     int64_t value = ms->kvm_shadow_mem;
 
-    visit_type_int(v, &value, name, errp);
+    visit_type_int(v, name, &value, errp);
 }
 
 static void machine_set_kvm_shadow_mem(Object *obj, Visitor *v,
@@ -85,7 +85,7 @@ static void machine_set_kvm_shadow_mem(Object *obj, Visitor *v,
     Error *error = NULL;
     int64_t value;
 
-    visit_type_int(v, &value, name, &error);
+    visit_type_int(v, name, &value, &error);
     if (error) {
         error_propagate(errp, error);
         return;
@@ -176,7 +176,7 @@ static void machine_get_phandle_start(Object *obj, Visitor *v,
     MachineState *ms = MACHINE(obj);
     int64_t value = ms->phandle_start;
 
-    visit_type_int(v, &value, name, errp);
+    visit_type_int(v, name, &value, errp);
 }
 
 static void machine_set_phandle_start(Object *obj, Visitor *v,
@@ -187,7 +187,7 @@ static void machine_set_phandle_start(Object *obj, Visitor *v,
     Error *error = NULL;
     int64_t value;
 
-    visit_type_int(v, &value, name, &error);
+    visit_type_int(v, name, &value, &error);
     if (error) {
         error_propagate(errp, error);
         return;
hw/core/qdev-properties-system.c +6 -6
index 1589aba..86e0b02 100644
@@ -30,7 +30,7 @@ static void get_pointer(Object *obj, Visitor *v, Property *prop,
     char *p;
 
     p = *ptr ? print(*ptr) : g_strdup("");
-    visit_type_str(v, &p, name, errp);
+    visit_type_str(v, name, &p, errp);
     g_free(p);
 }
 
@@ -50,7 +50,7 @@ static void set_pointer(Object *obj, Visitor *v, Property *prop,
         return;
     }
 
-    visit_type_str(v, &str, name, &local_err);
+    visit_type_str(v, name, &str, &local_err);
     if (local_err) {
         error_propagate(errp, local_err);
         return;
@@ -201,7 +201,7 @@ static void get_netdev(Object *obj, Visitor *v, void *opaque,
     NICPeers *peers_ptr = qdev_get_prop_ptr(dev, prop);
     char *p = g_strdup(peers_ptr->ncs[0] ? peers_ptr->ncs[0]->name : "");
 
-    visit_type_str(v, &p, name, errp);
+    visit_type_str(v, name, &p, errp);
     g_free(p);
 }
 
@@ -222,7 +222,7 @@ static void set_netdev(Object *obj, Visitor *v, void *opaque,
         return;
     }
 
-    visit_type_str(v, &str, name, &local_err);
+    visit_type_str(v, name, &str, &local_err);
     if (local_err) {
         error_propagate(errp, local_err);
         return;
@@ -307,7 +307,7 @@ static void get_vlan(Object *obj, Visitor *v, void *opaque,
         }
     }
 
-    visit_type_int32(v, &id, name, errp);
+    visit_type_int32(v, name, &id, errp);
 }
 
 static void set_vlan(Object *obj, Visitor *v, void *opaque,
@@ -326,7 +326,7 @@ static void set_vlan(Object *obj, Visitor *v, void *opaque,
         return;
     }
 
-    visit_type_int32(v, &id, name, &local_err);
+    visit_type_int32(v, name, &id, &local_err);
     if (local_err) {
         error_propagate(errp, local_err);
         return;
hw/core/qdev-properties.c +33 -33

244 lines not on this page · raw message

hw/core/qdev.c +1 -1
index 44bf790..b343a4d 100644
@@ -897,7 +897,7 @@ static void qdev_get_legacy_property(Object *obj, Visitor *v, void *opaque,
     char *ptr = buffer;
 
     prop->info->print(dev, prop, buffer, sizeof(buffer));
-    visit_type_str(v, &ptr, name, errp);
+    visit_type_str(v, name, &ptr, errp);
 }
 
 /**
hw/i386/pc.c +7 -7
index 9e37186..0ec39dc 100644
@@ -1760,7 +1760,7 @@ pc_machine_get_hotplug_memory_region_size(Object *obj, Visitor *v, void *opaque,
     PCMachineState *pcms = PC_MACHINE(obj);
     int64_t value = memory_region_size(&pcms->hotplug_memory.mr);
 
-    visit_type_int(v, &value, name, errp);
+    visit_type_int(v, name, &value, errp);
 }
 
 static void pc_machine_get_max_ram_below_4g(Object *obj, Visitor *v,
@@ -1770,7 +1770,7 @@ static void pc_machine_get_max_ram_below_4g(Object *obj, Visitor *v,
     PCMachineState *pcms = PC_MACHINE(obj);
     uint64_t value = pcms->max_ram_below_4g;
 
-    visit_type_size(v, &value, name, errp);
+    visit_type_size(v, name, &value, errp);
 }
 
 static void pc_machine_set_max_ram_below_4g(Object *obj, Visitor *v,
@@ -1781,7 +1781,7 @@ static void pc_machine_set_max_ram_below_4g(Object *obj, Visitor *v,
     Error *error = NULL;
     uint64_t value;
 
-    visit_type_size(v, &value, name, &error);
+    visit_type_size(v, name, &value, &error);
     if (error) {
         error_propagate(errp, error);
         return;
@@ -1809,7 +1809,7 @@ static void pc_machine_get_vmport(Object *obj, Visitor *v, void *opaque,
     PCMachineState *pcms = PC_MACHINE(obj);
     OnOffAuto vmport = pcms->vmport;
 
-    visit_type_OnOffAuto(v, &vmport, name, errp);
+    visit_type_OnOffAuto(v, name, &vmport, errp);
 }
 
 static void pc_machine_set_vmport(Object *obj, Visitor *v, void *opaque,
@@ -1817,7 +1817,7 @@ static void pc_machine_set_vmport(Object *obj, Visitor *v, void *opaque,
 {
     PCMachineState *pcms = PC_MACHINE(obj);
 
-    visit_type_OnOffAuto(v, &pcms->vmport, name, errp);
+    visit_type_OnOffAuto(v, name, &pcms->vmport, errp);
 }
 
 bool pc_machine_is_smm_enabled(PCMachineState *pcms)
@@ -1851,7 +1851,7 @@ static void pc_machine_get_smm(Object *obj, Visitor *v, void *opaque,
     PCMachineState *pcms = PC_MACHINE(obj);
     OnOffAuto smm = pcms->smm;
 
-    visit_type_OnOffAuto(v, &smm, name, errp);
+    visit_type_OnOffAuto(v, name, &smm, errp);
 }
 
 static void pc_machine_set_smm(Object *obj, Visitor *v, void *opaque,
@@ -1859,7 +1859,7 @@ static void pc_machine_set_smm(Object *obj, Visitor *v, void *opaque,
 {
     PCMachineState *pcms = PC_MACHINE(obj);
 
-    visit_type_OnOffAuto(v, &pcms->smm, name, errp);
+    visit_type_OnOffAuto(v, name, &pcms->smm, errp);
 }
 
 static bool pc_machine_get_nvdimm(Object *obj, Error **errp)
hw/ide/qdev.c +2 -2
index 1f83109..66f56e7 100644
@@ -204,7 +204,7 @@ static void ide_dev_get_bootindex(Object *obj, Visitor *v, void *opaque,
 {
     IDEDevice *d = IDE_DEVICE(obj);
 
-    visit_type_int32(v, &d->conf.bootindex, name, errp);
+    visit_type_int32(v, name, &d->conf.bootindex, errp);
 }
 
 static void ide_dev_set_bootindex(Object *obj, Visitor *v, void *opaque,
@@ -214,7 +214,7 @@ static void ide_dev_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;
     }
hw/intc/xics.c +4 -4
index 9ff5796..502c87f 100644
@@ -94,7 +94,7 @@ static void xics_prop_get_nr_irqs(Object *obj, Visitor *v,
     XICSState *icp = XICS_COMMON(obj);
     int64_t value = icp->nr_irqs;
 
-    visit_type_int(v, &value, name, errp);
+    visit_type_int(v, name, &value, errp);
 }
 
 static void xics_prop_set_nr_irqs(Object *obj, Visitor *v,
@@ -105,7 +105,7 @@ static void xics_prop_set_nr_irqs(Object *obj, Visitor *v,
     Error *error = NULL;
     int64_t value;
 
-    visit_type_int(v, &value, name, &error);
+    visit_type_int(v, name, &value, &error);
     if (error) {
         error_propagate(errp, error);
         return;
@@ -128,7 +128,7 @@ static void xics_prop_get_nr_servers(Object *obj, Visitor *v,
     XICSState *icp = XICS_COMMON(obj);
     int64_t value = icp->nr_servers;
 
-    visit_type_int(v, &value, name, errp);
+    visit_type_int(v, name, &value, errp);
 }
 
 static void xics_prop_set_nr_servers(Object *obj, Visitor *v,
@@ -140,7 +140,7 @@ static void xics_prop_set_nr_servers(Object *obj, Visitor *v,
     Error *error = NULL;
     int64_t value;
 
-    visit_type_int(v, &value, name, &error);
+    visit_type_int(v, name, &value, &error);
     if (error) {
         error_propagate(errp, error);
         return;
hw/isa/lpc_ich9.c +1 -1
index ed9907d..358f707 100644
@@ -576,7 +576,7 @@ static void ich9_lpc_get_sci_int(Object *obj, Visitor *v,
     ICH9LPCState *lpc = ICH9_LPC_DEVICE(obj);
     uint32_t value = ich9_lpc_sci_irq(lpc);
 
-    visit_type_uint32(v, &value, name, errp);
+    visit_type_uint32(v, name, &value, errp);
 }
 
 static void ich9_lpc_add_properties(ICH9LPCState *lpc)
hw/mem/pc-dimm.c +1 -1
index d5cdab2..123baeb 100644
@@ -382,7 +382,7 @@ static void pc_dimm_get_size(Object *obj, Visitor *v, void *opaque,
     mr = host_memory_backend_get_memory(dimm->hostmem, errp);
     value = memory_region_size(mr);
 
-    visit_type_int(v, &value, name, errp);
+    visit_type_int(v, name, &value, errp);
 }
 
 static void pc_dimm_check_memdev_is_busy(Object *obj, const char *name,
hw/misc/edu.c +1 -1
index a7171eb..4a3dc76 100644
@@ -367,7 +367,7 @@ static void edu_obj_uint64(Object *obj, Visitor *v, void *opaque,
 {
     uint64_t *val = opaque;
 
-    visit_type_uint64(v, val, name, errp);
+    visit_type_uint64(v, name, val, errp);
 }
 
 static void edu_instance_init(Object *obj)
hw/misc/tmp105.c +2 -2
index f3fe8b8..1850315 100644
@@ -58,7 +58,7 @@ static void tmp105_get_temperature(Object *obj, Visitor *v, void *opaque,
     TMP105State *s = TMP105(obj);
     int64_t value = s->temperature * 1000 / 256;
 
-    visit_type_int(v, &value, name, errp);
+    visit_type_int(v, name, &value, errp);
 }
 
 /* Units are 0.001 centigrades relative to 0 C.  s->temperature is 8.8
@@ -71,7 +71,7 @@ static void tmp105_set_temperature(Object *obj, Visitor *v, void *opaque,
     Error *local_err = NULL;
     int64_t temp;
 
-    visit_type_int(v, &temp, name, &local_err);
+    visit_type_int(v, name, &temp, &local_err);
     if (local_err) {
         error_propagate(errp, local_err);
         return;
hw/net/ne2000-isa.c +2 -2
index 18b0644..46ef304 100644
@@ -99,7 +99,7 @@ static void isa_ne2000_get_bootindex(Object *obj, Visitor *v, void *opaque,
     ISANE2000State *isa = ISA_NE2000(obj);
     NE2000State *s = &isa->ne2000;
 
-    visit_type_int32(v, &s->c.bootindex, name, errp);
+    visit_type_int32(v, name, &s->c.bootindex, errp);
 }
 
 static void isa_ne2000_set_bootindex(Object *obj, Visitor *v, void *opaque,
@@ -110,7 +110,7 @@ static void isa_ne2000_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;
     }
hw/pci-host/piix.c +4 -4
index b0d7e31..dbae0aa 100644
@@ -221,7 +221,7 @@ static void i440fx_pcihost_get_pci_hole_start(Object *obj, Visitor *v,
     I440FXState *s = I440FX_PCI_HOST_BRIDGE(obj);
     uint32_t value = s->pci_info.w32.begin;
 
-    visit_type_uint32(v, &value, name, errp);
+    visit_type_uint32(v, name, &value, errp);
 }
 
 static void i440fx_pcihost_get_pci_hole_end(Object *obj, Visitor *v,
@@ -231,7 +231,7 @@ static void i440fx_pcihost_get_pci_hole_end(Object *obj, Visitor *v,
     I440FXState *s = I440FX_PCI_HOST_BRIDGE(obj);
     uint32_t value = s->pci_info.w32.end;
 
-    visit_type_uint32(v, &value, name, errp);
+    visit_type_uint32(v, name, &value, errp);
 }
 
 static void i440fx_pcihost_get_pci_hole64_start(Object *obj, Visitor *v,
@@ -243,7 +243,7 @@ static void i440fx_pcihost_get_pci_hole64_start(Object *obj, Visitor *v,
 
     pci_bus_get_w64_range(h->bus, &w64);
 
-    visit_type_uint64(v, &w64.begin, name, errp);
+    visit_type_uint64(v, name, &w64.begin, errp);
 }
 
 static void i440fx_pcihost_get_pci_hole64_end(Object *obj, Visitor *v,
@@ -255,7 +255,7 @@ static void i440fx_pcihost_get_pci_hole64_end(Object *obj, Visitor *v,
 
     pci_bus_get_w64_range(h->bus, &w64);
 
-    visit_type_uint64(v, &w64.end, name, errp);
+    visit_type_uint64(v, name, &w64.end, errp);
 }
 
 static void i440fx_pcihost_initfn(Object *obj)
hw/pci-host/q35.c +5 -5
index 1fb4707..2b3608a 100644
@@ -73,7 +73,7 @@ static void q35_host_get_pci_hole_start(Object *obj, Visitor *v,
     Q35PCIHost *s = Q35_HOST_DEVICE(obj);
     uint32_t value = s->mch.pci_info.w32.begin;
 
-    visit_type_uint32(v, &value, name, errp);
+    visit_type_uint32(v, name, &value, errp);
 }
 
 static void q35_host_get_pci_hole_end(Object *obj, Visitor *v,
@@ -83,7 +83,7 @@ static void q35_host_get_pci_hole_end(Object *obj, Visitor *v,
     Q35PCIHost *s = Q35_HOST_DEVICE(obj);
     uint32_t value = s->mch.pci_info.w32.end;
 
-    visit_type_uint32(v, &value, name, errp);
+    visit_type_uint32(v, name, &value, errp);
 }
 
 static void q35_host_get_pci_hole64_start(Object *obj, Visitor *v,
@@ -95,7 +95,7 @@ static void q35_host_get_pci_hole64_start(Object *obj, Visitor *v,
 
     pci_bus_get_w64_range(h->bus, &w64);
 
-    visit_type_uint64(v, &w64.begin, name, errp);
+    visit_type_uint64(v, name, &w64.begin, errp);
 }
 
 static void q35_host_get_pci_hole64_end(Object *obj, Visitor *v,
@@ -107,7 +107,7 @@ static void q35_host_get_pci_hole64_end(Object *obj, Visitor *v,
 
     pci_bus_get_w64_range(h->bus, &w64);
 
-    visit_type_uint64(v, &w64.end, name, errp);
+    visit_type_uint64(v, name, &w64.end, errp);
 }
 
 static void q35_host_get_mmcfg_size(Object *obj, Visitor *v,
@@ -117,7 +117,7 @@ static void q35_host_get_mmcfg_size(Object *obj, Visitor *v,
     PCIExpressHost *e = PCIE_HOST_BRIDGE(obj);
     uint32_t value = e->size;
 
-    visit_type_uint32(v, &value, name, errp);
+    visit_type_uint32(v, name, &value, errp);
 }
 
 static Property mch_props[] = {
hw/ppc/spapr_drc.c +6 -6
index dccb908..9c8fbe8 100644
@@ -220,7 +220,7 @@ static void prop_get_index(Object *obj, Visitor *v, void *opaque,
     sPAPRDRConnector *drc = SPAPR_DR_CONNECTOR(obj);
     sPAPRDRConnectorClass *drck = SPAPR_DR_CONNECTOR_GET_CLASS(drc);
     uint32_t value = (uint32_t)drck->get_index(drc);
-    visit_type_uint32(v, &value, name, errp);
+    visit_type_uint32(v, name, &value, errp);
 }
 
 static void prop_get_type(Object *obj, Visitor *v, void *opaque,
@@ -229,7 +229,7 @@ static void prop_get_type(Object *obj, Visitor *v, void *opaque,
     sPAPRDRConnector *drc = SPAPR_DR_CONNECTOR(obj);
     sPAPRDRConnectorClass *drck = SPAPR_DR_CONNECTOR_GET_CLASS(drc);
     uint32_t value = (uint32_t)drck->get_type(drc);
-    visit_type_uint32(v, &value, name, errp);
+    visit_type_uint32(v, name, &value, errp);
 }
 
 static char *prop_get_name(Object *obj, Error **errp)
@@ -247,7 +247,7 @@ static void prop_get_entity_sense(Object *obj, Visitor *v, void *opaque,
     uint32_t value;
 
     drck->entity_sense(drc, &value);
-    visit_type_uint32(v, &value, name, errp);
+    visit_type_uint32(v, name, &value, errp);
 }
 
 static void prop_get_fdt(Object *obj, Visitor *v, void *opaque,
@@ -259,7 +259,7 @@ static void prop_get_fdt(Object *obj, Visitor *v, void *opaque,
     void *fdt;
 
     if (!drc->fdt) {
-        visit_start_struct(v, NULL, NULL, name, 0, &err);
+        visit_start_struct(v, name, NULL, NULL, 0, &err);
         if (!err) {
             visit_end_struct(v, &err);
         }
@@ -282,7 +282,7 @@ static void prop_get_fdt(Object *obj, Visitor *v, void *opaque,
         case FDT_BEGIN_NODE:
             fdt_depth++;
             name = fdt_get_name(fdt, fdt_offset, &name_len);
-            visit_start_struct(v, NULL, NULL, name, 0, &err);
+            visit_start_struct(v, name, NULL, NULL, 0, &err);
             if (err) {
                 error_propagate(errp, err);
                 return;
@@ -308,7 +308,7 @@ static void prop_get_fdt(Object *obj, Visitor *v, void *opaque,
                 return;
             }
             for (i = 0; i < prop_len; i++) {
-                visit_type_uint8(v, (uint8_t *)&prop->data[i], NULL, &err);
+                visit_type_uint8(v, NULL, (uint8_t *)&prop->data[i], &err);
                 if (err) {
                     error_propagate(errp, err);
                     return;
hw/usb/dev-storage.c +2 -2
index 597d8fd..3261446 100644
@@ -786,7 +786,7 @@ static void usb_msd_get_bootindex(Object *obj, Visitor *v, void *opaque,
     USBDevice *dev = USB_DEVICE(obj);
     MSDState *s = USB_STORAGE_DEV(dev);
 
-    visit_type_int32(v, &s->conf.bootindex, name, errp);
+    visit_type_int32(v, name, &s->conf.bootindex, errp);
 }
 
 static void usb_msd_set_bootindex(Object *obj, Visitor *v, void *opaque,
@@ -797,7 +797,7 @@ static void usb_msd_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;
     }
hw/virtio/virtio-balloon.c +6 -6
index 9cc7cf9..1d81a34 100644
@@ -117,21 +117,21 @@ static void balloon_stats_get_all(Object *obj, Visitor *v,
     VirtIOBalloon *s = opaque;
     int i;
 
-    visit_start_struct(v, NULL, "guest-stats", name, 0, &err);
+    visit_start_struct(v, name, NULL, "guest-stats", 0, &err);
     if (err) {
         goto out;
     }
-    visit_type_int(v, &s->stats_last_update, "last-update", &err);
+    visit_type_int(v, "last-update", &s->stats_last_update, &err);
     if (err) {
         goto out_end;
     }
 
-    visit_start_struct(v, NULL, NULL, "stats", 0, &err);
+    visit_start_struct(v, "stats", NULL, NULL, 0, &err);
     if (err) {
         goto out_end;
     }
     for (i = 0; i < VIRTIO_BALLOON_S_NR; i++) {
-        visit_type_uint64(v, &s->stats[i], balloon_stat_names[i], &err);
+        visit_type_uint64(v, balloon_stat_names[i], &s->stats[i], &err);
         if (err) {
             goto out_nested;
         }
@@ -154,7 +154,7 @@ static void balloon_stats_get_poll_interval(Object *obj, Visitor *v,
                                             Error **errp)
 {
     VirtIOBalloon *s = opaque;
-    visit_type_int(v, &s->stats_poll_interval, name, errp);
+    visit_type_int(v, name, &s->stats_poll_interval, errp);
 }
 
 static void balloon_stats_set_poll_interval(Object *obj, Visitor *v,
@@ -165,7 +165,7 @@ static void balloon_stats_set_poll_interval(Object *obj, Visitor *v,
     Error *local_err = NULL;
     int64_t value;
 
-    visit_type_int(v, &value, name, &local_err);
+    visit_type_int(v, name, &value, &local_err);
     if (local_err) {
         error_propagate(errp, local_err);
         return;
include/qapi/visitor.h +31 -21

70 lines not on this page · raw message

memory.c +4 -4
index 93bd8ed..49eb809 100644
@@ -934,7 +934,7 @@ static void memory_region_get_addr(Object *obj, Visitor *v, void *opaque,
     MemoryRegion *mr = MEMORY_REGION(obj);
     uint64_t value = mr->addr;
 
-    visit_type_uint64(v, &value, name, errp);
+    visit_type_uint64(v, name, &value, errp);
 }
 
 static void memory_region_get_container(Object *obj, Visitor *v, void *opaque,
@@ -946,7 +946,7 @@ static void memory_region_get_container(Object *obj, Visitor *v, void *opaque,
     if (mr->container) {
         path = object_get_canonical_path(OBJECT(mr->container));
     }
-    visit_type_str(v, &path, name, errp);
+    visit_type_str(v, name, &path, errp);
     if (mr->container) {
         g_free(path);
     }
@@ -966,7 +966,7 @@ static void memory_region_get_priority(Object *obj, Visitor *v, void *opaque,
     MemoryRegion *mr = MEMORY_REGION(obj);
     int32_t value = mr->priority;
 
-    visit_type_int32(v, &value, name, errp);
+    visit_type_int32(v, name, &value, errp);
 }
 
 static bool memory_region_get_may_overlap(Object *obj, Error **errp)
@@ -982,7 +982,7 @@ static void memory_region_get_size(Object *obj, Visitor *v, void *opaque,
     MemoryRegion *mr = MEMORY_REGION(obj);
     uint64_t value = memory_region_size(mr);
 
-    visit_type_uint64(v, &value, name, errp);
+    visit_type_uint64(v, name, &value, errp);
 }
 
 static void memory_region_initfn(Object *obj)
net/dump.c +2 -2
index 88d9582..0aac9b8 100644
@@ -277,7 +277,7 @@ static void filter_dump_get_maxlen(Object *obj, Visitor *v, void *opaque,
     NetFilterDumpState *nfds = FILTER_DUMP(obj);
     uint32_t value = nfds->maxlen;
 
-    visit_type_uint32(v, &value, name, errp);
+    visit_type_uint32(v, name, &value, errp);
 }
 
 static void filter_dump_set_maxlen(Object *obj, Visitor *v, void *opaque,
@@ -287,7 +287,7 @@ static void filter_dump_set_maxlen(Object *obj, Visitor *v, void *opaque,
     Error *local_err = NULL;
     uint32_t value;
 
-    visit_type_uint32(v, &value, name, &local_err);
+    visit_type_uint32(v, name, &value, &local_err);
     if (local_err) {
         goto out;
     }
net/filter-buffer.c +2 -2
index 57be149..3173d26 100644
@@ -138,7 +138,7 @@ static void filter_buffer_get_interval(Object *obj, Visitor *v, void *opaque,
     FilterBufferState *s = FILTER_BUFFER(obj);
     uint32_t value = s->interval;
 
-    visit_type_uint32(v, &value, name, errp);
+    visit_type_uint32(v, name, &value, errp);
 }
 
 static void filter_buffer_set_interval(Object *obj, Visitor *v, void *opaque,
@@ -148,7 +148,7 @@ static void filter_buffer_set_interval(Object *obj, Visitor *v, void *opaque,
     Error *local_err = NULL;
     uint32_t value;
 
-    visit_type_uint32(v, &value, name, &local_err);
+    visit_type_uint32(v, name, &value, &local_err);
     if (local_err) {
         goto out;
     }
net/net.c +2 -2
index 87dd356..428636a 100644
@@ -1035,9 +1035,9 @@ static int net_client_init1(const void *object, int is_netdev, Error **errp)
 static void net_visit(Visitor *v, int is_netdev, void **object, Error **errp)
 {
     if (is_netdev) {
-        visit_type_Netdev(v, (Netdev **)object, NULL, errp);
+        visit_type_Netdev(v, NULL, (Netdev **)object, errp);
     } else {
-        visit_type_NetLegacy(v, (NetLegacy **)object, NULL, errp);
+        visit_type_NetLegacy(v, NULL, (NetLegacy **)object, errp);
     }
 }
 
numa.c +3 -3
index 425ef8d..dbf3278 100644
@@ -218,7 +218,7 @@ static int parse_numa(void *opaque, QemuOpts *opts, Error **errp)
 
     {
         OptsVisitor *ov = opts_visitor_new(opts);
-        visit_type_NumaOptions(opts_get_visitor(ov), &object, NULL, &err);
+        visit_type_NumaOptions(opts_get_visitor(ov), NULL, &object, &err);
         opts_visitor_cleanup(ov);
     }
 
@@ -245,8 +245,8 @@ error:
 
     if (object) {
         QapiDeallocVisitor *dv = qapi_dealloc_visitor_new();
-        visit_type_NumaOptions(qapi_dealloc_get_visitor(dv),
-                               &object, NULL, NULL);
+        visit_type_NumaOptions(qapi_dealloc_get_visitor(dv), NULL, &object,
+                               NULL);
         qapi_dealloc_visitor_cleanup(dv);
     }
 
qapi/qapi-visit-core.c +30 -24

164 lines not on this page · raw message

qemu-img.c +5 -6
index a5949e6..5ee7a38 100644
@@ -376,8 +376,8 @@ static void dump_json_image_check(ImageCheck *check, bool quiet)
     QString *str;
     QmpOutputVisitor *ov = qmp_output_visitor_new();
     QObject *obj;
-    visit_type_ImageCheck(qmp_output_get_visitor(ov),
-                          &check, NULL, &local_err);
+    visit_type_ImageCheck(qmp_output_get_visitor(ov), NULL, &check,
+                          &local_err);
     obj = qmp_output_get_qobject(ov);
     str = qobject_to_json_pretty(obj);
     assert(str != NULL);
@@ -1924,8 +1924,8 @@ static void dump_json_image_info_list(ImageInfoList *list)
     QString *str;
     QmpOutputVisitor *ov = qmp_output_visitor_new();
     QObject *obj;
-    visit_type_ImageInfoList(qmp_output_get_visitor(ov),
-                             &list, NULL, &local_err);
+    visit_type_ImageInfoList(qmp_output_get_visitor(ov), NULL, &list,
+                             &local_err);
     obj = qmp_output_get_qobject(ov);
     str = qobject_to_json_pretty(obj);
     assert(str != NULL);
@@ -1941,8 +1941,7 @@ static void dump_json_image_info(ImageInfo *info)
     QString *str;
     QmpOutputVisitor *ov = qmp_output_visitor_new();
     QObject *obj;
-    visit_type_ImageInfo(qmp_output_get_visitor(ov),
-                         &info, NULL, &local_err);
+    visit_type_ImageInfo(qmp_output_get_visitor(ov), NULL, &info, &local_err);
     obj = qmp_output_get_qobject(ov);
     str = qobject_to_json_pretty(obj);
     assert(str != NULL);
qom/object.c +24 -25

166 lines not on this page · raw message

replay/replay-input.c +2 -2
index bc15f59..ade61e4 100644
@@ -28,7 +28,7 @@ static InputEvent *qapi_clone_InputEvent(InputEvent *src)
 
     qov = qmp_output_visitor_new();
     ov = qmp_output_get_visitor(qov);
-    visit_type_InputEvent(ov, &src, NULL, &error_abort);
+    visit_type_InputEvent(ov, NULL, &src, &error_abort);
     obj = qmp_output_get_qobject(qov);
     qmp_output_visitor_cleanup(qov);
     if (!obj) {
@@ -37,7 +37,7 @@ static InputEvent *qapi_clone_InputEvent(InputEvent *src)
 
     qiv = qmp_input_visitor_new(obj);
     iv = qmp_input_get_visitor(qiv);
-    visit_type_InputEvent(iv, &dst, NULL, &error_abort);
+    visit_type_InputEvent(iv, NULL, &dst, &error_abort);
     qmp_input_visitor_cleanup(qiv);
     qobject_decref(obj);
 
scripts/qapi-commands.py +2 -2
index 561e47a..91c5a4e 100644
@@ -131,7 +131,7 @@ static void qmp_marshal_output_%(c_name)s(%(c_type)s ret_in, QObject **ret_out,
     Visitor *v;
 
     v = qmp_output_get_visitor(qov);
-    visit_type_%(c_name)s(v, &ret_in, "unused", &err);
+    visit_type_%(c_name)s(v, "unused", &ret_in, &err);
     if (err) {
         goto out;
     }
@@ -142,7 +142,7 @@ out:
     qmp_output_visitor_cleanup(qov);
     qdv = qapi_dealloc_visitor_new();
     v = qapi_dealloc_get_visitor(qdv);
-    visit_type_%(c_name)s(v, &ret_in, "unused", NULL);
+    visit_type_%(c_name)s(v, "unused", &ret_in, NULL);
     qapi_dealloc_visitor_cleanup(qdv);
 }
 ''',
scripts/qapi-event.py +1 -1
index 761cda9..fd03e38 100644
@@ -63,7 +63,7 @@ def gen_event_send(name, arg_type):
     qov = qmp_output_visitor_new();
     v = qmp_output_get_visitor(qov);
 
-    visit_start_struct(v, NULL, NULL, "%(name)s", 0, &err);
+    visit_start_struct(v, "%(name)s", NULL, NULL, 0, &err);
 ''',
                      name=name)
         ret += gen_err_check()
scripts/qapi-types.py +1 -1
index 0d86269..d3f631a 100644
@@ -155,7 +155,7 @@ void qapi_free_%(c_name)s(%(c_name)s *obj)
 
     qdv = qapi_dealloc_visitor_new();
     v = qapi_dealloc_get_visitor(qdv);
-    visit_type_%(c_name)s(v, &obj, NULL, NULL);
+    visit_type_%(c_name)s(v, NULL, &obj, NULL);
     qapi_dealloc_visitor_cleanup(qdv);
 }
 ''',
scripts/qapi-visit.py +14 -14
index 6bd188b..ca28b08 100644
@@ -29,7 +29,7 @@ def gen_visit_decl(name, scalar=False):
     if not scalar:
         c_type += '*'
     return mcgen('''
-void visit_type_%(c_name)s(Visitor *v, %(c_type)sobj, const char *name, Error **errp);
+void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_type)sobj, Error **errp);
 ''',
                  c_name=c_name(name), c_type=c_type)
 
@@ -118,11 +118,11 @@ def gen_visit_struct(name, base, members):
     # call qapi_free_FOO() to avoid a memory leak of the partial FOO.
     ret += mcgen('''
 
-void visit_type_%(c_name)s(Visitor *v, %(c_name)s **obj, const char *name, Error **errp)
+void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
 {
     Error *err = NULL;
 
-    visit_start_struct(v, (void **)obj, "%(name)s", name, sizeof(%(c_name)s), &err);
+    visit_start_struct(v, name, (void **)obj, "%(name)s", sizeof(%(c_name)s), &err);
     if (err) {
         goto out;
     }
@@ -150,7 +150,7 @@ def gen_visit_list(name, element_type):
     # call qapi_free_FOOList() to avoid a memory leak of the partial FOOList.
     return mcgen('''
 
-void visit_type_%(c_name)s(Visitor *v, %(c_name)s **obj, const char *name, Error **errp)
+void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
 {
     Error *err = NULL;
     GenericList *i, **prev;
@@ -164,7 +164,7 @@ void visit_type_%(c_name)s(Visitor *v, %(c_name)s **obj, const char *name, Error
          !err && (i = visit_next_list(v, prev, &err)) != NULL;
          prev = &i) {
         %(c_name)s *native_i = (%(c_name)s *)i;
-        visit_type_%(c_elt_type)s(v, &native_i->value, NULL, &err);
+        visit_type_%(c_elt_type)s(v, NULL, &native_i->value, &err);
     }
 
     error_propagate(errp, err);
@@ -180,10 +180,10 @@ out:
 def gen_visit_enum(name):
     return mcgen('''
 
-void visit_type_%(c_name)s(Visitor *v, %(c_name)s *obj, const char *name, Error **errp)
+void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s *obj, Error **errp)
 {
     int tmp = *obj;
-    visit_type_enum(v, &tmp, %(c_name)s_lookup, "%(name)s", name, errp);
+    visit_type_enum(v, name, &tmp, %(c_name)s_lookup, "%(name)s", errp);
     *obj = tmp;
 }
 ''',
@@ -198,7 +198,7 @@ def gen_visit_alternate(name, variants):
 
     ret = mcgen('''
 
-void visit_type_%(c_name)s(Visitor *v, %(c_name)s **obj, const char *name, Error **errp)
+void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
 {
     Error *err = NULL;
 
@@ -206,7 +206,7 @@ void visit_type_%(c_name)s(Visitor *v, %(c_name)s **obj, const char *name, Error
     if (err) {
         goto out;
     }
-    visit_get_next_type(v, &(*obj)->type, %(promote_int)s, name, &err);
+    visit_get_next_type(v, name, &(*obj)->type, %(promote_int)s, &err);
     if (err) {
         goto out_obj;
     }
@@ -217,7 +217,7 @@ void visit_type_%(c_name)s(Visitor *v, %(c_name)s **obj, const char *name, Error
     for var in variants.variants:
         ret += mcgen('''
     case %(case)s:
-        visit_type_%(c_type)s(v, &(*obj)->u.%(c_name)s, name, &err);
+        visit_type_%(c_type)s(v, name, &(*obj)->u.%(c_name)s, &err);
         break;
 ''',
                      case=var.type.alternate_qtype(),
@@ -255,11 +255,11 @@ def gen_visit_union(name, base, variants):
 
     ret += mcgen('''
 
-void visit_type_%(c_name)s(Visitor *v, %(c_name)s **obj, const char *name, Error **errp)
+void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error **errp)
 {
     Error *err = NULL;
 
-    visit_start_struct(v, (void **)obj, "%(name)s", name, sizeof(%(c_name)s), &err);
+    visit_start_struct(v, name, (void **)obj, "%(name)s", sizeof(%(c_name)s), &err);
     if (err) {
         goto out;
     }
@@ -276,7 +276,7 @@ void visit_type_%(c_name)s(Visitor *v, %(c_name)s **obj, const char *name, Error
                      c_name=base.c_name())
     else:
         ret += mcgen('''
-    visit_type_%(c_type)s(v, &(*obj)->%(c_name)s, "%(name)s", &err);
+    visit_type_%(c_type)s(v, "%(name)s", &(*obj)->%(c_name)s, &err);
 ''',
                      c_type=variants.tag_member.type.c_name(),
                      c_name=c_name(variants.tag_member.name),
@@ -300,7 +300,7 @@ void visit_type_%(c_name)s(Visitor *v, %(c_name)s **obj, const char *name, Error
                                        var.name))
         if simple_union_type:
             ret += mcgen('''
-        visit_type_%(c_type)s(v, &(*obj)->u.%(c_name)s, "data", &err);
+        visit_type_%(c_type)s(v, "data", &(*obj)->u.%(c_name)s, &err);
 ''',
                          c_type=simple_union_type.c_name(),
                          c_name=c_name(var.name))
scripts/qapi.py +2 -2
index 497eaba..3b4c62e 100644
@@ -1647,7 +1647,7 @@ def gen_visit_fields(members, prefix='', need_cast=False, skiperr=False,
     for memb in members:
         if memb.optional:
             ret += mcgen('''
-    if (visit_optional(v, &%(prefix)shas_%(c_name)s, "%(name)s")) {
+    if (visit_optional(v, "%(name)s", &%(prefix)shas_%(c_name)s)) {
 ''',
                          prefix=prefix, c_name=c_name(memb.name),
                          name=memb.name, errp=errparg)
@@ -1660,7 +1660,7 @@ def gen_visit_fields(members, prefix='', need_cast=False, skiperr=False,
             cast = ''
 
         ret += mcgen('''
-    visit_type_%(c_type)s(v, %(cast)s&%(prefix)s%(c_name)s, "%(name)s", %(errp)s);
+    visit_type_%(c_type)s(v, "%(name)s", %(cast)s&%(prefix)s%(c_name)s, %(errp)s);
 ''',
                      c_type=memb.type.c_name(), prefix=prefix, cast=cast,
                      c_name=c_name(memb.name), name=memb.name,
target-i386/cpu.c +15 -15
index 13c5b69..110fa1c 100644
@@ -1520,7 +1520,7 @@ static void x86_cpuid_version_get_family(Object *obj, Visitor *v, void *opaque,
     if (value == 0xf) {
         value += (env->cpuid_version >> 20) & 0xff;
     }
-    visit_type_int(v, &value, name, errp);
+    visit_type_int(v, name, &value, errp);
 }
 
 static void x86_cpuid_version_set_family(Object *obj, Visitor *v, void *opaque,
@@ -1533,7 +1533,7 @@ static void x86_cpuid_version_set_family(Object *obj, Visitor *v, void *opaque,
     Error *local_err = NULL;
     int64_t value;
 
-    visit_type_int(v, &value, name, &local_err);
+    visit_type_int(v, name, &value, &local_err);
     if (local_err) {
         error_propagate(errp, local_err);
         return;
@@ -1561,7 +1561,7 @@ static void x86_cpuid_version_get_model(Object *obj, Visitor *v, void *opaque,
 
     value = (env->cpuid_version >> 4) & 0xf;
     value |= ((env->cpuid_version >> 16) & 0xf) << 4;
-    visit_type_int(v, &value, name, errp);
+    visit_type_int(v, name, &value, errp);
 }
 
 static void x86_cpuid_version_set_model(Object *obj, Visitor *v, void *opaque,
@@ -1574,7 +1574,7 @@ static void x86_cpuid_version_set_model(Object *obj, Visitor *v, void *opaque,
     Error *local_err = NULL;
     int64_t value;
 
-    visit_type_int(v, &value, name, &local_err);
+    visit_type_int(v, name, &value, &local_err);
     if (local_err) {
         error_propagate(errp, local_err);
         return;
@@ -1598,7 +1598,7 @@ static void x86_cpuid_version_get_stepping(Object *obj, Visitor *v,
     int64_t value;
 
     value = env->cpuid_version & 0xf;
-    visit_type_int(v, &value, name, errp);
+    visit_type_int(v, name, &value, errp);
 }
 
 static void x86_cpuid_version_set_stepping(Object *obj, Visitor *v,
@@ -1612,7 +1612,7 @@ static void x86_cpuid_version_set_stepping(Object *obj, Visitor *v,
     Error *local_err = NULL;
     int64_t value;
 
-    visit_type_int(v, &value, name, &local_err);
+    visit_type_int(v, name, &value, &local_err);
     if (local_err) {
         error_propagate(errp, local_err);
         return;
@@ -1705,7 +1705,7 @@ static void x86_cpuid_get_tsc_freq(Object *obj, Visitor *v, void *opaque,
     int64_t value;
 
     value = cpu->env.tsc_khz * 1000;
-    visit_type_int(v, &value, name, errp);
+    visit_type_int(v, name, &value, errp);
 }
 
 static void x86_cpuid_set_tsc_freq(Object *obj, Visitor *v, void *opaque,
@@ -1717,7 +1717,7 @@ static void x86_cpuid_set_tsc_freq(Object *obj, Visitor *v, void *opaque,
     Error *local_err = NULL;
     int64_t value;
 
-    visit_type_int(v, &value, name, &local_err);
+    visit_type_int(v, name, &value, &local_err);
     if (local_err) {
         error_propagate(errp, local_err);
         return;
@@ -1737,7 +1737,7 @@ static void x86_cpuid_get_apic_id(Object *obj, Visitor *v, void *opaque,
     X86CPU *cpu = X86_CPU(obj);
     int64_t value = cpu->apic_id;
 
-    visit_type_int(v, &value, name, errp);
+    visit_type_int(v, name, &value, errp);
 }
 
 static void x86_cpuid_set_apic_id(Object *obj, Visitor *v, void *opaque,
@@ -1756,7 +1756,7 @@ static void x86_cpuid_set_apic_id(Object *obj, Visitor *v, void *opaque,
         return;
     }
 
-    visit_type_int(v, &value, name, &error);
+    visit_type_int(v, name, &value, &error);
     if (error) {
         error_propagate(errp, error);
         return;
@@ -1801,7 +1801,7 @@ static void x86_cpu_get_feature_words(Object *obj, Visitor *v, void *opaque,
         list = &list_entries[w];
     }
 
-    visit_type_X86CPUFeatureWordInfoList(v, &list, "feature-words", &err);
+    visit_type_X86CPUFeatureWordInfoList(v, "feature-words", &list, &err);
     error_propagate(errp, err);
 }
 
@@ -1811,7 +1811,7 @@ static void x86_get_hv_spinlocks(Object *obj, Visitor *v, void *opaque,
     X86CPU *cpu = X86_CPU(obj);
     int64_t value = cpu->hyperv_spinlock_attempts;
 
-    visit_type_int(v, &value, name, errp);
+    visit_type_int(v, name, &value, errp);
 }
 
 static void x86_set_hv_spinlocks(Object *obj, Visitor *v, void *opaque,
@@ -1823,7 +1823,7 @@ static void x86_set_hv_spinlocks(Object *obj, Visitor *v, void *opaque,
     Error *err = NULL;
     int64_t value;
 
-    visit_type_int(v, &value, name, &err);
+    visit_type_int(v, name, &value, &err);
     if (err) {
         error_propagate(errp, err);
         return;
@@ -2928,7 +2928,7 @@ static void x86_cpu_get_bit_prop(Object *obj,
 {
     BitProperty *fp = opaque;
     bool value = (*fp->ptr & fp->mask) == fp->mask;
-    visit_type_bool(v, &value, name, errp);
+    visit_type_bool(v, name, &value, errp);
 }
 
 static void x86_cpu_set_bit_prop(Object *obj,
@@ -2947,7 +2947,7 @@ static void x86_cpu_set_bit_prop(Object *obj,
         return;
     }
 
-    visit_type_bool(v, &value, name, &local_err);
+    visit_type_bool(v, name, &value, &local_err);
     if (local_err) {
         error_propagate(errp, local_err);
         return;
target-ppc/translate_init.c +2 -2
index 4ab2d92..9d7936b 100644
@@ -8059,7 +8059,7 @@ static void powerpc_get_compat(Object *obj, Visitor *v,
         break;
     }
 
-    visit_type_str(v, &value, name, errp);
+    visit_type_str(v, name, &value, errp);
 }
 
 static void powerpc_set_compat(Object *obj, Visitor *v,
@@ -8070,7 +8070,7 @@ static void powerpc_set_compat(Object *obj, Visitor *v,
     Property *prop = opaque;
     uint32_t *max_compat = qdev_get_prop_ptr(DEVICE(obj), prop);
 
-    visit_type_str(v, &value, name, &error);
+    visit_type_str(v, name, &value, &error);
     if (error) {
         error_propagate(errp, error);
         return;
tests/test-opts-visitor.c +3 -3
index 1c753d9..9600b97 100644
@@ -44,7 +44,7 @@ setup_fixture(OptsVisitorFixture *f, gconstpointer test_data)
     g_assert(opts != NULL);
 
     ov = opts_visitor_new(opts);
-    visit_type_UserDefOptions(opts_get_visitor(ov), &f->userdef, NULL,
+    visit_type_UserDefOptions(opts_get_visitor(ov), NULL, &f->userdef,
                               &f->err);
     opts_visitor_cleanup(ov);
     qemu_opts_del(opts);
@@ -58,8 +58,8 @@ teardown_fixture(OptsVisitorFixture *f, gconstpointer test_data)
         QapiDeallocVisitor *dv;
 
         dv = qapi_dealloc_visitor_new();
-        visit_type_UserDefOptions(qapi_dealloc_get_visitor(dv), &f->userdef,
-                                  NULL, NULL);
+        visit_type_UserDefOptions(qapi_dealloc_get_visitor(dv), NULL,
+                                  &f->userdef, NULL);
         qapi_dealloc_visitor_cleanup(dv);
     }
     error_free(f->err);
tests/test-qdev-global-props.c +2 -2
index 0be9835..e728611 100644
@@ -124,7 +124,7 @@ static void prop1_accessor(Object *obj,
 {
     MyType *mt = DYNAMIC_TYPE(obj);
 
-    visit_type_uint32(v, &mt->prop1, name, errp);
+    visit_type_uint32(v, name, &mt->prop1, errp);
 }
 
 static void prop2_accessor(Object *obj,
@@ -135,7 +135,7 @@ static void prop2_accessor(Object *obj,
 {
     MyType *mt = DYNAMIC_TYPE(obj);
 
-    visit_type_uint32(v, &mt->prop2, name, errp);
+    visit_type_uint32(v, name, &mt->prop2, errp);
 }
 
 static void dynamic_instance_init(Object *obj)
tests/test-qmp-commands.c +1 -1
index 9f35b80..4d267b6 100644
@@ -217,7 +217,7 @@ static void test_dealloc_partial(void)
         qdict_put_obj(ud2_dict, "string0", QOBJECT(qstring_from_str(text)));
 
         qiv = qmp_input_visitor_new(QOBJECT(ud2_dict));
-        visit_type_UserDefTwo(qmp_input_get_visitor(qiv), &ud2, NULL, &err);
+        visit_type_UserDefTwo(qmp_input_get_visitor(qiv), NULL, &ud2, &err);
         qmp_input_visitor_cleanup(qiv);
         QDECREF(ud2_dict);
     }
tests/test-qmp-input-strict.c +14 -14
index f1c2e3b..775ad39 100644
@@ -98,7 +98,7 @@ static void test_validate_struct(TestInputVisitorData *data,
 
     v = validate_test_init(data, "{ 'integer': -42, 'boolean': true, 'string': 'foo' }");
 
-    visit_type_TestStruct(v, &p, NULL, &error_abort);
+    visit_type_TestStruct(v, NULL, &p, &error_abort);
     g_free(p->string);
     g_free(p);
 }
@@ -114,7 +114,7 @@ static void test_validate_struct_nested(TestInputVisitorData *data,
                            "'dict2': { 'userdef': { 'integer': 42, "
                            "'string': 'string' }, 'string': 'string2'}}}");
 
-    visit_type_UserDefTwo(v, &udp, NULL, &error_abort);
+    visit_type_UserDefTwo(v, NULL, &udp, &error_abort);
     qapi_free_UserDefTwo(udp);
 }
 
@@ -126,7 +126,7 @@ static void test_validate_list(TestInputVisitorData *data,
 
     v = validate_test_init(data, "[ { 'string': 'string0', 'integer': 42 }, { 'string': 'string1', 'integer': 43 }, { 'string': 'string2', 'integer': 44 } ]");
 
-    visit_type_UserDefOneList(v, &head, NULL, &error_abort);
+    visit_type_UserDefOneList(v, NULL, &head, &error_abort);
     qapi_free_UserDefOneList(head);
 }
 
@@ -138,7 +138,7 @@ static void test_validate_union_native_list(TestInputVisitorData *data,
 
     v = validate_test_init(data, "{ 'type': 'integer', 'data' : [ 1, 2 ] }");
 
-    visit_type_UserDefNativeListUnion(v, &tmp, NULL, &error_abort);
+    visit_type_UserDefNativeListUnion(v, NULL, &tmp, &error_abort);
     qapi_free_UserDefNativeListUnion(tmp);
 }
 
@@ -154,7 +154,7 @@ static void test_validate_union_flat(TestInputVisitorData *data,
                            "'string': 'str', "
                            "'boolean': true }");
 
-    visit_type_UserDefFlatUnion(v, &tmp, NULL, &error_abort);
+    visit_type_UserDefFlatUnion(v, NULL, &tmp, &error_abort);
     qapi_free_UserDefFlatUnion(tmp);
 }
 
@@ -166,7 +166,7 @@ static void test_validate_alternate(TestInputVisitorData *data,
 
     v = validate_test_init(data, "42");
 
-    visit_type_UserDefAlternate(v, &tmp, NULL, &error_abort);
+    visit_type_UserDefAlternate(v, NULL, &tmp, &error_abort);
     qapi_free_UserDefAlternate(tmp);
 }
 
@@ -179,7 +179,7 @@ static void test_validate_fail_struct(TestInputVisitorData *data,
 
     v = validate_test_init(data, "{ 'integer': -42, 'boolean': true, 'string': 'foo', 'extra': 42 }");
 
-    visit_type_TestStruct(v, &p, NULL, &err);
+    visit_type_TestStruct(v, NULL, &p, &err);
     error_free_or_abort(&err);
     if (p) {
         g_free(p->string);
@@ -196,7 +196,7 @@ static void test_validate_fail_struct_nested(TestInputVisitorData *data,
 
     v = validate_test_init(data, "{ 'string0': 'string0', 'dict1': { 'string1': 'string1', 'dict2': { 'userdef1': { 'integer': 42, 'string': 'string', 'extra': [42, 23, {'foo':'bar'}] }, 'string2': 'string2'}}}");
 
-    visit_type_UserDefTwo(v, &udp, NULL, &err);
+    visit_type_UserDefTwo(v, NULL, &udp, &err);
     error_free_or_abort(&err);
     qapi_free_UserDefTwo(udp);
 }
@@ -210,7 +210,7 @@ static void test_validate_fail_list(TestInputVisitorData *data,
 
     v = validate_test_init(data, "[ { 'string': 'string0', 'integer': 42 }, { 'string': 'string1', 'integer': 43 }, { 'string': 'string2', 'integer': 44, 'extra': 'ggg' } ]");
 
-    visit_type_UserDefOneList(v, &head, NULL, &err);
+    visit_type_UserDefOneList(v, NULL, &head, &err);
     error_free_or_abort(&err);
     qapi_free_UserDefOneList(head);
 }
@@ -225,7 +225,7 @@ static void test_validate_fail_union_native_list(TestInputVisitorData *data,
     v = validate_test_init(data,
                            "{ 'type': 'integer', 'data' : [ 'string' ] }");
 
-    visit_type_UserDefNativeListUnion(v, &tmp, NULL, &err);
+    visit_type_UserDefNativeListUnion(v, NULL, &tmp, &err);
     error_free_or_abort(&err);
     qapi_free_UserDefNativeListUnion(tmp);
 }
@@ -239,7 +239,7 @@ static void test_validate_fail_union_flat(TestInputVisitorData *data,
 
     v = validate_test_init(data, "{ 'string': 'c', 'integer': 41, 'boolean': true }");
 
-    visit_type_UserDefFlatUnion(v, &tmp, NULL, &err);
+    visit_type_UserDefFlatUnion(v, NULL, &tmp, &err);
     error_free_or_abort(&err);
     qapi_free_UserDefFlatUnion(tmp);
 }
@@ -254,7 +254,7 @@ static void test_validate_fail_union_flat_no_discrim(TestInputVisitorData *data,
     /* test situation where discriminator field ('enum1' here) is missing */
     v = validate_test_init(data, "{ 'integer': 42, 'string': 'c', 'string1': 'd', 'string2': 'e' }");
 
-    visit_type_UserDefFlatUnion2(v, &tmp, NULL, &err);
+    visit_type_UserDefFlatUnion2(v, NULL, &tmp, &err);
     error_free_or_abort(&err);
     qapi_free_UserDefFlatUnion2(tmp);
 }
@@ -268,7 +268,7 @@ static void test_validate_fail_alternate(TestInputVisitorData *data,
 
     v = validate_test_init(data, "3.14");
 
-    visit_type_UserDefAlternate(v, &tmp, NULL, &err);
+    visit_type_UserDefAlternate(v, NULL, &tmp, &err);
     error_free_or_abort(&err);
     qapi_free_UserDefAlternate(tmp);
 }
@@ -281,7 +281,7 @@ static void do_test_validate_qmp_introspect(TestInputVisitorData *data,
 
     v = validate_test_init_raw(data, schema_json);
 
-    visit_type_SchemaInfoList(v, &schema, NULL, &error_abort);
+    visit_type_SchemaInfoList(v, NULL, &schema, &error_abort);
     g_assert(schema);
 
     qapi_free_SchemaInfoList(schema);
tests/test-qmp-input-visitor.c +40 -40

298 lines not on this page · raw message

tests/test-qmp-output-visitor.c +17 -17
index 3078442..4df94bc 100644
@@ -47,7 +47,7 @@ static void test_visitor_out_int(TestOutputVisitorData *data,
     int64_t value = -42;
     QObject *obj;
 
-    visit_type_int(data->ov, &value, NULL, &error_abort);
+    visit_type_int(data->ov, NULL, &value, &error_abort);
 
     obj = qmp_output_get_qobject(data->qov);
     g_assert(obj != NULL);
@@ -63,7 +63,7 @@ static void test_visitor_out_bool(TestOutputVisitorData *data,
     bool value = true;
     QObject *obj;
 
-    visit_type_bool(data->ov, &value, NULL, &error_abort);
+    visit_type_bool(data->ov, NULL, &value, &error_abort);
 
     obj = qmp_output_get_qobject(data->qov);
     g_assert(obj != NULL);
@@ -79,7 +79,7 @@ static void test_visitor_out_number(TestOutputVisitorData *data,
     double value = 3.14;
     QObject *obj;
 
-    visit_type_number(data->ov, &value, NULL, &error_abort);
+    visit_type_number(data->ov, NULL, &value, &error_abort);
 
     obj = qmp_output_get_qobject(data->qov);
     g_assert(obj != NULL);
@@ -95,7 +95,7 @@ static void test_visitor_out_string(TestOutputVisitorData *data,
     char *string = (char *) "Q E M U";
     QObject *obj;
 
-    visit_type_str(data->ov, &string, NULL, &error_abort);
+    visit_type_str(data->ov, NULL, &string, &error_abort);
 
     obj = qmp_output_get_qobject(data->qov);
     g_assert(obj != NULL);
@@ -112,7 +112,7 @@ static void test_visitor_out_no_string(TestOutputVisitorData *data,
     QObject *obj;
 
     /* A null string should return "" */
-    visit_type_str(data->ov, &string, NULL, &error_abort);
+    visit_type_str(data->ov, NULL, &string, &error_abort);
 
     obj = qmp_output_get_qobject(data->qov);
     g_assert(obj != NULL);
@@ -129,7 +129,7 @@ static void test_visitor_out_enum(TestOutputVisitorData *data,
     EnumOne i;
 
     for (i = 0; i < ENUM_ONE__MAX; i++) {
-        visit_type_EnumOne(data->ov, &i, "unused", &error_abort);
+        visit_type_EnumOne(data->ov, "unused", &i, &error_abort);
 
         obj = qmp_output_get_qobject(data->qov);
         g_assert(obj != NULL);
@@ -148,7 +148,7 @@ static void test_visitor_out_enum_errors(TestOutputVisitorData *data,
 
     for (i = 0; i < ARRAY_SIZE(bad_values) ; i++) {
         err = NULL;
-        visit_type_EnumOne(data->ov, &bad_values[i], "unused", &err);
+        visit_type_EnumOne(data->ov, "unused", &bad_values[i], &err);
         g_assert(err);
         error_free(err);
     }
@@ -165,7 +165,7 @@ static void test_visitor_out_struct(TestOutputVisitorData *data,
     QObject *obj;
     QDict *qdict;
 
-    visit_type_TestStruct(data->ov, &p, NULL, &error_abort);
+    visit_type_TestStruct(data->ov, NULL, &p, &error_abort);
 
     obj = qmp_output_get_qobject(data->qov);
     g_assert(obj != NULL);
@@ -210,7 +210,7 @@ static void test_visitor_out_struct_nested(TestOutputVisitorData *data,
     ud2->dict1->dict3->userdef->integer = value;
     ud2->dict1->dict3->string = g_strdup(strings[3]);
 
-    visit_type_UserDefTwo(data->ov, &ud2, "unused", &error_abort);
+    visit_type_UserDefTwo(data->ov, "unused", &ud2, &error_abort);
 
     obj = qmp_output_get_qobject(data->qov);
     g_assert(obj != NULL);
@@ -257,7 +257,7 @@ static void test_visitor_out_struct_errors(TestOutputVisitorData *data,
         err = NULL;
         u.has_enum1 = true;
         u.enum1 = bad_values[i];
-        visit_type_UserDefOne(data->ov, &pu, "unused", &err);
+        visit_type_UserDefOne(data->ov, "unused", &pu, &err);
         g_assert(err);
         error_free(err);
     }
@@ -289,7 +289,7 @@ static void test_visitor_out_list(TestOutputVisitorData *data,
         head = p;
     }
 
-    visit_type_TestStructList(data->ov, &head, NULL, &error_abort);
+    visit_type_TestStructList(data->ov, NULL, &head, &error_abort);
 
     obj = qmp_output_get_qobject(data->qov);
     g_assert(obj != NULL);
@@ -356,7 +356,7 @@ static void test_visitor_out_any(TestOutputVisitorData *data,
     QObject *obj;
 
     qobj = QOBJECT(qint_from_int(-42));
-    visit_type_any(data->ov, &qobj, NULL, &error_abort);
+    visit_type_any(data->ov, NULL, &qobj, &error_abort);
     obj = qmp_output_get_qobject(data->qov);
     g_assert(obj != NULL);
     g_assert(qobject_type(obj) == QTYPE_QINT);
@@ -369,7 +369,7 @@ static void test_visitor_out_any(TestOutputVisitorData *data,
     qdict_put(qdict, "boolean", qbool_from_bool(true));
     qdict_put(qdict, "string", qstring_from_str("foo"));
     qobj = QOBJECT(qdict);
-    visit_type_any(data->ov, &qobj, NULL, &error_abort);
+    visit_type_any(data->ov, NULL, &qobj, &error_abort);
     qobject_decref(qobj);
     obj = qmp_output_get_qobject(data->qov);
     g_assert(obj != NULL);
@@ -406,7 +406,7 @@ static void test_visitor_out_union_flat(TestOutputVisitorData *data,
     tmp->integer = 41;
     tmp->u.value1->boolean = true;
 
-    visit_type_UserDefFlatUnion(data->ov, &tmp, NULL, &error_abort);
+    visit_type_UserDefFlatUnion(data->ov, NULL, &tmp, &error_abort);
     arg = qmp_output_get_qobject(data->qov);
 
     g_assert(qobject_type(arg) == QTYPE_QDICT);
@@ -431,7 +431,7 @@ static void test_visitor_out_alternate(TestOutputVisitorData *data,
     tmp->type = QTYPE_QINT;
     tmp->u.i = 42;
 
-    visit_type_UserDefAlternate(data->ov, &tmp, NULL, &error_abort);
+    visit_type_UserDefAlternate(data->ov, NULL, &tmp, &error_abort);
     arg = qmp_output_get_qobject(data->qov);
 
     g_assert(qobject_type(arg) == QTYPE_QINT);
@@ -444,7 +444,7 @@ static void test_visitor_out_alternate(TestOutputVisitorData *data,
     tmp->type = QTYPE_QSTRING;
     tmp->u.s = g_strdup("hello");
 
-    visit_type_UserDefAlternate(data->ov, &tmp, NULL, &error_abort);
+    visit_type_UserDefAlternate(data->ov, NULL, &tmp, &error_abort);
     arg = qmp_output_get_qobject(data->qov);
 
     g_assert(qobject_type(arg) == QTYPE_QSTRING);
@@ -690,7 +690,7 @@ static void test_native_list(TestOutputVisitorData *data,
     cvalue->type = kind;
     init_native_list(cvalue);
 
-    visit_type_UserDefNativeListUnion(data->ov, &cvalue, NULL, &error_abort);
+    visit_type_UserDefNativeListUnion(data->ov, NULL, &cvalue, &error_abort);
 
     obj = qmp_output_get_qobject(data->qov);
     check_native_list(obj, cvalue->type);
tests/test-string-input-visitor.c +17 -17
index 8e3433e..d99498d 100644
@@ -59,7 +59,7 @@ static void test_visitor_in_int(TestInputVisitorData *data,
 
     v = visitor_input_test_init(data, "-42");
 
-    visit_type_int(v, &res, NULL, &err);
+    visit_type_int(v, NULL, &res, &err);
     g_assert(!err);
     g_assert_cmpint(res, ==, value);
 }
@@ -74,7 +74,7 @@ static void test_visitor_in_intList(TestInputVisitorData *data,
 
     v = visitor_input_test_init(data, "1,2,0,2-4,20,5-9,1-8");
 
-    visit_type_int16List(v, &res, NULL, &error_abort);
+    visit_type_int16List(v, NULL, &res, &error_abort);
     tmp = res;
     while (i < sizeof(value) / sizeof(value[0])) {
         g_assert(tmp);
@@ -100,42 +100,42 @@ static void test_visitor_in_bool(TestInputVisitorData *data,
 
     v = visitor_input_test_init(data, "true");
 
-    visit_type_bool(v, &res, NULL, &err);
+    visit_type_bool(v, NULL, &res, &err);
     g_assert(!err);
     g_assert_cmpint(res, ==, true);
     visitor_input_teardown(data, unused);
 
     v = visitor_input_test_init(data, "yes");
 
-    visit_type_bool(v, &res, NULL, &err);
+    visit_type_bool(v, NULL, &res, &err);
     g_assert(!err);
     g_assert_cmpint(res, ==, true);
     visitor_input_teardown(data, unused);
 
     v = visitor_input_test_init(data, "on");
 
-    visit_type_bool(v, &res, NULL, &err);
+    visit_type_bool(v, NULL, &res, &err);
     g_assert(!err);
     g_assert_cmpint(res, ==, true);
     visitor_input_teardown(data, unused);
 
     v = visitor_input_test_init(data, "false");
 
-    visit_type_bool(v, &res, NULL, &err);
+    visit_type_bool(v, NULL, &res, &err);
     g_assert(!err);
     g_assert_cmpint(res, ==, false);
     visitor_input_teardown(data, unused);
 
     v = visitor_input_test_init(data, "no");
 
-    visit_type_bool(v, &res, NULL, &err);
+    visit_type_bool(v, NULL, &res, &err);
     g_assert(!err);
     g_assert_cmpint(res, ==, false);
     visitor_input_teardown(data, unused);
 
     v = visitor_input_test_init(data, "off");
 
-    visit_type_bool(v, &res, NULL, &err);
+    visit_type_bool(v, NULL, &res, &err);
     g_assert(!err);
     g_assert_cmpint(res, ==, false);
 }
@@ -149,7 +149,7 @@ static void test_visitor_in_number(TestInputVisitorData *data,
 
     v = visitor_input_test_init(data, "3.14");
 
-    visit_type_number(v, &res, NULL, &err);
+    visit_type_number(v, NULL, &res, &err);
     g_assert(!err);
     g_assert_cmpfloat(res, ==, value);
 }
@@ -163,7 +163,7 @@ static void test_visitor_in_string(TestInputVisitorData *data,
 
     v = visitor_input_test_init(data, value);
 
-    visit_type_str(v, &res, NULL, &err);
+    visit_type_str(v, NULL, &res, &err);
     g_assert(!err);
     g_assert_cmpstr(res, ==, value);
 
@@ -182,7 +182,7 @@ static void test_visitor_in_enum(TestInputVisitorData *data,
 
         v = visitor_input_test_init(data, EnumOne_lookup[i]);
 
-        visit_type_EnumOne(v, &res, NULL, &err);
+        visit_type_EnumOne(v, NULL, &res, &err);
         g_assert(!err);
         g_assert_cmpint(i, ==, res);
 
@@ -220,29 +220,29 @@ static void test_visitor_in_fuzz(TestInputVisitorData *data,
         }
 
         v = visitor_input_test_init(data, buf);
-        visit_type_int(v, &ires, NULL, NULL);
+        visit_type_int(v, NULL, &ires, NULL);
         visitor_input_teardown(data, NULL);
 
         v = visitor_input_test_init(data, buf);
-        visit_type_intList(v, &ilres, NULL, NULL);
+        visit_type_intList(v, NULL, &ilres, NULL);
         visitor_input_teardown(data, NULL);
 
         v = visitor_input_test_init(data, buf);
-        visit_type_bool(v, &bres, NULL, NULL);
+        visit_type_bool(v, NULL, &bres, NULL);
         visitor_input_teardown(data, NULL);
 
         v = visitor_input_test_init(data, buf);
-        visit_type_number(v, &nres, NULL, NULL);
+        visit_type_number(v, NULL, &nres, NULL);
         visitor_input_teardown(data, NULL);
 
         v = visitor_input_test_init(data, buf);
         sres = NULL;
-        visit_type_str(v, &sres, NULL, NULL);
+        visit_type_str(v, NULL, &sres, NULL);
         g_free(sres);
         visitor_input_teardown(data, NULL);
 
         v = visitor_input_test_init(data, buf);
-        visit_type_EnumOne(v, &eres, NULL, NULL);
+        visit_type_EnumOne(v, NULL, &eres, NULL);
         visitor_input_teardown(data, NULL);
     }
 }
tests/test-string-output-visitor.c +8 -8
index 7aecdfc..4f4450f 100644
@@ -61,7 +61,7 @@ static void test_visitor_out_int(TestOutputVisitorData *data,
     Error *err = NULL;
     char *str;
 
-    visit_type_int(data->ov, &value, NULL, &err);
+    visit_type_int(data->ov, NULL, &value, &err);
     g_assert(!err);
 
     str = string_output_get_string(data->sov);
@@ -90,7 +90,7 @@ static void test_visitor_out_intList(TestOutputVisitorData *data,
         tmp = &(*tmp)->next;
     }
 
-    visit_type_intList(data->ov, &list, NULL, &err);
+    visit_type_intList(data->ov, NULL, &list, &err);
     g_assert(err == NULL);
 
     str = string_output_get_string(data->sov);
@@ -120,7 +120,7 @@ static void test_visitor_out_bool(TestOutputVisitorData *data,
     bool value = true;
     char *str;
 
-    visit_type_bool(data->ov, &value, NULL, &err);
+    visit_type_bool(data->ov, NULL, &value, &err);
     g_assert(!err);
 
     str = string_output_get_string(data->sov);
@@ -136,7 +136,7 @@ static void test_visitor_out_number(TestOutputVisitorData *data,
     Error *err = NULL;
     char *str;
 
-    visit_type_number(data->ov, &value, NULL, &err);
+    visit_type_number(data->ov, NULL, &value, &err);
     g_assert(!err);
 
     str = string_output_get_string(data->sov);
@@ -153,7 +153,7 @@ static void test_visitor_out_string(TestOutputVisitorData *data,
     Error *err = NULL;
     char *str;
 
-    visit_type_str(data->ov, &string, NULL, &err);
+    visit_type_str(data->ov, NULL, &string, &err);
     g_assert(!err);
 
     str = string_output_get_string(data->sov);
@@ -174,7 +174,7 @@ static void test_visitor_out_no_string(TestOutputVisitorData *data,
     char *str;
 
     /* A null string should return "" */
-    visit_type_str(data->ov, &string, NULL, &err);
+    visit_type_str(data->ov, NULL, &string, &err);
     g_assert(!err);
 
     str = string_output_get_string(data->sov);
@@ -197,7 +197,7 @@ static void test_visitor_out_enum(TestOutputVisitorData *data,
     for (i = 0; i < ENUM_ONE__MAX; i++) {
         char *str_human;
 
-        visit_type_EnumOne(data->ov, &i, "unused", &err);
+        visit_type_EnumOne(data->ov, "unused", &i, &err);
         g_assert(!err);
 
         str_human = g_strdup_printf("\"%s\"", EnumOne_lookup[i]);
@@ -222,7 +222,7 @@ static void test_visitor_out_enum_errors(TestOutputVisitorData *data,
 
     for (i = 0; i < ARRAY_SIZE(bad_values) ; i++) {
         err = NULL;
-        visit_type_EnumOne(data->ov, &bad_values[i], "unused", &err);
+        visit_type_EnumOne(data->ov, "unused", &bad_values[i], &err);
         g_assert(err);
         error_free(err);
     }
tests/test-visitor-serialization.c +27 -27

126 lines not on this page · raw message

util/qemu-sockets.c +2 -2
index 922efb3..96b7ae7 100644
@@ -1152,7 +1152,7 @@ void qapi_copy_SocketAddress(SocketAddress **p_dest,
 
     qov = qmp_output_visitor_new();
     ov = qmp_output_get_visitor(qov);
-    visit_type_SocketAddress(ov, &src, NULL, &error_abort);
+    visit_type_SocketAddress(ov, NULL, &src, &error_abort);
     obj = qmp_output_get_qobject(qov);
     qmp_output_visitor_cleanup(qov);
     if (!obj) {
@@ -1161,7 +1161,7 @@ void qapi_copy_SocketAddress(SocketAddress **p_dest,
 
     qiv = qmp_input_visitor_new(obj);
     iv = qmp_input_get_visitor(qiv);
-    visit_type_SocketAddress(iv, p_dest, NULL, &error_abort);
+    visit_type_SocketAddress(iv, NULL, p_dest, &error_abort);
     qmp_input_visitor_cleanup(qiv);
     qobject_decref(obj);
 }
vl.c +2 -2
index aaa5403..49ec0de 100644
@@ -2840,7 +2840,7 @@ static int object_create(void *opaque, QemuOpts *opts, Error **errp)
     }
 
     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;
     }
@@ -2850,7 +2850,7 @@ static int object_create(void *opaque, QemuOpts *opts, Error **errp)
     }
 
     qdict_del(pdict, "id");
-    visit_type_str(v, &id, "id", &err);
+    visit_type_str(v, "id", &id, &err);
     if (err) {
         goto out_end;
     }
Signature · 1 line
2.5.0
#47 lore raw

Re: [Qemu-devel] [PATCH v9 14/37] qapi: Swap visit_* arguments for consistent 'name' placement

Quoted 8 lines · Eric Blake

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.

Yes, please!

Quoted 4 lines

Additional reasons in favor of the swap: name is always an input parameter, while &value is sometimes an output parameter (depending on whether the caller is using an input visitor); and it is nicer to list input parameters first.

Except when it isn't: memcpy(), strcat(), ... I'd scratch this argument. The case for the transformation is plenty strong without it.

Quoted 17 lines

Also, 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.

The next 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').
Quoted 8 lines
    // 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)

Rotates second to fourth parameters right. Their types are sufficiently incompatible, so the compiler should catch inconsistencies.

Similar argument for the other functions.

Quoted 61 lines
     { ... }

    @@
    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)
    )
Quoted 2 lines

Didn't check the patch closely.

author
#48 lore raw

PATCH v9 15/37 qom: Swap 'name' next to visitor in ObjectPropertyAccessor

In reply to Eric Blake

Similar to the previous patch, it's nice to have all functions in the tree that involve a visitor and a name for conversion to or from QAPI to consistently stick the 'name' parameter next to the Visitor parameter.

Done by manually changing include/qom/object.h and qom/object.c, then running this Coccinelle script and touching up the fallout (Coccinelle insisted on adding some trailing whitespace).

    @ rule1 @
    identifier fn;
    type Object, Visitor, Error;
    identifier obj, v, opaque, name, errp;
    @@
     void fn
    - (Object *obj, Visitor *v, void *opaque, const char *name,
    + (Object *obj, Visitor *v, const char *name, void *opaque,
       Error **errp) { ... }

    @@
    identifier rule1.fn;
    expression obj, v, opaque, name, errp;
    @@
     fn(obj, v,
    -   opaque, name,
    +   name, opaque,
        errp)

---
v9: typo fix in commit message, rebase to master context
v8: new patch

---
 backends/hostmem.c               |  16 +++---
 bootdevice.c                     |   8 +--
 hw/acpi/ich9.c                   |  35 +++++-------
 hw/block/nvme.c                  |   8 +--
 hw/core/machine.c                |  14 ++---
 hw/core/qdev-properties-system.c |  32 +++++------
 hw/core/qdev-properties.c        | 116 +++++++++++++++++++--------------------
 hw/core/qdev.c                   |   5 +-
 hw/i386/pc.c                     |  29 +++++-----
 hw/ide/qdev.c                    |   8 +--
 hw/intc/xics.c                   |  12 ++--
 hw/isa/lpc_ich9.c                |   5 +-
 hw/mem/pc-dimm.c                 |   4 +-
 hw/misc/edu.c                    |   4 +-
 hw/misc/tmp105.c                 |   8 +--
 hw/net/ne2000-isa.c              |  10 ++--
 hw/pci-host/piix.c               |  10 ++--
 hw/pci-host/q35.c                |  13 ++---
 hw/ppc/spapr_drc.c               |  16 +++---
 hw/usb/dev-storage.c             |   8 +--
 hw/virtio/virtio-balloon.c       |   8 +--
 include/qom/object.h             |   4 +-
 memory.c                         |  18 +++---
 net/dump.c                       |   8 +--
 net/filter-buffer.c              |  10 ++--
 qom/object.c                     |  75 +++++++++++++------------
 target-i386/cpu.c                |  66 +++++++++++-----------
 target-ppc/translate_init.c      |   8 +--
 tests/test-qdev-global-props.c   |  14 ++---
 29 files changed, 282 insertions(+), 290 deletions(-)
backends/hostmem.c +8 -8
index a9d30d8..2657907 100644
@@ -26,8 +26,8 @@ QEMU_BUILD_BUG_ON(HOST_MEM_POLICY_INTERLEAVE != MPOL_INTERLEAVE);
 #endif
 
 static void
-host_memory_backend_get_size(Object *obj, Visitor *v, void *opaque,
-                             const char *name, Error **errp)
+host_memory_backend_get_size(Object *obj, Visitor *v, const char *name,
+                             void *opaque, Error **errp)
 {
     HostMemoryBackend *backend = MEMORY_BACKEND(obj);
     uint64_t value = backend->size;
@@ -36,8 +36,8 @@ host_memory_backend_get_size(Object *obj, Visitor *v, void *opaque,
 }
 
 static void
-host_memory_backend_set_size(Object *obj, Visitor *v, void *opaque,
-                             const char *name, Error **errp)
+host_memory_backend_set_size(Object *obj, Visitor *v, const char *name,
+                             void *opaque, Error **errp)
 {
     HostMemoryBackend *backend = MEMORY_BACKEND(obj);
     Error *local_err = NULL;
@@ -63,8 +63,8 @@ out:
 }
 
 static void
-host_memory_backend_get_host_nodes(Object *obj, Visitor *v, void *opaque,
-                                   const char *name, Error **errp)
+host_memory_backend_get_host_nodes(Object *obj, Visitor *v, const char *name,
+                                   void *opaque, Error **errp)
 {
     HostMemoryBackend *backend = MEMORY_BACKEND(obj);
     uint16List *host_nodes = NULL;
@@ -95,8 +95,8 @@ host_memory_backend_get_host_nodes(Object *obj, Visitor *v, void *opaque,
 }
 
 static void
-host_memory_backend_set_host_nodes(Object *obj, Visitor *v, void *opaque,
-                                   const char *name, Error **errp)
+host_memory_backend_set_host_nodes(Object *obj, Visitor *v, const char *name,
+                                   void *opaque, Error **errp)
 {
 #ifdef CONFIG_NUMA
     HostMemoryBackend *backend = MEMORY_BACKEND(obj);
bootdevice.c +4 -4
index d307cfc..56e5baf 100644
@@ -270,15 +270,15 @@ typedef struct {
     DeviceState *dev;
 } BootIndexProperty;
 
-static void device_get_bootindex(Object *obj, Visitor *v, void *opaque,
-                                 const char *name, Error **errp)
+static void device_get_bootindex(Object *obj, Visitor *v, const char *name,
+                                 void *opaque, Error **errp)
 {
     BootIndexProperty *prop = opaque;
     visit_type_int32(v, name, prop->bootindex, errp);
 }
 
-static void device_set_bootindex(Object *obj, Visitor *v, void *opaque,
-                                 const char *name, Error **errp)
+static void device_set_bootindex(Object *obj, Visitor *v, const char *name,
+                                 void *opaque, Error **errp)
 {
     BootIndexProperty *prop = opaque;
     int32_t boot_index;
hw/acpi/ich9.c +14 -21
index 0a486fb..3efdce7 100644
@@ -282,9 +282,8 @@ void ich9_pm_init(PCIDevice *lpc_pci, ICH9LPCPMRegs *pm,
     }
 }
 
-static void ich9_pm_get_gpe0_blk(Object *obj, Visitor *v,
-                                 void *opaque, const char *name,
-                                 Error **errp)
+static void ich9_pm_get_gpe0_blk(Object *obj, Visitor *v, const char *name,
+                                 void *opaque, Error **errp)
 {
     ICH9LPCPMRegs *pm = opaque;
     uint32_t value = pm->pm_io_base + ICH9_PMIO_GPE0_STS;
@@ -307,9 +306,8 @@ static void ich9_pm_set_memory_hotplug_support(Object *obj, bool value,
     s->pm.acpi_memory_hotplug.is_enabled = value;
 }
 
-static void ich9_pm_get_disable_s3(Object *obj, Visitor *v,
-                                   void *opaque, const char *name,
-                                   Error **errp)
+static void ich9_pm_get_disable_s3(Object *obj, Visitor *v, const char *name,
+                                   void *opaque, Error **errp)
 {
     ICH9LPCPMRegs *pm = opaque;
     uint8_t value = pm->disable_s3;
@@ -317,9 +315,8 @@ static void ich9_pm_get_disable_s3(Object *obj, Visitor *v,
     visit_type_uint8(v, name, &value, errp);
 }
 
-static void ich9_pm_set_disable_s3(Object *obj, Visitor *v,
-                                   void *opaque, const char *name,
-                                   Error **errp)
+static void ich9_pm_set_disable_s3(Object *obj, Visitor *v, const char *name,
+                                   void *opaque, Error **errp)
 {
     ICH9LPCPMRegs *pm = opaque;
     Error *local_err = NULL;
@@ -334,9 +331,8 @@ out:
     error_propagate(errp, local_err);
 }
 
-static void ich9_pm_get_disable_s4(Object *obj, Visitor *v,
-                                   void *opaque, const char *name,
-                                   Error **errp)
+static void ich9_pm_get_disable_s4(Object *obj, Visitor *v, const char *name,
+                                   void *opaque, Error **errp)
 {
     ICH9LPCPMRegs *pm = opaque;
     uint8_t value = pm->disable_s4;
@@ -344,9 +340,8 @@ static void ich9_pm_get_disable_s4(Object *obj, Visitor *v,
     visit_type_uint8(v, name, &value, errp);
 }
 
-static void ich9_pm_set_disable_s4(Object *obj, Visitor *v,
-                                   void *opaque, const char *name,
-                                   Error **errp)
+static void ich9_pm_set_disable_s4(Object *obj, Visitor *v, const char *name,
+                                   void *opaque, Error **errp)
 {
     ICH9LPCPMRegs *pm = opaque;
     Error *local_err = NULL;
@@ -361,9 +356,8 @@ out:
     error_propagate(errp, local_err);
 }
 
-static void ich9_pm_get_s4_val(Object *obj, Visitor *v,
-                               void *opaque, const char *name,
-                               Error **errp)
+static void ich9_pm_get_s4_val(Object *obj, Visitor *v, const char *name,
+                               void *opaque, Error **errp)
 {
     ICH9LPCPMRegs *pm = opaque;
     uint8_t value = pm->s4_val;
@@ -371,9 +365,8 @@ static void ich9_pm_get_s4_val(Object *obj, Visitor *v,
     visit_type_uint8(v, name, &value, errp);
 }
 
-static void ich9_pm_set_s4_val(Object *obj, Visitor *v,
-                               void *opaque, const char *name,
-                               Error **errp)
+static void ich9_pm_set_s4_val(Object *obj, Visitor *v, const char *name,
+                               void *opaque, Error **errp)
 {
     ICH9LPCPMRegs *pm = opaque;
     Error *local_err = NULL;
hw/block/nvme.c +4 -4
index 3676e2e..8d32ede 100644
@@ -915,16 +915,16 @@ static void nvme_class_init(ObjectClass *oc, void *data)
     dc->vmsd = &nvme_vmstate;
 }
 
-static void nvme_get_bootindex(Object *obj, Visitor *v, void *opaque,
-                                  const char *name, Error **errp)
+static void nvme_get_bootindex(Object *obj, Visitor *v, const char *name,
+                               void *opaque, Error **errp)
 {
     NvmeCtrl *s = NVME(obj);
 
     visit_type_int32(v, name, &s->conf.bootindex, errp);
 }
 
-static void nvme_set_bootindex(Object *obj, Visitor *v, void *opaque,
-                                  const char *name, Error **errp)
+static void nvme_set_bootindex(Object *obj, Visitor *v, const char *name,
+                               void *opaque, Error **errp)
 {
     NvmeCtrl *s = NVME(obj);
     int32_t boot_index;
hw/core/machine.c +7 -7
index 0fd1e73..3ec3efa 100644
@@ -33,7 +33,7 @@ static void machine_set_accel(Object *obj, const char *value, Error **errp)
 }
 
 static void machine_set_kernel_irqchip(Object *obj, Visitor *v,
-                                       void *opaque, const char *name,
+                                       const char *name, void *opaque,
                                        Error **errp)
 {
     Error *err = NULL;
@@ -68,7 +68,7 @@ static void machine_set_kernel_irqchip(Object *obj, Visitor *v,
 }
 
 static void machine_get_kvm_shadow_mem(Object *obj, Visitor *v,
-                                       void *opaque, const char *name,
+                                       const char *name, void *opaque,
                                        Error **errp)
 {
     MachineState *ms = MACHINE(obj);
@@ -78,7 +78,7 @@ static void machine_get_kvm_shadow_mem(Object *obj, Visitor *v,
 }
 
 static void machine_set_kvm_shadow_mem(Object *obj, Visitor *v,
-                                       void *opaque, const char *name,
+                                       const char *name, void *opaque,
                                        Error **errp)
 {
     MachineState *ms = MACHINE(obj);
@@ -170,8 +170,8 @@ static void machine_set_dumpdtb(Object *obj, const char *value, Error **errp)
 }
 
 static void machine_get_phandle_start(Object *obj, Visitor *v,
-                                       void *opaque, const char *name,
-                                       Error **errp)
+                                      const char *name, void *opaque,
+                                      Error **errp)
 {
     MachineState *ms = MACHINE(obj);
     int64_t value = ms->phandle_start;
@@ -180,8 +180,8 @@ static void machine_get_phandle_start(Object *obj, Visitor *v,
 }
 
 static void machine_set_phandle_start(Object *obj, Visitor *v,
-                                       void *opaque, const char *name,
-                                       Error **errp)
+                                      const char *name, void *opaque,
+                                      Error **errp)
 {
     MachineState *ms = MACHINE(obj);
     Error *error = NULL;
hw/core/qdev-properties-system.c +16 -16
index 86e0b02..0f0e472 100644
@@ -111,14 +111,14 @@ static char *print_drive(void *ptr)
     return g_strdup(blk_name(ptr));
 }
 
-static void get_drive(Object *obj, Visitor *v, void *opaque,
-                      const char *name, Error **errp)
+static void get_drive(Object *obj, Visitor *v, const char *name, void *opaque,
+                      Error **errp)
 {
     get_pointer(obj, v, opaque, print_drive, name, errp);
 }
 
-static void set_drive(Object *obj, Visitor *v, void *opaque,
-                      const char *name, Error **errp)
+static void set_drive(Object *obj, Visitor *v, const char *name, void *opaque,
+                      Error **errp)
 {
     set_pointer(obj, v, opaque, parse_drive, name, errp);
 }
@@ -172,14 +172,14 @@ static char *print_chr(void *ptr)
     return g_strdup(val);
 }
 
-static void get_chr(Object *obj, Visitor *v, void *opaque,
-                    const char *name, Error **errp)
+static void get_chr(Object *obj, Visitor *v, const char *name, void *opaque,
+                    Error **errp)
 {
     get_pointer(obj, v, opaque, print_chr, name, errp);
 }
 
-static void set_chr(Object *obj, Visitor *v, void *opaque,
-                    const char *name, Error **errp)
+static void set_chr(Object *obj, Visitor *v, const char *name, void *opaque,
+                    Error **errp)
 {
     set_pointer(obj, v, opaque, parse_chr, name, errp);
 }
@@ -193,8 +193,8 @@ PropertyInfo qdev_prop_chr = {
 };
 
 /* --- netdev device --- */
-static void get_netdev(Object *obj, Visitor *v, void *opaque,
-                       const char *name, Error **errp)
+static void get_netdev(Object *obj, Visitor *v, const char *name,
+                       void *opaque, Error **errp)
 {
     DeviceState *dev = DEVICE(obj);
     Property *prop = opaque;
@@ -205,8 +205,8 @@ static void get_netdev(Object *obj, Visitor *v, void *opaque,
     g_free(p);
 }
 
-static void set_netdev(Object *obj, Visitor *v, void *opaque,
-                       const char *name, Error **errp)
+static void set_netdev(Object *obj, Visitor *v, const char *name,
+                       void *opaque, Error **errp)
 {
     DeviceState *dev = DEVICE(obj);
     Property *prop = opaque;
@@ -292,8 +292,8 @@ static int print_vlan(DeviceState *dev, Property *prop, char *dest, size_t len)
     return snprintf(dest, len, "<null>");
 }
 
-static void get_vlan(Object *obj, Visitor *v, void *opaque,
-                     const char *name, Error **errp)
+static void get_vlan(Object *obj, Visitor *v, const char *name, void *opaque,
+                     Error **errp)
 {
     DeviceState *dev = DEVICE(obj);
     Property *prop = opaque;
@@ -310,8 +310,8 @@ static void get_vlan(Object *obj, Visitor *v, void *opaque,
     visit_type_int32(v, name, &id, errp);
 }
 
-static void set_vlan(Object *obj, Visitor *v, void *opaque,
-                     const char *name, Error **errp)
+static void set_vlan(Object *obj, Visitor *v, const char *name, void *opaque,
+                     Error **errp)
 {
     DeviceState *dev = DEVICE(obj);
     Property *prop = opaque;
hw/core/qdev-properties.c +58 -58

290 lines not on this page · raw message

hw/core/qdev.c +3 -2
index b343a4d..aa0792a 100644
@@ -887,8 +887,9 @@ char *qdev_get_dev_path(DeviceState *dev)
  * Legacy property handling
  */
 
-static void qdev_get_legacy_property(Object *obj, Visitor *v, void *opaque,
-                                     const char *name, Error **errp)
+static void qdev_get_legacy_property(Object *obj, Visitor *v,
+                                     const char *name, void *opaque,
+                                     Error **errp)
 {
     DeviceState *dev = DEVICE(obj);
     Property *prop = opaque;
hw/i386/pc.c +15 -14
index 0ec39dc..b43da29 100644
@@ -1754,8 +1754,9 @@ static HotplugHandler *pc_get_hotpug_handler(MachineState *machine,
 }
 
 static void
-pc_machine_get_hotplug_memory_region_size(Object *obj, Visitor *v, void *opaque,
-                                          const char *name, Error **errp)
+pc_machine_get_hotplug_memory_region_size(Object *obj, Visitor *v,
+                                          const char *name, void *opaque,
+                                          Error **errp)
 {
     PCMachineState *pcms = PC_MACHINE(obj);
     int64_t value = memory_region_size(&pcms->hotplug_memory.mr);
@@ -1764,8 +1765,8 @@ pc_machine_get_hotplug_memory_region_size(Object *obj, Visitor *v, void *opaque,
 }
 
 static void pc_machine_get_max_ram_below_4g(Object *obj, Visitor *v,
-                                         void *opaque, const char *name,
-                                         Error **errp)
+                                            const char *name, void *opaque,
+                                            Error **errp)
 {
     PCMachineState *pcms = PC_MACHINE(obj);
     uint64_t value = pcms->max_ram_below_4g;
@@ -1774,8 +1775,8 @@ static void pc_machine_get_max_ram_below_4g(Object *obj, Visitor *v,
 }
 
 static void pc_machine_set_max_ram_below_4g(Object *obj, Visitor *v,
-                                         void *opaque, const char *name,
-                                         Error **errp)
+                                            const char *name, void *opaque,
+                                            Error **errp)
 {
     PCMachineState *pcms = PC_MACHINE(obj);
     Error *error = NULL;
@@ -1803,8 +1804,8 @@ static void pc_machine_set_max_ram_below_4g(Object *obj, Visitor *v,
     pcms->max_ram_below_4g = value;
 }
 
-static void pc_machine_get_vmport(Object *obj, Visitor *v, void *opaque,
-                                  const char *name, Error **errp)
+static void pc_machine_get_vmport(Object *obj, Visitor *v, const char *name,
+                                  void *opaque, Error **errp)
 {
     PCMachineState *pcms = PC_MACHINE(obj);
     OnOffAuto vmport = pcms->vmport;
@@ -1812,8 +1813,8 @@ static void pc_machine_get_vmport(Object *obj, Visitor *v, void *opaque,
     visit_type_OnOffAuto(v, name, &vmport, errp);
 }
 
-static void pc_machine_set_vmport(Object *obj, Visitor *v, void *opaque,
-                                  const char *name, Error **errp)
+static void pc_machine_set_vmport(Object *obj, Visitor *v, const char *name,
+                                  void *opaque, Error **errp)
 {
     PCMachineState *pcms = PC_MACHINE(obj);
 
@@ -1845,8 +1846,8 @@ bool pc_machine_is_smm_enabled(PCMachineState *pcms)
     return false;
 }
 
-static void pc_machine_get_smm(Object *obj, Visitor *v, void *opaque,
-                              const char *name, Error **errp)
+static void pc_machine_get_smm(Object *obj, Visitor *v, const char *name,
+                               void *opaque, Error **errp)
 {
     PCMachineState *pcms = PC_MACHINE(obj);
     OnOffAuto smm = pcms->smm;
@@ -1854,8 +1855,8 @@ static void pc_machine_get_smm(Object *obj, Visitor *v, void *opaque,
     visit_type_OnOffAuto(v, name, &smm, errp);
 }
 
-static void pc_machine_set_smm(Object *obj, Visitor *v, void *opaque,
-                                  const char *name, Error **errp)
+static void pc_machine_set_smm(Object *obj, Visitor *v, const char *name,
+                               void *opaque, Error **errp)
 {
     PCMachineState *pcms = PC_MACHINE(obj);
 
hw/ide/qdev.c +4 -4
index 66f56e7..ec84937 100644
@@ -199,16 +199,16 @@ static int ide_dev_initfn(IDEDevice *dev, IDEDriveKind kind)
     return 0;
 }
 
-static void ide_dev_get_bootindex(Object *obj, Visitor *v, void *opaque,
-                                  const char *name, Error **errp)
+static void ide_dev_get_bootindex(Object *obj, Visitor *v, const char *name,
+                                  void *opaque, Error **errp)
 {
     IDEDevice *d = IDE_DEVICE(obj);
 
     visit_type_int32(v, name, &d->conf.bootindex, errp);
 }
 
-static void ide_dev_set_bootindex(Object *obj, Visitor *v, void *opaque,
-                                  const char *name, Error **errp)
+static void ide_dev_set_bootindex(Object *obj, Visitor *v, const char *name,
+                                  void *opaque, Error **errp)
 {
     IDEDevice *d = IDE_DEVICE(obj);
     int32_t boot_index;
hw/intc/xics.c +6 -6
index 502c87f..ba7c40f 100644
@@ -88,8 +88,8 @@ static void xics_common_reset(DeviceState *d)
     device_reset(DEVICE(icp->ics));
 }
 
-static void xics_prop_get_nr_irqs(Object *obj, Visitor *v,
-                                  void *opaque, const char *name, Error **errp)
+static void xics_prop_get_nr_irqs(Object *obj, Visitor *v, const char *name,
+                                  void *opaque, Error **errp)
 {
     XICSState *icp = XICS_COMMON(obj);
     int64_t value = icp->nr_irqs;
@@ -97,8 +97,8 @@ static void xics_prop_get_nr_irqs(Object *obj, Visitor *v,
     visit_type_int(v, name, &value, errp);
 }
 
-static void xics_prop_set_nr_irqs(Object *obj, Visitor *v,
-                                  void *opaque, const char *name, Error **errp)
+static void xics_prop_set_nr_irqs(Object *obj, Visitor *v, const char *name,
+                                  void *opaque, Error **errp)
 {
     XICSState *icp = XICS_COMMON(obj);
     XICSStateClass *info = XICS_COMMON_GET_CLASS(icp);
@@ -122,7 +122,7 @@ static void xics_prop_set_nr_irqs(Object *obj, Visitor *v,
 }
 
 static void xics_prop_get_nr_servers(Object *obj, Visitor *v,
-                                     void *opaque, const char *name,
+                                     const char *name, void *opaque,
                                      Error **errp)
 {
     XICSState *icp = XICS_COMMON(obj);
@@ -132,7 +132,7 @@ static void xics_prop_get_nr_servers(Object *obj, Visitor *v,
 }
 
 static void xics_prop_set_nr_servers(Object *obj, Visitor *v,
-                                     void *opaque, const char *name,
+                                     const char *name, void *opaque,
                                      Error **errp)
 {
     XICSState *icp = XICS_COMMON(obj);
hw/isa/lpc_ich9.c +2 -3
index 358f707..b9ae1da 100644
@@ -569,9 +569,8 @@ Object *ich9_lpc_find(void)
     return o;
 }
 
-static void ich9_lpc_get_sci_int(Object *obj, Visitor *v,
-                                 void *opaque, const char *name,
-                                 Error **errp)
+static void ich9_lpc_get_sci_int(Object *obj, Visitor *v, const char *name,
+                                 void *opaque, Error **errp)
 {
     ICH9LPCState *lpc = ICH9_LPC_DEVICE(obj);
     uint32_t value = ich9_lpc_sci_irq(lpc);
hw/mem/pc-dimm.c +2 -2
index 123baeb..c52bf09 100644
@@ -372,8 +372,8 @@ static Property pc_dimm_properties[] = {
     DEFINE_PROP_END_OF_LIST(),
 };
 
-static void pc_dimm_get_size(Object *obj, Visitor *v, void *opaque,
-                          const char *name, Error **errp)
+static void pc_dimm_get_size(Object *obj, Visitor *v, const char *name,
+                             void *opaque, Error **errp)
 {
     int64_t value;
     MemoryRegion *mr;
hw/misc/edu.c +2 -2
index 4a3dc76..b6c83ce 100644
@@ -362,8 +362,8 @@ static void pci_edu_uninit(PCIDevice *pdev)
     timer_del(&edu->dma_timer);
 }
 
-static void edu_obj_uint64(Object *obj, Visitor *v, void *opaque,
-                           const char *name, Error **errp)
+static void edu_obj_uint64(Object *obj, Visitor *v, const char *name,
+                           void *opaque, Error **errp)
 {
     uint64_t *val = opaque;
 
hw/misc/tmp105.c +4 -4
index 1850315..a9ac524 100644
@@ -52,8 +52,8 @@ static void tmp105_alarm_update(TMP105State *s)
     tmp105_interrupt_update(s);
 }
 
-static void tmp105_get_temperature(Object *obj, Visitor *v, void *opaque,
-                                   const char *name, Error **errp)
+static void tmp105_get_temperature(Object *obj, Visitor *v, const char *name,
+                                   void *opaque, Error **errp)
 {
     TMP105State *s = TMP105(obj);
     int64_t value = s->temperature * 1000 / 256;
@@ -64,8 +64,8 @@ static void tmp105_get_temperature(Object *obj, Visitor *v, void *opaque,
 /* Units are 0.001 centigrades relative to 0 C.  s->temperature is 8.8
  * fixed point, so units are 1/256 centigrades.  A simple ratio will do.
  */
-static void tmp105_set_temperature(Object *obj, Visitor *v, void *opaque,
-                                   const char *name, Error **errp)
+static void tmp105_set_temperature(Object *obj, Visitor *v, const char *name,
+                                   void *opaque, Error **errp)
 {
     TMP105State *s = TMP105(obj);
     Error *local_err = NULL;
hw/net/ne2000-isa.c +6 -4
index 46ef304..630cab3 100644
@@ -93,8 +93,9 @@ static void isa_ne2000_class_initfn(ObjectClass *klass, void *data)
     set_bit(DEVICE_CATEGORY_NETWORK, dc->categories);
 }
 
-static void isa_ne2000_get_bootindex(Object *obj, Visitor *v, void *opaque,
-                                     const char *name, Error **errp)
+static void isa_ne2000_get_bootindex(Object *obj, Visitor *v,
+                                     const char *name, void *opaque,
+                                     Error **errp)
 {
     ISANE2000State *isa = ISA_NE2000(obj);
     NE2000State *s = &isa->ne2000;
@@ -102,8 +103,9 @@ static void isa_ne2000_get_bootindex(Object *obj, Visitor *v, void *opaque,
     visit_type_int32(v, name, &s->c.bootindex, errp);
 }
 
-static void isa_ne2000_set_bootindex(Object *obj, Visitor *v, void *opaque,
-                                     const char *name, Error **errp)
+static void isa_ne2000_set_bootindex(Object *obj, Visitor *v,
+                                     const char *name, void *opaque,
+                                     Error **errp)
 {
     ISANE2000State *isa = ISA_NE2000(obj);
     NE2000State *s = &isa->ne2000;
hw/pci-host/piix.c +5 -5
index dbae0aa..b5f59af 100644
@@ -215,7 +215,7 @@ static const VMStateDescription vmstate_i440fx = {
 };
 
 static void i440fx_pcihost_get_pci_hole_start(Object *obj, Visitor *v,
-                                              void *opaque, const char *name,
+                                              const char *name, void *opaque,
                                               Error **errp)
 {
     I440FXState *s = I440FX_PCI_HOST_BRIDGE(obj);
@@ -225,7 +225,7 @@ static void i440fx_pcihost_get_pci_hole_start(Object *obj, Visitor *v,
 }
 
 static void i440fx_pcihost_get_pci_hole_end(Object *obj, Visitor *v,
-                                            void *opaque, const char *name,
+                                            const char *name, void *opaque,
                                             Error **errp)
 {
     I440FXState *s = I440FX_PCI_HOST_BRIDGE(obj);
@@ -235,8 +235,8 @@ static void i440fx_pcihost_get_pci_hole_end(Object *obj, Visitor *v,
 }
 
 static void i440fx_pcihost_get_pci_hole64_start(Object *obj, Visitor *v,
-                                                void *opaque, const char *name,
-                                                Error **errp)
+                                                const char *name,
+                                                void *opaque, Error **errp)
 {
     PCIHostState *h = PCI_HOST_BRIDGE(obj);
     Range w64;
@@ -247,7 +247,7 @@ static void i440fx_pcihost_get_pci_hole64_start(Object *obj, Visitor *v,
 }
 
 static void i440fx_pcihost_get_pci_hole64_end(Object *obj, Visitor *v,
-                                              void *opaque, const char *name,
+                                              const char *name, void *opaque,
                                               Error **errp)
 {
     PCIHostState *h = PCI_HOST_BRIDGE(obj);
hw/pci-host/q35.c +6 -7
index 2b3608a..23b78cc 100644
@@ -67,7 +67,7 @@ static const char *q35_host_root_bus_path(PCIHostState *host_bridge,
 }
 
 static void q35_host_get_pci_hole_start(Object *obj, Visitor *v,
-                                        void *opaque, const char *name,
+                                        const char *name, void *opaque,
                                         Error **errp)
 {
     Q35PCIHost *s = Q35_HOST_DEVICE(obj);
@@ -77,7 +77,7 @@ static void q35_host_get_pci_hole_start(Object *obj, Visitor *v,
 }
 
 static void q35_host_get_pci_hole_end(Object *obj, Visitor *v,
-                                      void *opaque, const char *name,
+                                      const char *name, void *opaque,
                                       Error **errp)
 {
     Q35PCIHost *s = Q35_HOST_DEVICE(obj);
@@ -87,7 +87,7 @@ static void q35_host_get_pci_hole_end(Object *obj, Visitor *v,
 }
 
 static void q35_host_get_pci_hole64_start(Object *obj, Visitor *v,
-                                          void *opaque, const char *name,
+                                          const char *name, void *opaque,
                                           Error **errp)
 {
     PCIHostState *h = PCI_HOST_BRIDGE(obj);
@@ -99,7 +99,7 @@ static void q35_host_get_pci_hole64_start(Object *obj, Visitor *v,
 }
 
 static void q35_host_get_pci_hole64_end(Object *obj, Visitor *v,
-                                        void *opaque, const char *name,
+                                        const char *name, void *opaque,
                                         Error **errp)
 {
     PCIHostState *h = PCI_HOST_BRIDGE(obj);
@@ -110,9 +110,8 @@ static void q35_host_get_pci_hole64_end(Object *obj, Visitor *v,
     visit_type_uint64(v, name, &w64.end, errp);
 }
 
-static void q35_host_get_mmcfg_size(Object *obj, Visitor *v,
-                                    void *opaque, const char *name,
-                                    Error **errp)
+static void q35_host_get_mmcfg_size(Object *obj, Visitor *v, const char *name,
+                                    void *opaque, Error **errp)
 {
     PCIExpressHost *e = PCIE_HOST_BRIDGE(obj);
     uint32_t value = e->size;
hw/ppc/spapr_drc.c +8 -8
index 9c8fbe8..9ef603b 100644
@@ -214,8 +214,8 @@ static uint32_t entity_sense(sPAPRDRConnector *drc, sPAPRDREntitySense *state)
     return RTAS_OUT_SUCCESS;
 }
 
-static void prop_get_index(Object *obj, Visitor *v, void *opaque,
-                                  const char *name, Error **errp)
+static void prop_get_index(Object *obj, Visitor *v, const char *name,
+                           void *opaque, Error **errp)
 {
     sPAPRDRConnector *drc = SPAPR_DR_CONNECTOR(obj);
     sPAPRDRConnectorClass *drck = SPAPR_DR_CONNECTOR_GET_CLASS(drc);
@@ -223,8 +223,8 @@ static void prop_get_index(Object *obj, Visitor *v, void *opaque,
     visit_type_uint32(v, name, &value, errp);
 }
 
-static void prop_get_type(Object *obj, Visitor *v, void *opaque,
-                          const char *name, Error **errp)
+static void prop_get_type(Object *obj, Visitor *v, const char *name,
+                          void *opaque, Error **errp)
 {
     sPAPRDRConnector *drc = SPAPR_DR_CONNECTOR(obj);
     sPAPRDRConnectorClass *drck = SPAPR_DR_CONNECTOR_GET_CLASS(drc);
@@ -239,8 +239,8 @@ static char *prop_get_name(Object *obj, Error **errp)
     return g_strdup(drck->get_name(drc));
 }
 
-static void prop_get_entity_sense(Object *obj, Visitor *v, void *opaque,
-                                  const char *name, Error **errp)
+static void prop_get_entity_sense(Object *obj, Visitor *v, const char *name,
+                                  void *opaque, Error **errp)
 {
     sPAPRDRConnector *drc = SPAPR_DR_CONNECTOR(obj);
     sPAPRDRConnectorClass *drck = SPAPR_DR_CONNECTOR_GET_CLASS(drc);
@@ -250,8 +250,8 @@ static void prop_get_entity_sense(Object *obj, Visitor *v, void *opaque,
     visit_type_uint32(v, name, &value, errp);
 }
 
-static void prop_get_fdt(Object *obj, Visitor *v, void *opaque,
-                        const char *name, Error **errp)
+static void prop_get_fdt(Object *obj, Visitor *v, const char *name,
+                         void *opaque, Error **errp)
 {
     sPAPRDRConnector *drc = SPAPR_DR_CONNECTOR(obj);
     Error *err = NULL;
hw/usb/dev-storage.c +4 -4
index 3261446..e743551 100644
@@ -780,8 +780,8 @@ static void usb_msd_class_initfn_storage(ObjectClass *klass, void *data)
     dc->props = msd_properties;
 }
 
-static void usb_msd_get_bootindex(Object *obj, Visitor *v, void *opaque,
-                                  const char *name, Error **errp)
+static void usb_msd_get_bootindex(Object *obj, Visitor *v, const char *name,
+                                  void *opaque, Error **errp)
 {
     USBDevice *dev = USB_DEVICE(obj);
     MSDState *s = USB_STORAGE_DEV(dev);
@@ -789,8 +789,8 @@ static void usb_msd_get_bootindex(Object *obj, Visitor *v, void *opaque,
     visit_type_int32(v, name, &s->conf.bootindex, errp);
 }
 
-static void usb_msd_set_bootindex(Object *obj, Visitor *v, void *opaque,
-                                  const char *name, Error **errp)
+static void usb_msd_set_bootindex(Object *obj, Visitor *v, const char *name,
+                                  void *opaque, Error **errp)
 {
     USBDevice *dev = USB_DEVICE(obj);
     MSDState *s = USB_STORAGE_DEV(dev);
hw/virtio/virtio-balloon.c +4 -4
index 1d81a34..dc44088 100644
@@ -110,8 +110,8 @@ static void balloon_stats_poll_cb(void *opaque)
     virtio_notify(vdev, s->svq);
 }
 
-static void balloon_stats_get_all(Object *obj, Visitor *v,
-                                  void *opaque, const char *name, Error **errp)
+static void balloon_stats_get_all(Object *obj, Visitor *v, const char *name,
+                                  void *opaque, Error **errp)
 {
     Error *err = NULL;
     VirtIOBalloon *s = opaque;
@@ -150,7 +150,7 @@ out:
 }
 
 static void balloon_stats_get_poll_interval(Object *obj, Visitor *v,
-                                            void *opaque, const char *name,
+                                            const char *name, void *opaque,
                                             Error **errp)
 {
     VirtIOBalloon *s = opaque;
@@ -158,7 +158,7 @@ static void balloon_stats_get_poll_interval(Object *obj, Visitor *v,
 }
 
 static void balloon_stats_set_poll_interval(Object *obj, Visitor *v,
-                                            void *opaque, const char *name,
+                                            const char *name, void *opaque,
                                             Error **errp)
 {
     VirtIOBalloon *s = opaque;
include/qom/object.h +2 -2
index 3e7e99d..698827d 100644
@@ -290,16 +290,16 @@ typedef struct InterfaceInfo InterfaceInfo;
  * ObjectPropertyAccessor:
  * @obj: the object that owns the property
  * @v: the visitor that contains the property data
+ * @name: the name of the property
  * @opaque: the object property opaque
- * @name: the name of the property
  * @errp: a pointer to an Error that is filled if getting/setting fails.
  *
  * Called when trying to get/set a property.
  */
 typedef void (ObjectPropertyAccessor)(Object *obj,
                                       Visitor *v,
-                                      void *opaque,
                                       const char *name,
+                                      void *opaque,
                                       Error **errp);
 
 /**
memory.c +10 -8
index 49eb809..fc58f1c 100644
@@ -928,8 +928,8 @@ void memory_region_init(MemoryRegion *mr,
     }
 }
 
-static void memory_region_get_addr(Object *obj, Visitor *v, void *opaque,
-                                   const char *name, Error **errp)
+static void memory_region_get_addr(Object *obj, Visitor *v, const char *name,
+                                   void *opaque, Error **errp)
 {
     MemoryRegion *mr = MEMORY_REGION(obj);
     uint64_t value = mr->addr;
@@ -937,8 +937,9 @@ static void memory_region_get_addr(Object *obj, Visitor *v, void *opaque,
     visit_type_uint64(v, name, &value, errp);
 }
 
-static void memory_region_get_container(Object *obj, Visitor *v, void *opaque,
-                                        const char *name, Error **errp)
+static void memory_region_get_container(Object *obj, Visitor *v,
+                                        const char *name, void *opaque,
+                                        Error **errp)
 {
     MemoryRegion *mr = MEMORY_REGION(obj);
     gchar *path = (gchar *)"";
@@ -960,8 +961,9 @@ static Object *memory_region_resolve_container(Object *obj, void *opaque,
     return OBJECT(mr->container);
 }
 
-static void memory_region_get_priority(Object *obj, Visitor *v, void *opaque,
-                                       const char *name, Error **errp)
+static void memory_region_get_priority(Object *obj, Visitor *v,
+                                       const char *name, void *opaque,
+                                       Error **errp)
 {
     MemoryRegion *mr = MEMORY_REGION(obj);
     int32_t value = mr->priority;
@@ -976,8 +978,8 @@ static bool memory_region_get_may_overlap(Object *obj, Error **errp)
     return mr->may_overlap;
 }
 
-static void memory_region_get_size(Object *obj, Visitor *v, void *opaque,
-                                   const char *name, Error **errp)
+static void memory_region_get_size(Object *obj, Visitor *v, const char *name,
+                                   void *opaque, Error **errp)
 {
     MemoryRegion *mr = MEMORY_REGION(obj);
     uint64_t value = memory_region_size(mr);
net/dump.c +4 -4
index 0aac9b8..760a12d 100644
@@ -271,8 +271,8 @@ static void filter_dump_setup(NetFilterState *nf, Error **errp)
     net_dump_state_init(&nfds->ds, nfds->filename, nfds->maxlen, errp);
 }
 
-static void filter_dump_get_maxlen(Object *obj, Visitor *v, void *opaque,
-                                   const char *name, Error **errp)
+static void filter_dump_get_maxlen(Object *obj, Visitor *v, const char *name,
+                                   void *opaque, Error **errp)
 {
     NetFilterDumpState *nfds = FILTER_DUMP(obj);
     uint32_t value = nfds->maxlen;
@@ -280,8 +280,8 @@ static void filter_dump_get_maxlen(Object *obj, Visitor *v, void *opaque,
     visit_type_uint32(v, name, &value, errp);
 }
 
-static void filter_dump_set_maxlen(Object *obj, Visitor *v, void *opaque,
-                                   const char *name, Error **errp)
+static void filter_dump_set_maxlen(Object *obj, Visitor *v, const char *name,
+                                   void *opaque, Error **errp)
 {
     NetFilterDumpState *nfds = FILTER_DUMP(obj);
     Error *local_err = NULL;
net/filter-buffer.c +6 -4
index 3173d26..570d342 100644
@@ -132,8 +132,9 @@ static void filter_buffer_class_init(ObjectClass *oc, void *data)
     nfc->receive_iov = filter_buffer_receive_iov;
 }
 
-static void filter_buffer_get_interval(Object *obj, Visitor *v, void *opaque,
-                                       const char *name, Error **errp)
+static void filter_buffer_get_interval(Object *obj, Visitor *v,
+                                       const char *name, void *opaque,
+                                       Error **errp)
 {
     FilterBufferState *s = FILTER_BUFFER(obj);
     uint32_t value = s->interval;
@@ -141,8 +142,9 @@ static void filter_buffer_get_interval(Object *obj, Visitor *v, void *opaque,
     visit_type_uint32(v, name, &value, errp);
 }
 
-static void filter_buffer_set_interval(Object *obj, Visitor *v, void *opaque,
-                                       const char *name, Error **errp)
+static void filter_buffer_set_interval(Object *obj, Visitor *v,
+                                       const char *name, void *opaque,
+                                       Error **errp)
 {
     FilterBufferState *s = FILTER_BUFFER(obj);
     Error *local_err = NULL;
qom/object.c +37 -38

180 lines not on this page · raw message

target-i386/cpu.c +33 -33

156 lines not on this page · raw message

target-ppc/translate_init.c +4 -4
index 9d7936b..d36b627 100644
@@ -8034,8 +8034,8 @@ POWERPC_FAMILY(POWER5P)(ObjectClass *oc, void *data)
     pcc->l1_icache_size = 0x10000;
 }
 
-static void powerpc_get_compat(Object *obj, Visitor *v,
-                               void *opaque, const char *name, Error **errp)
+static void powerpc_get_compat(Object *obj, Visitor *v, const char *name,
+                               void *opaque, Error **errp)
 {
     char *value = (char *)"";
     Property *prop = opaque;
@@ -8062,8 +8062,8 @@ static void powerpc_get_compat(Object *obj, Visitor *v,
     visit_type_str(v, name, &value, errp);
 }
 
-static void powerpc_set_compat(Object *obj, Visitor *v,
-                               void *opaque, const char *name, Error **errp)
+static void powerpc_set_compat(Object *obj, Visitor *v, const char *name,
+                               void *opaque, Error **errp)
 {
     Error *error = NULL;
     char *value = NULL;
tests/test-qdev-global-props.c +4 -10
index e728611..07c1823 100644
@@ -116,22 +116,16 @@ static void test_static_globalprop(void)
 #define TYPE_UNUSED_HOTPLUG   "hotplug-type"
 #define TYPE_UNUSED_NOHOTPLUG "nohotplug-type"
 
-static void prop1_accessor(Object *obj,
-                           Visitor *v,
-                           void *opaque,
-                           const char *name,
-                           Error **errp)
+static void prop1_accessor(Object *obj, Visitor *v, const char *name,
+                           void *opaque, Error **errp)
 {
     MyType *mt = DYNAMIC_TYPE(obj);
 
     visit_type_uint32(v, name, &mt->prop1, errp);
 }
 
-static void prop2_accessor(Object *obj,
-                           Visitor *v,
-                           void *opaque,
-                           const char *name,
-                           Error **errp)
+static void prop2_accessor(Object *obj, Visitor *v, const char *name,
+                           void *opaque, Error **errp)
 {
     MyType *mt = DYNAMIC_TYPE(obj);
 
Signature · 1 line
2.5.0
#49 lore raw

Re: [Qemu-devel] [PATCH v9 15/37] qom: Swap 'name' next to visitor in ObjectPropertyAccessor

Quoted 9 lines · Eric Blake

Similar to the previous patch, it's nice to have all functions in the tree that involve a visitor and a name for conversion to or from QAPI to consistently stick the 'name' parameter next to the Visitor parameter.

Done by manually changing include/qom/object.h and qom/object.c, then running this Coccinelle script and touching up the fallout (Coccinelle insisted on adding some trailing whitespace).

Quoted 9 lines
    @ rule1 @
    identifier fn;
    type Object, Visitor, Error;
    identifier obj, v, opaque, name, errp;
    @@
     void fn
    - (Object *obj, Visitor *v, void *opaque, const char *name,
    + (Object *obj, Visitor *v, const char *name, void *opaque,
       Error **errp) { ... }

I think we want to match void functions with exactly these parameter types. The parameter names don't matter.

However, the actual match is looser! For instance, it also matches

    void foo(int *pi, unsigned *pu, void *vp, const char *cp, double **dpp)
    {
    }

This could mess up unrelated function. I could double-check it doesn't, but I'd rather have a narrower match instead. Can't give one offhand, though. Ideas?

Quoted 9 lines
    @@
    identifier rule1.fn;
    expression obj, v, opaque, name, errp;
    @@
     fn(obj, v,
    -   opaque, name,
    +   name, opaque,
        errp)

The rule1.fn restricts the match to functions changed by the previous rule. Good.

Quoted 3 lines
author
#50 lore raw

Re: [Qemu-devel] [PATCH v9 15/37] qom: Swap 'name' next to visitor in ObjectPropertyAccessor

Quoted 21 lines · Markus Armbruster
Quoted 9 lines · Eric Blake

Similar to the previous patch, it's nice to have all functions in the tree that involve a visitor and a name for conversion to or from QAPI to consistently stick the 'name' parameter next to the Visitor parameter.

Done by manually changing include/qom/object.h and qom/object.c, then running this Coccinelle script and touching up the fallout (Coccinelle insisted on adding some trailing whitespace).

Quoted 9 lines
    @ rule1 @
    identifier fn;
    type Object, Visitor, Error;
    identifier obj, v, opaque, name, errp;
    @@
     void fn
    - (Object *obj, Visitor *v, void *opaque, const char *name,
    + (Object *obj, Visitor *v, const char *name, void *opaque,
       Error **errp) { ... }
Quoted 2 lines

I think we want to match void functions with exactly these parameter types. The parameter names don't matter.

The parameter names shouldn't matter; the 'identifier obj' should have been enough to make 'obj' a metavariable matching any actual parameter name.

Quoted 6 lines

However, the actual match is looser! For instance, it also matches

    void foo(int *pi, unsigned *pu, void *vp, const char *cp, double **dpp)
    {
    }

Uggh. My intent was to match exactly 'Object *' and 'Visitor *' as the first two types, where 'int *' and 'unsigned *' are NOT matches. But I don't know Coccinelle well enough to make that blatantly obvious (is my declaration of 'type Object' not correct?).

Quoted 4 lines

This could mess up unrelated function. I could double-check it doesn't, but I'd rather have a narrower match instead. Can't give one offhand, though. Ideas?

Is 'typedef' better than 'type' for constraining the type of the first two arguments? Or does Coccinelle do literal matches on anything you don't pre-declare, as in:

     @ rule1 @
     identifier fn;
     identifier obj, v, opaque, name, errp;
     @@
      void fn
     - (Object *obj, Visitor *v, void *opaque, const char *name,
     + (Object *obj, Visitor *v, const char *name, void *opaque,
        Error **errp) { ... }

Fortunately, a manual inspection of the results (which I had to do anyways due to spacing issues) didn't spot any incorrect swaps.

At this point, I don't know that re-writing Coccinelle will be worth the hassle (nothing else needs to be rewritten).

Quoted 18 lines
Quoted 10 lines

    @@
    identifier rule1.fn;
    expression obj, v, opaque, name, errp;
    @@
     fn(obj, v,
    -   opaque, name,
    +   name, opaque,
        errp)

The rule1.fn restricts the match to functions changed by the previous rule. Good.

Quoted 3 lines
Signature · 2 lines
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org
#51 lore raw

Re: [Qemu-devel] [PATCH v9 15/37] qom: Swap 'name' next to visitor in ObjectPropertyAccessor

Quoted 31 lines · Eric Blake
Quoted 21 lines · Markus Armbruster
Quoted 9 lines · Eric Blake

Similar to the previous patch, it's nice to have all functions in the tree that involve a visitor and a name for conversion to or from QAPI to consistently stick the 'name' parameter next to the Visitor parameter.

Done by manually changing include/qom/object.h and qom/object.c, then running this Coccinelle script and touching up the fallout (Coccinelle insisted on adding some trailing whitespace).

Quoted 9 lines
    @ rule1 @
    identifier fn;
    type Object, Visitor, Error;
    identifier obj, v, opaque, name, errp;
    @@
     void fn
    - (Object *obj, Visitor *v, void *opaque, const char *name,
    + (Object *obj, Visitor *v, const char *name, void *opaque,
       Error **errp) { ... }
Quoted 2 lines

I think we want to match void functions with exactly these parameter types. The parameter names don't matter.

The parameter names shouldn't matter; the 'identifier obj' should have been enough to make 'obj' a metavariable matching any actual parameter name.

Quoted 3 lines

However, the actual match is looser! For instance, it also matches

Quoted 8 lines
Quoted 3 lines
    void foo(int *pi, unsigned *pu, void *vp, const char *cp, double **dpp)
    {
    }

Uggh. My intent was to match exactly 'Object *' and 'Visitor *' as the first two types, where 'int *' and 'unsigned *' are NOT matches. But I don't know Coccinelle well enough to make that blatantly obvious (is my declaration of 'type Object' not correct?).

'type Object' makes 'Object' a metavariable matching any C type.

Quoted 6 lines
Quoted 3 lines

This could mess up unrelated function. I could double-check it doesn't, but I'd rather have a narrower match instead. Can't give one offhand, though. Ideas?

Is 'typedef' better than 'type' for constraining the type of the first two arguments?

Matches any C typedef name. Less wrong, but still wrong :)

Quoted 2 lines

Or does Coccinelle do literal matches on anything you
don't pre-declare, as in:

Yes, but...

Quoted 8 lines
     @ rule1 @
     identifier fn;
     identifier obj, v, opaque, name, errp;
     @@
      void fn
     - (Object *obj, Visitor *v, void *opaque, const char *name,
     + (Object *obj, Visitor *v, const char *name, void *opaque,
        Error **errp) { ... }

... when I try that, spatch throws a parse error.

Quoted 5 lines

Fortunately, a manual inspection of the results (which I had to do anyways due to spacing issues) didn't spot any incorrect swaps.

At this point, I don't know that re-writing Coccinelle will be worth the hassle (nothing else needs to be rewritten).

I'd normally take up the challenge to wrestle Coccinelle, but I think our time is better spent elsewhere right now. Let's amend the commit message instead: describe the semantic patch's shortcomings, and your manual checking:

This semantic patch is actually far too lose: it matches *any* type, not just Object, Visitor, Error. However, I can't figure out how to make Coccinelle match Object, Visitor, Error exactly. Simply deleting the 'type Object, Visitor, Error;' line results in a parse error. I reviewed the resulting patch carefully to verify there are no unwanted matches.

Quoted 16 lines
Quoted 16 lines
Quoted 8 lines
    @@
    identifier rule1.fn;
    expression obj, v, opaque, name, errp;
    @@
     fn(obj, v,
    -   opaque, name,
    +   name, opaque,
        errp)

The rule1.fn restricts the match to functions changed by the previous rule. Good.

Quoted 3 lines
#52 lore raw

Re: [Qemu-devel] [PATCH v9 15/37] qom: Swap 'name' next to visitor in ObjectPropertyAccessor

Am 21.01.2016 um 10:18 hat Markus Armbruster geschrieben:

Quoted 10 lines
Quoted 9 lines · Eric Blake
Quoted 7 lines · Markus Armbruster

Eric Blake <[email protected]> writes:

However, the actual match is looser! For instance, it also matches

    void foo(int *pi, unsigned *pu, void *vp, const char *cp, double **dpp)
    {
    }
Quoted 6 lines
Quoted 4 lines

Uggh. My intent was to match exactly 'Object *' and 'Visitor *' as the first two types, where 'int *' and 'unsigned *' are NOT matches. But I don't know Coccinelle well enough to make that blatantly obvious (is my declaration of 'type Object' not correct?).

'type Object' makes 'Object' a metavariable matching any C type.

I can't say anything on this one, because I've never used 'type'. You may or may not be right. However...

Quoted 8 lines
Quoted 6 lines
Quoted 3 lines

This could mess up unrelated function. I could double-check it doesn't, but I'd rather have a narrower match instead. Can't give one offhand, though. Ideas?

Is 'typedef' better than 'type' for constraining the type of the first two arguments?

Matches any C typedef name. Less wrong, but still wrong :)

...I'm pretty sure that this is wrong and 'typedef' only declares that a specific type exists as a typedef.

Quoted 14 lines
Quoted 2 lines

Or does Coccinelle do literal matches on anything you
don't pre-declare, as in:

Yes, but...

Quoted 8 lines
     @ rule1 @
     identifier fn;
     identifier obj, v, opaque, name, errp;
     @@
      void fn
     - (Object *obj, Visitor *v, void *opaque, const char *name,
     + (Object *obj, Visitor *v, const char *name, void *opaque,
        Error **errp) { ... }
Quoted 1 line

... when I try that, spatch throws a parse error.

Because you need to declare the typedef. :-)

I had a similar problem and asked Julia about it at KVM Forum, so I'm pretty sure that it's right.

Kevin

#53 lore raw

Re: [Qemu-devel] [PATCH v9 15/37] qom: Swap 'name' next to visitor in ObjectPropertyAccessor

Quoted 25 lines · Kevin Wolf

Am 21.01.2016 um 10:18 hat Markus Armbruster geschrieben:

Quoted 10 lines
Quoted 9 lines · Eric Blake
Quoted 7 lines · Markus Armbruster

Eric Blake <[email protected]> writes:

However, the actual match is looser! For instance, it also matches

    void foo(int *pi, unsigned *pu, void *vp, const char *cp, double **dpp)
    {
    }
Quoted 6 lines
Quoted 4 lines

Uggh. My intent was to match exactly 'Object *' and 'Visitor *' as the first two types, where 'int *' and 'unsigned *' are NOT matches. But I don't know Coccinelle well enough to make that blatantly obvious (is my declaration of 'type Object' not correct?).

'type Object' makes 'Object' a metavariable matching any C type.

I can't say anything on this one, because I've never used 'type'. You may or may not be right. However...

Quoted 4 lines
Quoted 4 lines
Quoted 3 lines

This could mess up unrelated function. I could double-check it doesn't, but I'd rather have a narrower match instead. Can't give one offhand, though. Ideas?

Quoted 7 lines
Quoted 4 lines
Quoted 2 lines

Is 'typedef' better than 'type' for constraining the type of the first two arguments?

Matches any C typedef name. Less wrong, but still wrong :)

...I'm pretty sure that this is wrong and 'typedef' only declares that a specific type exists as a typedef.

Coccinelle's documentation is awfully terse. Looks like I jumped to conclusions.

Quoted 14 lines
Quoted 14 lines
Quoted 2 lines

Or does Coccinelle do literal matches on anything you
don't pre-declare, as in:

Yes, but...

Quoted 8 lines
     @ rule1 @
     identifier fn;
     identifier obj, v, opaque, name, errp;
     @@
      void fn
     - (Object *obj, Visitor *v, void *opaque, const char *name,
     + (Object *obj, Visitor *v, const char *name, void *opaque,
        Error **errp) { ... }
Quoted 6 lines
Quoted 1 line

... when I try that, spatch throws a parse error.

Because you need to declare the typedef. :-)

I had a similar problem and asked Julia about it at KVM Forum, so I'm pretty sure that it's right.

If I replace 'type' by 'typedef', spatch no longer messes up

void foo(int *pi, unsigned *pu, void *vp, const char *cp, double **dpp)

but still rewrites

void bar(Object *o, Visitor *v, void *opq, const char *n, Error **ep)

Thanks, Kevin!

Eric, could you try to regenerate your patch with the corrected script?

author
#54 lore raw

PATCH v9 16/37 qapi: Swap 'name' in visit_* callbacks to match public API

In reply to Eric Blake

As explained in the previous patches, matching argument order of 'name, &value' to JSON's "name":value makes sense. However, while the last two patches were easy with Coccinelle, I ended up doing this one all by hand. Now all the visitor callbacks match the main interface.

---
v9: no change
v8: new patch

---
 include/qapi/visitor-impl.h  | 39 +++++++++++++++++++++------------------
 qapi/opts-visitor.c          | 16 ++++++++--------
 qapi/qapi-dealloc-visitor.c  | 25 ++++++++++++-------------
 qapi/qapi-visit-core.c       | 38 +++++++++++++++++++-------------------
 qapi/qmp-input-visitor.c     | 22 +++++++++++-----------
 qapi/qmp-output-visitor.c    | 16 ++++++++--------
 qapi/string-input-visitor.c  | 16 ++++++++--------
 qapi/string-output-visitor.c | 16 ++++++++--------
 8 files changed, 95 insertions(+), 93 deletions(-)
include/qapi/visitor-impl.h +21 -18
index e6399d1..0257359 100644
@@ -18,8 +18,8 @@
 struct Visitor
 {
     /* Must be set */
-    void (*start_struct)(Visitor *v, void **obj, const char *kind,
-                         const char *name, size_t size, Error **errp);
+    void (*start_struct)(Visitor *v, const char *name, void **obj,
+                         const char *kind, size_t size, Error **errp);
     void (*end_struct)(Visitor *v, Error **errp);
 
     void (*start_implicit_struct)(Visitor *v, void **obj, size_t size,
@@ -30,39 +30,42 @@ struct Visitor
     GenericList *(*next_list)(Visitor *v, GenericList **list, Error **errp);
     void (*end_list)(Visitor *v, Error **errp);
 
-    void (*type_enum)(Visitor *v, int *obj, const char * const strings[],
-                      const char *kind, const char *name, Error **errp);
+    void (*type_enum)(Visitor *v, const char *name, int *obj,
+                      const char * const strings[], const char *kind,
+                      Error **errp);
     /* May be NULL; only needed for input visitors. */
-    void (*get_next_type)(Visitor *v, QType *type, bool promote_int,
-                          const char *name, Error **errp);
+    void (*get_next_type)(Visitor *v, const char *name, QType *type,
+                          bool promote_int, Error **errp);
 
     /* Must be set. */
-    void (*type_int64)(Visitor *v, int64_t *obj, const char *name,
+    void (*type_int64)(Visitor *v, const char *name, int64_t *obj,
                        Error **errp);
     /* Must be set. */
-    void (*type_uint64)(Visitor *v, uint64_t *obj, const char *name,
+    void (*type_uint64)(Visitor *v, const char *name, uint64_t *obj,
                         Error **errp);
     /* Optional; fallback is type_uint64().  */
-    void (*type_size)(Visitor *v, uint64_t *obj, const char *name,
+    void (*type_size)(Visitor *v, const char *name, uint64_t *obj,
                       Error **errp);
     /* Must be set. */
-    void (*type_bool)(Visitor *v, bool *obj, const char *name, Error **errp);
-    void (*type_str)(Visitor *v, char **obj, const char *name, Error **errp);
-    void (*type_number)(Visitor *v, double *obj, const char *name,
+    void (*type_bool)(Visitor *v, const char *name, bool *obj, Error **errp);
+    void (*type_str)(Visitor *v, const char *name, char **obj, Error **errp);
+    void (*type_number)(Visitor *v, const char *name, double *obj,
                         Error **errp);
-    void (*type_any)(Visitor *v, QObject **obj, const char *name,
+    void (*type_any)(Visitor *v, const char *name, QObject **obj,
                      Error **errp);
 
     /* May be NULL; most useful for input visitors. */
-    void (*optional)(Visitor *v, bool *present, const char *name);
+    void (*optional)(Visitor *v, const char *name, bool *present);
 
     bool (*start_union)(Visitor *v, bool data_present, Error **errp);
     void (*end_union)(Visitor *v, bool data_present, Error **errp);
 };
 
-void input_type_enum(Visitor *v, int *obj, const char * const strings[],
-                     const char *kind, const char *name, Error **errp);
-void output_type_enum(Visitor *v, int *obj, const char * const strings[],
-                      const char *kind, const char *name, Error **errp);
+void input_type_enum(Visitor *v, const char *name, int *obj,
+                     const char * const strings[], const char *kind,
+                     Error **errp);
+void output_type_enum(Visitor *v, const char *name, int *obj,
+                      const char * const strings[], const char *kind,
+                      Error **errp);
 
 #endif
qapi/opts-visitor.c +8 -8
index 56c798f..b1c8e50 100644
@@ -124,8 +124,8 @@ opts_visitor_insert(GHashTable *unprocessed_opts, const QemuOpt *opt)
 
 
 static void
-opts_start_struct(Visitor *v, void **obj, const char *kind,
-                  const char *name, size_t size, Error **errp)
+opts_start_struct(Visitor *v, const char *name, void **obj, const char *kind,
+                  size_t size, Error **errp)
 {
     OptsVisitor *ov = to_ov(v);
     const QemuOpt *opt;
@@ -311,7 +311,7 @@ processed(OptsVisitor *ov, const char *name)
 
 
 static void
-opts_type_str(Visitor *v, char **obj, const char *name, Error **errp)
+opts_type_str(Visitor *v, const char *name, char **obj, Error **errp)
 {
     OptsVisitor *ov = to_ov(v);
     const QemuOpt *opt;
@@ -327,7 +327,7 @@ opts_type_str(Visitor *v, char **obj, const char *name, Error **errp)
 
 /* mimics qemu-option.c::parse_option_bool() */
 static void
-opts_type_bool(Visitor *v, bool *obj, const char *name, Error **errp)
+opts_type_bool(Visitor *v, const char *name, bool *obj, Error **errp)
 {
     OptsVisitor *ov = to_ov(v);
     const QemuOpt *opt;
@@ -360,7 +360,7 @@ opts_type_bool(Visitor *v, bool *obj, const char *name, Error **errp)
 
 
 static void
-opts_type_int64(Visitor *v, int64_t *obj, const char *name, Error **errp)
+opts_type_int64(Visitor *v, const char *name, int64_t *obj, Error **errp)
 {
     OptsVisitor *ov = to_ov(v);
     const QemuOpt *opt;
@@ -416,7 +416,7 @@ opts_type_int64(Visitor *v, int64_t *obj, const char *name, Error **errp)
 
 
 static void
-opts_type_uint64(Visitor *v, uint64_t *obj, const char *name, Error **errp)
+opts_type_uint64(Visitor *v, const char *name, uint64_t *obj, Error **errp)
 {
     OptsVisitor *ov = to_ov(v);
     const QemuOpt *opt;
@@ -468,7 +468,7 @@ opts_type_uint64(Visitor *v, uint64_t *obj, const char *name, Error **errp)
 
 
 static void
-opts_type_size(Visitor *v, uint64_t *obj, const char *name, Error **errp)
+opts_type_size(Visitor *v, const char *name, uint64_t *obj, Error **errp)
 {
     OptsVisitor *ov = to_ov(v);
     const QemuOpt *opt;
@@ -494,7 +494,7 @@ opts_type_size(Visitor *v, uint64_t *obj, const char *name, Error **errp)
 
 
 static void
-opts_optional(Visitor *v, bool *present, const char *name)
+opts_optional(Visitor *v, const char *name, bool *present)
 {
     OptsVisitor *ov = to_ov(v);
 
qapi/qapi-dealloc-visitor.c +12 -13
index 11eb828..b521f7c 100644
@@ -58,8 +58,8 @@ static void *qapi_dealloc_pop(QapiDeallocVisitor *qov)
     return value;
 }
 
-static void qapi_dealloc_start_struct(Visitor *v, void **obj, const char *kind,
-                                      const char *name, size_t unused,
+static void qapi_dealloc_start_struct(Visitor *v, const char *name, void **obj,
+                                      const char *kind, size_t unused,
                                       Error **errp)
 {
     QapiDeallocVisitor *qov = to_qov(v);
@@ -127,7 +127,7 @@ static void qapi_dealloc_end_list(Visitor *v, Error **errp)
     assert(obj == NULL); /* should've been list head tracker with no payload */
 }
 
-static void qapi_dealloc_type_str(Visitor *v, char **obj, const char *name,
+static void qapi_dealloc_type_str(Visitor *v, const char *name, char **obj,
                                   Error **errp)
 {
     if (obj) {
@@ -135,38 +135,37 @@ static void qapi_dealloc_type_str(Visitor *v, char **obj, const char *name,
     }
 }
 
-static void qapi_dealloc_type_int64(Visitor *v, int64_t *obj, const char *name,
+static void qapi_dealloc_type_int64(Visitor *v, const char *name, int64_t *obj,
                                     Error **errp)
 {
 }
 
-static void qapi_dealloc_type_uint64(Visitor *v, uint64_t *obj,
-                                     const char *name, Error **errp)
+static void qapi_dealloc_type_uint64(Visitor *v, const char *name,
+                                     uint64_t *obj, Error **errp)
 {
 }
 
-static void qapi_dealloc_type_bool(Visitor *v, bool *obj, const char *name,
+static void qapi_dealloc_type_bool(Visitor *v, const char *name, bool *obj,
                                    Error **errp)
 {
 }
 
-static void qapi_dealloc_type_number(Visitor *v, double *obj, const char *name,
+static void qapi_dealloc_type_number(Visitor *v, const char *name, double *obj,
                                      Error **errp)
 {
 }
 
-static void qapi_dealloc_type_anything(Visitor *v, QObject **obj,
-                                       const char *name, Error **errp)
+static void qapi_dealloc_type_anything(Visitor *v, const char *name,
+                                       QObject **obj, Error **errp)
 {
     if (obj) {
         qobject_decref(*obj);
     }
 }
 
-static void qapi_dealloc_type_enum(Visitor *v, int *obj,
+static void qapi_dealloc_type_enum(Visitor *v, const char *name, int *obj,
                                    const char * const strings[],
-                                   const char *kind, const char *name,
-                                   Error **errp)
+                                   const char *kind, Error **errp)
 {
 }
 
qapi/qapi-visit-core.c +19 -19
index 609db22..7bc3de6 100644
@@ -20,7 +20,7 @@
 void visit_start_struct(Visitor *v, const char *name, void **obj,
                         const char *kind, size_t size, Error **errp)
 {
-    v->start_struct(v, obj, kind, name, size, errp);
+    v->start_struct(v, name, obj, kind, size, errp);
 }
 
 void visit_end_struct(Visitor *v, Error **errp)
@@ -76,7 +76,7 @@ void visit_end_union(Visitor *v, bool data_present, Error **errp)
 bool visit_optional(Visitor *v, const char *name, bool *present)
 {
     if (v->optional) {
-        v->optional(v, present, name);
+        v->optional(v, name, present);
     }
     return *present;
 }
@@ -85,7 +85,7 @@ void visit_get_next_type(Visitor *v, const char *name, QType *type,
                          bool promote_int, Error **errp)
 {
     if (v->get_next_type) {
-        v->get_next_type(v, type, promote_int, name, errp);
+        v->get_next_type(v, name, type, promote_int, errp);
     }
 }
 
@@ -93,12 +93,12 @@ void visit_type_enum(Visitor *v, const char *name, int *obj,
                      const char *const strings[], const char *kind,
                      Error **errp)
 {
-    v->type_enum(v, obj, strings, kind, name, errp);
+    v->type_enum(v, name, obj, strings, kind, errp);
 }
 
 void visit_type_int(Visitor *v, const char *name, int64_t *obj, Error **errp)
 {
-    v->type_int64(v, obj, name, errp);
+    v->type_int64(v, name, obj, errp);
 }
 
 static void visit_type_uintN(Visitor *v, uint64_t *obj, const char *name,
@@ -107,7 +107,7 @@ static void visit_type_uintN(Visitor *v, uint64_t *obj, const char *name,
     Error *err = NULL;
     uint64_t value = *obj;
 
-    v->type_uint64(v, &value, name, &err);
+    v->type_uint64(v, name, &value, &err);
     if (err) {
         error_propagate(errp, err);
     } else if (value > max) {
@@ -145,7 +145,7 @@ void visit_type_uint32(Visitor *v, const char *name, uint32_t *obj,
 void visit_type_uint64(Visitor *v, const char *name, uint64_t *obj,
                        Error **errp)
 {
-    v->type_uint64(v, obj, name, errp);
+    v->type_uint64(v, name, obj, errp);
 }
 
 static void visit_type_intN(Visitor *v, int64_t *obj, const char *name,
@@ -155,7 +155,7 @@ static void visit_type_intN(Visitor *v, int64_t *obj, const char *name,
     Error *err = NULL;
     int64_t value = *obj;
 
-    v->type_int64(v, &value, name, &err);
+    v->type_int64(v, name, &value, &err);
     if (err) {
         error_propagate(errp, err);
     } else if (value < min || value > max) {
@@ -192,42 +192,42 @@ void visit_type_int32(Visitor *v, const char *name, int32_t *obj,
 void visit_type_int64(Visitor *v, const char *name, int64_t *obj,
                       Error **errp)
 {
-    v->type_int64(v, obj, name, errp);
+    v->type_int64(v, name, obj, errp);
 }
 
 void visit_type_size(Visitor *v, const char *name, uint64_t *obj,
                      Error **errp)
 {
     if (v->type_size) {
-        v->type_size(v, obj, name, errp);
+        v->type_size(v, name, obj, errp);
     } else {
-        v->type_uint64(v, obj, name, errp);
+        v->type_uint64(v, name, obj, errp);
     }
 }
 
 void visit_type_bool(Visitor *v, const char *name, bool *obj, Error **errp)
 {
-    v->type_bool(v, obj, name, errp);
+    v->type_bool(v, name, obj, errp);
 }
 
 void visit_type_str(Visitor *v, const char *name, char **obj, Error **errp)
 {
-    v->type_str(v, obj, name, errp);
+    v->type_str(v, name, obj, errp);
 }
 
 void visit_type_number(Visitor *v, const char *name, double *obj,
                        Error **errp)
 {
-    v->type_number(v, obj, name, errp);
+    v->type_number(v, name, obj, errp);
 }
 
 void visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp)
 {
-    v->type_any(v, obj, name, errp);
+    v->type_any(v, name, obj, errp);
 }
 
-void output_type_enum(Visitor *v, int *obj, const char * const strings[],
-                      const char *kind, const char *name,
+void output_type_enum(Visitor *v, const char *name, int *obj,
+                      const char * const strings[], const char *kind,
                       Error **errp)
 {
     int i = 0;
@@ -245,8 +245,8 @@ void output_type_enum(Visitor *v, int *obj, const char * const strings[],
     visit_type_str(v, name, &enum_str, errp);
 }
 
-void input_type_enum(Visitor *v, int *obj, const char * const strings[],
-                     const char *kind, const char *name,
+void input_type_enum(Visitor *v, const char *name, int *obj,
+                     const char * const strings[], const char *kind,
                      Error **errp)
 {
     Error *local_err = NULL;
qapi/qmp-input-visitor.c +11 -11
index 32b60bb..de77740 100644
@@ -114,8 +114,8 @@ static void qmp_input_pop(QmpInputVisitor *qiv, Error **errp)
     qiv->nb_stack--;
 }
 
-static void qmp_input_start_struct(Visitor *v, void **obj, const char *kind,
-                                   const char *name, size_t size, Error **errp)
+static void qmp_input_start_struct(Visitor *v, const char *name, void **obj,
+                                   const char *kind, size_t size, Error **errp)
 {
     QmpInputVisitor *qiv = to_qiv(v);
     QObject *qobj = qmp_input_get_object(qiv, name, true);
@@ -208,8 +208,8 @@ static void qmp_input_end_list(Visitor *v, Error **errp)
     qmp_input_pop(qiv, errp);
 }
 
-static void qmp_input_get_next_type(Visitor *v, QType *type, bool promote_int,
-                                    const char *name, Error **errp)
+static void qmp_input_get_next_type(Visitor *v, const char *name, QType *type,
+                                    bool promote_int, Error **errp)
 {
     QmpInputVisitor *qiv = to_qiv(v);
     QObject *qobj = qmp_input_get_object(qiv, name, false);
@@ -224,7 +224,7 @@ static void qmp_input_get_next_type(Visitor *v, QType *type, bool promote_int,
     }
 }
 
-static void qmp_input_type_int64(Visitor *v, int64_t *obj, const char *name,
+static void qmp_input_type_int64(Visitor *v, const char *name, int64_t *obj,
                                  Error **errp)
 {
     QmpInputVisitor *qiv = to_qiv(v);
@@ -239,7 +239,7 @@ static void qmp_input_type_int64(Visitor *v, int64_t *obj, const char *name,
     *obj = qint_get_int(qint);
 }
 
-static void qmp_input_type_uint64(Visitor *v, uint64_t *obj, const char *name,
+static void qmp_input_type_uint64(Visitor *v, const char *name, uint64_t *obj,
                                   Error **errp)
 {
     /* FIXME: qobject_to_qint mishandles values over INT64_MAX */
@@ -255,7 +255,7 @@ static void qmp_input_type_uint64(Visitor *v, uint64_t *obj, const char *name,
     *obj = qint_get_int(qint);
 }
 
-static void qmp_input_type_bool(Visitor *v, bool *obj, const char *name,
+static void qmp_input_type_bool(Visitor *v, const char *name, bool *obj,
                                 Error **errp)
 {
     QmpInputVisitor *qiv = to_qiv(v);
@@ -270,7 +270,7 @@ static void qmp_input_type_bool(Visitor *v, bool *obj, const char *name,
     *obj = qbool_get_bool(qbool);
 }
 
-static void qmp_input_type_str(Visitor *v, char **obj, const char *name,
+static void qmp_input_type_str(Visitor *v, const char *name, char **obj,
                                Error **errp)
 {
     QmpInputVisitor *qiv = to_qiv(v);
@@ -285,7 +285,7 @@ static void qmp_input_type_str(Visitor *v, char **obj, const char *name,
     *obj = g_strdup(qstring_get_str(qstr));
 }
 
-static void qmp_input_type_number(Visitor *v, double *obj, const char *name,
+static void qmp_input_type_number(Visitor *v, const char *name, double *obj,
                                   Error **errp)
 {
     QmpInputVisitor *qiv = to_qiv(v);
@@ -309,7 +309,7 @@ static void qmp_input_type_number(Visitor *v, double *obj, const char *name,
                "number");
 }
 
-static void qmp_input_type_any(Visitor *v, QObject **obj, const char *name,
+static void qmp_input_type_any(Visitor *v, const char *name, QObject **obj,
                                Error **errp)
 {
     QmpInputVisitor *qiv = to_qiv(v);
@@ -319,7 +319,7 @@ static void qmp_input_type_any(Visitor *v, QObject **obj, const char *name,
     *obj = qobj;
 }
 
-static void qmp_input_optional(Visitor *v, bool *present, const char *name)
+static void qmp_input_optional(Visitor *v, const char *name, bool *present)
 {
     QmpInputVisitor *qiv = to_qiv(v);
     QObject *qobj = qmp_input_get_object(qiv, name, true);
qapi/qmp-output-visitor.c +8 -8
index f8eebaa..af600a9 100644
@@ -110,8 +110,8 @@ static void qmp_output_add_obj(QmpOutputVisitor *qov, const char *name,
     }
 }
 
-static void qmp_output_start_struct(Visitor *v, void **obj, const char *kind,
-                                    const char *name, size_t unused,
+static void qmp_output_start_struct(Visitor *v, const char *name, void **obj,
+                                    const char *kind, size_t unused,
                                     Error **errp)
 {
     QmpOutputVisitor *qov = to_qov(v);
@@ -158,14 +158,14 @@ static void qmp_output_end_list(Visitor *v, Error **errp)
     qmp_output_pop(qov);
 }
 
-static void qmp_output_type_int64(Visitor *v, int64_t *obj, const char *name,
+static void qmp_output_type_int64(Visitor *v, const char *name, int64_t *obj,
                                   Error **errp)
 {
     QmpOutputVisitor *qov = to_qov(v);
     qmp_output_add(qov, name, qint_from_int(*obj));
 }
 
-static void qmp_output_type_uint64(Visitor *v, uint64_t *obj, const char *name,
+static void qmp_output_type_uint64(Visitor *v, const char *name, uint64_t *obj,
                                    Error **errp)
 {
     /* FIXME: QMP outputs values larger than INT64_MAX as negative */
@@ -173,14 +173,14 @@ static void qmp_output_type_uint64(Visitor *v, uint64_t *obj, const char *name,
     qmp_output_add(qov, name, qint_from_int(*obj));
 }
 
-static void qmp_output_type_bool(Visitor *v, bool *obj, const char *name,
+static void qmp_output_type_bool(Visitor *v, const char *name, bool *obj,
                                  Error **errp)
 {
     QmpOutputVisitor *qov = to_qov(v);
     qmp_output_add(qov, name, qbool_from_bool(*obj));
 }
 
-static void qmp_output_type_str(Visitor *v, char **obj, const char *name,
+static void qmp_output_type_str(Visitor *v, const char *name, char **obj,
                                 Error **errp)
 {
     QmpOutputVisitor *qov = to_qov(v);
@@ -191,14 +191,14 @@ static void qmp_output_type_str(Visitor *v, char **obj, const char *name,
     }
 }
 
-static void qmp_output_type_number(Visitor *v, double *obj, const char *name,
+static void qmp_output_type_number(Visitor *v, const char *name, double *obj,
                                    Error **errp)
 {
     QmpOutputVisitor *qov = to_qov(v);
     qmp_output_add(qov, name, qfloat_from_double(*obj));
 }
 
-static void qmp_output_type_any(Visitor *v, QObject **obj, const char *name,
+static void qmp_output_type_any(Visitor *v, const char *name, QObject **obj,
                                 Error **errp)
 {
     QmpOutputVisitor *qov = to_qov(v);
qapi/string-input-visitor.c +8 -8
index d7546b5..5347b61 100644
@@ -184,7 +184,7 @@ end_list(Visitor *v, Error **errp)
     siv->head = true;
 }
 
-static void parse_type_int64(Visitor *v, int64_t *obj, const char *name,
+static void parse_type_int64(Visitor *v, const char *name, int64_t *obj,
                              Error **errp)
 {
     StringInputVisitor *siv = to_siv(v);
@@ -226,13 +226,13 @@ error:
                "an int64 value or range");
 }
 
-static void parse_type_uint64(Visitor *v, uint64_t *obj, const char *name,
+static void parse_type_uint64(Visitor *v, const char *name, uint64_t *obj,
                               Error **errp)
 {
     /* FIXME: parse_type_int64 mishandles values over INT64_MAX */
     int64_t i;
     Error *err = NULL;
-    parse_type_int64(v, &i, name, &err);
+    parse_type_int64(v, name, &i, &err);
     if (err) {
         error_propagate(errp, err);
     } else {
@@ -240,7 +240,7 @@ static void parse_type_uint64(Visitor *v, uint64_t *obj, const char *name,
     }
 }
 
-static void parse_type_size(Visitor *v, uint64_t *obj, const char *name,
+static void parse_type_size(Visitor *v, const char *name, uint64_t *obj,
                             Error **errp)
 {
     StringInputVisitor *siv = to_siv(v);
@@ -262,7 +262,7 @@ static void parse_type_size(Visitor *v, uint64_t *obj, const char *name,
     *obj = val;
 }
 
-static void parse_type_bool(Visitor *v, bool *obj, const char *name,
+static void parse_type_bool(Visitor *v, const char *name, bool *obj,
                             Error **errp)
 {
     StringInputVisitor *siv = to_siv(v);
@@ -286,7 +286,7 @@ static void parse_type_bool(Visitor *v, bool *obj, const char *name,
                "boolean");
 }
 
-static void parse_type_str(Visitor *v, char **obj, const char *name,
+static void parse_type_str(Visitor *v, const char *name, char **obj,
                            Error **errp)
 {
     StringInputVisitor *siv = to_siv(v);
@@ -298,7 +298,7 @@ static void parse_type_str(Visitor *v, char **obj, const char *name,
     }
 }
 
-static void parse_type_number(Visitor *v, double *obj, const char *name,
+static void parse_type_number(Visitor *v, const char *name, double *obj,
                               Error **errp)
 {
     StringInputVisitor *siv = to_siv(v);
@@ -318,7 +318,7 @@ static void parse_type_number(Visitor *v, double *obj, const char *name,
     *obj = val;
 }
 
-static void parse_optional(Visitor *v, bool *present, const char *name)
+static void parse_optional(Visitor *v, const char *name, bool *present)
 {
     StringInputVisitor *siv = to_siv(v);
 
qapi/string-output-visitor.c +8 -8
index 3ed2b2c..74de6b6 100644
@@ -121,7 +121,7 @@ static void format_string(StringOutputVisitor *sov, Range *r, bool next,
     }
 }
 
-static void print_type_int64(Visitor *v, int64_t *obj, const char *name,
+static void print_type_int64(Visitor *v, const char *name, int64_t *obj,
                              Error **errp)
 {
     StringOutputVisitor *sov = to_sov(v);
@@ -197,16 +197,16 @@ static void print_type_int64(Visitor *v, int64_t *obj, const char *name,
     }
 }
 
-static void print_type_uint64(Visitor *v, uint64_t *obj, const char *name,
+static void print_type_uint64(Visitor *v, const char *name, uint64_t *obj,
                              Error **errp)
 {
     /* FIXME: print_type_int64 mishandles values over INT64_MAX */
     int64_t i = *obj;
-    print_type_int64(v, &i, name, errp);
+    print_type_int64(v, name, &i, errp);
 }
 
-static void print_type_size(Visitor *v, uint64_t *obj, const char *name,
-                           Error **errp)
+static void print_type_size(Visitor *v, const char *name, uint64_t *obj,
+                            Error **errp)
 {
     StringOutputVisitor *sov = to_sov(v);
     static const char suffixes[] = { 'B', 'K', 'M', 'G', 'T', 'P', 'E' };
@@ -236,14 +236,14 @@ static void print_type_size(Visitor *v, uint64_t *obj, const char *name,
     string_output_set(sov, out);
 }
 
-static void print_type_bool(Visitor *v, bool *obj, const char *name,
+static void print_type_bool(Visitor *v, const char *name, bool *obj,
                             Error **errp)
 {
     StringOutputVisitor *sov = to_sov(v);
     string_output_set(sov, g_strdup(*obj ? "true" : "false"));
 }
 
-static void print_type_str(Visitor *v, char **obj, const char *name,
+static void print_type_str(Visitor *v, const char *name, char **obj,
                            Error **errp)
 {
     StringOutputVisitor *sov = to_sov(v);
@@ -257,7 +257,7 @@ static void print_type_str(Visitor *v, char **obj, const char *name,
     string_output_set(sov, out);
 }
 
-static void print_type_number(Visitor *v, double *obj, const char *name,
+static void print_type_number(Visitor *v, const char *name, double *obj,
                               Error **errp)
 {
     StringOutputVisitor *sov = to_sov(v);
Signature · 1 line
2.5.0
#55 lore raw

Re: [Qemu-devel] [PATCH v9 16/37] qapi: Swap 'name' in visit_* callbacks to match public API

Quoted 39 lines · Eric Blake

As explained in the previous patches, matching argument order of 'name, &value' to JSON's "name":value makes sense. However, while the last two patches were easy with Coccinelle, I ended up doing this one all by hand. Now all the visitor callbacks match the main interface.

---
v9: no change
v8: new patch

---
 include/qapi/visitor-impl.h  | 39 +++++++++++++++++++++------------------
 qapi/opts-visitor.c          | 16 ++++++++--------
 qapi/qapi-dealloc-visitor.c  | 25 ++++++++++++-------------
 qapi/qapi-visit-core.c       | 38 +++++++++++++++++++-------------------
 qapi/qmp-input-visitor.c     | 22 +++++++++++-----------
 qapi/qmp-output-visitor.c    | 16 ++++++++--------
 qapi/string-input-visitor.c  | 16 ++++++++--------
 qapi/string-output-visitor.c | 16 ++++++++--------
 8 files changed, 95 insertions(+), 93 deletions(-)
include/qapi/visitor-impl.h +2 -2
index e6399d1..0257359 100644
@@ -18,8 +18,8 @@
 struct Visitor
 {
     /* Must be set */
-    void (*start_struct)(Visitor *v, void **obj, const char *kind,
-                         const char *name, size_t size, Error **errp);
+    void (*start_struct)(Visitor *v, const char *name, void **obj,
+                         const char *kind, size_t size, Error **errp);
     void (*end_struct)(Visitor *v, Error **errp);
 
     void (*start_implicit_struct)(Visitor *v, void **obj, size_t size,

include/qapi/visitor-impl.h struct Visitor · line 34

Quoted 7 lines
include/qapi/visitor-impl.h +2 -2
@@ -30,39 +30,42 @@ struct Visitor
     GenericList *(*next_list)(Visitor *v, GenericList **list, Error **errp);
     void (*end_list)(Visitor *v, Error **errp);
 
-    void (*type_enum)(Visitor *v, int *obj, const char * const strings[],
-                      const char *kind, const char *name, Error **errp);
+    void (*type_enum)(Visitor *v, const char *name, int *obj,
+                      const char * const strings[], const char *kind,

Opportunity to change to 'const char *const'. I prefer that, because it makes the fact that this is a pointer-* and not a binary operator-* visually obvious.

Same elsewhere.

Quoted 41 lines
include/qapi/visitor-impl.h +11 -12
+                      Error **errp);
     /* May be NULL; only needed for input visitors. */
-    void (*get_next_type)(Visitor *v, QType *type, bool promote_int,
-                          const char *name, Error **errp);
+    void (*get_next_type)(Visitor *v, const char *name, QType *type,
+                          bool promote_int, Error **errp);
 
     /* Must be set. */
-    void (*type_int64)(Visitor *v, int64_t *obj, const char *name,
+    void (*type_int64)(Visitor *v, const char *name, int64_t *obj,
                        Error **errp);
     /* Must be set. */
-    void (*type_uint64)(Visitor *v, uint64_t *obj, const char *name,
+    void (*type_uint64)(Visitor *v, const char *name, uint64_t *obj,
                         Error **errp);
     /* Optional; fallback is type_uint64().  */
-    void (*type_size)(Visitor *v, uint64_t *obj, const char *name,
+    void (*type_size)(Visitor *v, const char *name, uint64_t *obj,
                       Error **errp);
     /* Must be set. */
-    void (*type_bool)(Visitor *v, bool *obj, const char *name, Error **errp);
-    void (*type_str)(Visitor *v, char **obj, const char *name, Error **errp);
-    void (*type_number)(Visitor *v, double *obj, const char *name,
+    void (*type_bool)(Visitor *v, const char *name, bool *obj, Error **errp);
+    void (*type_str)(Visitor *v, const char *name, char **obj, Error **errp);
+    void (*type_number)(Visitor *v, const char *name, double *obj,
                         Error **errp);
-    void (*type_any)(Visitor *v, QObject **obj, const char *name,
+    void (*type_any)(Visitor *v, const char *name, QObject **obj,
                      Error **errp);
 
     /* May be NULL; most useful for input visitors. */
-    void (*optional)(Visitor *v, bool *present, const char *name);
+    void (*optional)(Visitor *v, const char *name, bool *present);
 
     bool (*start_union)(Visitor *v, bool data_present, Error **errp);
     void (*end_union)(Visitor *v, bool data_present, Error **errp);
 };
 
-void input_type_enum(Visitor *v, int *obj, const char * const strings[],
-                     const char *kind, const char *name, Error **errp);

include/qapi/visitor-impl.h struct Visitor · line 71

Quoted 10 lines
include/qapi/visitor-impl.h +6 -2
-void output_type_enum(Visitor *v, int *obj, const char * const strings[],
-                      const char *kind, const char *name, Error **errp);
+void input_type_enum(Visitor *v, const char *name, int *obj,
+                     const char * const strings[], const char *kind,
+                     Error **errp);
+void output_type_enum(Visitor *v, const char *name, int *obj,
+                      const char * const strings[], const char *kind,
+                      Error **errp);
 
 #endif

I checked the changes to this file carefully. Can we rely on the compiler to flag mistakes in the rest of the patch?

author
#56 lore raw

Re: [Qemu-devel] [PATCH v9 16/37] qapi: Swap 'name' in visit_* callbacks to match public API

Quoted 25 lines · Markus Armbruster
Quoted 11 lines · Eric Blake

As explained in the previous patches, matching argument order of 'name, &value' to JSON's "name":value makes sense. However, while the last two patches were easy with Coccinelle, I ended up doing this one all by hand. Now all the visitor callbacks match the main interface.

include/qapi/visitor-impl.h struct Visitor · line 34

Quoted 7 lines
include/qapi/visitor-impl.h +2 -2
@@ -30,39 +30,42 @@ struct Visitor
     GenericList *(*next_list)(Visitor *v, GenericList **list, Error **errp);
     void (*end_list)(Visitor *v, Error **errp);
 
-    void (*type_enum)(Visitor *v, int *obj, const char * const strings[],
-                      const char *kind, const char *name, Error **errp);
+    void (*type_enum)(Visitor *v, const char *name, int *obj,
+                      const char * const strings[], const char *kind,

Opportunity to change to 'const char *const'. I prefer that, because it makes the fact that this is a pointer-* and not a binary operator-* visually obvious.

Quoted 1 line

Same elsewhere.

Hmm, I probably have churn later in the series. Will fix.

Quoted 8 lines

include/qapi/visitor-impl.h struct Visitor · line 59

Quoted 4 lines
include/qapi/visitor-impl.h +1 -1
     /* May be NULL; most useful for input visitors. */
-    void (*optional)(Visitor *v, bool *present, const char *name);
+    void (*optional)(Visitor *v, const char *name, bool *present);
 

I checked the changes to this file carefully. Can we rely on the compiler to flag mistakes in the rest of the patch?

C's (intentionally-loose) treatment of 'char *' like 'void *' is a bit worrisome, but the fact that we have 'const' on only one of the two swapped arguments was indeed enough to make the compiler complain about mismatch in parameter types when trying to assign incorrectly-typed static functions to the updated struct members.

Signature · 2 lines
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org
#57 lore raw

Re: [Qemu-devel] [PATCH v9 16/37] qapi: Swap 'name' in visit_* callbacks to match public API

Quoted 36 lines · Eric Blake
Quoted 25 lines · Markus Armbruster
Quoted 11 lines · Eric Blake

As explained in the previous patches, matching argument order of 'name, &value' to JSON's "name":value makes sense. However, while the last two patches were easy with Coccinelle, I ended up doing this one all by hand. Now all the visitor callbacks match the main interface.

include/qapi/visitor-impl.h struct Visitor · line 34

Quoted 7 lines
include/qapi/visitor-impl.h +2 -2
@@ -30,39 +30,42 @@ struct Visitor
     GenericList *(*next_list)(Visitor *v, GenericList **list, Error **errp);
     void (*end_list)(Visitor *v, Error **errp);
 
-    void (*type_enum)(Visitor *v, int *obj, const char * const strings[],
-                      const char *kind, const char *name, Error **errp);
+    void (*type_enum)(Visitor *v, const char *name, int *obj,
+                      const char * const strings[], const char *kind,

Opportunity to change to 'const char *const'. I prefer that, because it makes the fact that this is a pointer-* and not a binary operator-* visually obvious.

Quoted 1 line

Same elsewhere.

Hmm, I probably have churn later in the series. Will fix.

Quoted 6 lines
Quoted 4 lines
include/qapi/visitor-impl.h +1 -1
     /* May be NULL; most useful for input visitors. */
-    void (*optional)(Visitor *v, bool *present, const char *name);
+    void (*optional)(Visitor *v, const char *name, bool *present);
 
Quoted 8 lines
Quoted 2 lines

I checked the changes to this file carefully. Can we rely on the compiler to flag mistakes in the rest of the patch?

C's (intentionally-loose) treatment of 'char *' like 'void *' is a bit worrisome, but the fact that we have 'const' on only one of the two swapped arguments was indeed enough to make the compiler complain about mismatch in parameter types when trying to assign incorrectly-typed static functions to the updated struct members.

Okay, I guess that's good enough.

author
#58 lore raw

PATCH v9 17/37 qapi: Drop unused 'kind' for struct/enum visit

In reply to Eric Blake

visit_start_struct() and visit_type_enum() had a 'kind' argument that was usually set to either the stringized version of the corresponding qapi type name, or to NULL (although some clients didn't even get that right). But nothing ever used the argument. It's even hard to argue that it would be useful in a debugger, as a stack backtrace also tells which type is being visited.

Therefore, drop the 'kind' argument as dead.

---
v9: no change
v8: rebase to 'name' motion
v7: new patch

---
 hmp.c                       |  2 +-
 hw/core/qdev-properties.c   |  6 ++----
 hw/ppc/spapr_drc.c          |  4 ++--
 hw/virtio/virtio-balloon.c  |  4 ++--
 include/qapi/visitor-impl.h | 11 ++++-------
 include/qapi/visitor.h      |  5 ++---
 qapi/opts-visitor.c         |  2 +-
 qapi/qapi-dealloc-visitor.c |  6 ++----
 qapi/qapi-visit-core.c      | 16 +++++++---------
 qapi/qmp-input-visitor.c    |  2 +-
 qapi/qmp-output-visitor.c   |  3 +--
 qom/object.c                |  8 ++++----
 scripts/qapi-event.py       |  2 +-
 scripts/qapi-visit.py       | 12 ++++++------
 vl.c                        |  2 +-
 15 files changed, 37 insertions(+), 48 deletions(-)
hmp.c +1 -1
index 3beea3a..a4b74df 100644
@@ -1669,7 +1669,7 @@ void hmp_object_add(Monitor *mon, const QDict *qdict)
     pdict = qdict_clone_shallow(qdict);
     v = opts_get_visitor(ov);
 
-    visit_start_struct(v, NULL, NULL, NULL, 0, &err);
+    visit_start_struct(v, NULL, NULL, 0, &err);
     if (err) {
         goto out_clean;
     }
hw/core/qdev-properties.c +2 -4
index de927c6..e7c7719 100644
@@ -48,8 +48,7 @@ static void get_enum(Object *obj, Visitor *v, const char *name, void *opaque,
     Property *prop = opaque;
     int *ptr = qdev_get_prop_ptr(dev, prop);
 
-    visit_type_enum(v, prop->name, ptr, prop->info->enum_table,
-                    prop->info->name, errp);
+    visit_type_enum(v, prop->name, ptr, prop->info->enum_table, errp);
 }
 
 static void set_enum(Object *obj, Visitor *v, const char *name, void *opaque,
@@ -64,8 +63,7 @@ static void set_enum(Object *obj, Visitor *v, const char *name, void *opaque,
         return;
     }
 
-    visit_type_enum(v, prop->name, ptr, prop->info->enum_table,
-                    prop->info->name, errp);
+    visit_type_enum(v, prop->name, ptr, prop->info->enum_table, errp);
 }
 
 /* Bit */
hw/ppc/spapr_drc.c +2 -2
index 9ef603b..78d71e2 100644
@@ -259,7 +259,7 @@ static void prop_get_fdt(Object *obj, Visitor *v, const char *name,
     void *fdt;
 
     if (!drc->fdt) {
-        visit_start_struct(v, name, NULL, NULL, 0, &err);
+        visit_start_struct(v, name, NULL, 0, &err);
         if (!err) {
             visit_end_struct(v, &err);
         }
@@ -282,7 +282,7 @@ static void prop_get_fdt(Object *obj, Visitor *v, const char *name,
         case FDT_BEGIN_NODE:
             fdt_depth++;
             name = fdt_get_name(fdt, fdt_offset, &name_len);
-            visit_start_struct(v, name, NULL, NULL, 0, &err);
+            visit_start_struct(v, name, NULL, 0, &err);
             if (err) {
                 error_propagate(errp, err);
                 return;
hw/virtio/virtio-balloon.c +2 -2
index dc44088..24ecd87 100644
@@ -117,7 +117,7 @@ static void balloon_stats_get_all(Object *obj, Visitor *v, const char *name,
     VirtIOBalloon *s = opaque;
     int i;
 
-    visit_start_struct(v, name, NULL, "guest-stats", 0, &err);
+    visit_start_struct(v, name, NULL, 0, &err);
     if (err) {
         goto out;
     }
@@ -126,7 +126,7 @@ static void balloon_stats_get_all(Object *obj, Visitor *v, const char *name,
         goto out_end;
     }
 
-    visit_start_struct(v, "stats", NULL, NULL, 0, &err);
+    visit_start_struct(v, "stats", NULL, 0, &err);
     if (err) {
         goto out_end;
     }
include/qapi/visitor-impl.h +4 -7
index 0257359..6abfda7 100644
@@ -19,7 +19,7 @@ struct Visitor
 {
     /* Must be set */
     void (*start_struct)(Visitor *v, const char *name, void **obj,
-                         const char *kind, size_t size, Error **errp);
+                         size_t size, Error **errp);
     void (*end_struct)(Visitor *v, Error **errp);
 
     void (*start_implicit_struct)(Visitor *v, void **obj, size_t size,
@@ -31,8 +31,7 @@ struct Visitor
     void (*end_list)(Visitor *v, Error **errp);
 
     void (*type_enum)(Visitor *v, const char *name, int *obj,
-                      const char * const strings[], const char *kind,
-                      Error **errp);
+                      const char *const strings[], Error **errp);
     /* May be NULL; only needed for input visitors. */
     void (*get_next_type)(Visitor *v, const char *name, QType *type,
                           bool promote_int, Error **errp);
@@ -62,10 +61,8 @@ struct Visitor
 };
 
 void input_type_enum(Visitor *v, const char *name, int *obj,
-                     const char * const strings[], const char *kind,
-                     Error **errp);
+                     const char *const strings[], Error **errp);
 void output_type_enum(Visitor *v, const char *name, int *obj,
-                      const char * const strings[], const char *kind,
-                      Error **errp);
+                      const char *const strings[], Error **errp);
 
 #endif
include/qapi/visitor.h +2 -3
index eb50116..4abc180 100644
@@ -28,7 +28,7 @@ typedef struct GenericList
 } GenericList;
 
 void visit_start_struct(Visitor *v, const char *name, void **obj,
-                        const char *kind, size_t size, Error **errp);
+                        size_t size, Error **errp);
 void visit_end_struct(Visitor *v, Error **errp);
 void visit_start_implicit_struct(Visitor *v, void **obj, size_t size,
                                  Error **errp);
@@ -54,8 +54,7 @@ bool visit_optional(Visitor *v, const char *name, bool *present);
 void visit_get_next_type(Visitor *v, const char *name, QType *type,
                          bool promote_int, Error **errp);
 void visit_type_enum(Visitor *v, const char *name, int *obj,
-                     const char *const strings[], const char *kind,
-                     Error **errp);
+                     const char *const strings[], Error **errp);
 void visit_type_int(Visitor *v, const char *name, int64_t *obj, Error **errp);
 void visit_type_uint8(Visitor *v, const char *name, uint8_t *obj,
                       Error **errp);
qapi/opts-visitor.c +1 -1
index b1c8e50..6d4a91e 100644
@@ -124,7 +124,7 @@ opts_visitor_insert(GHashTable *unprocessed_opts, const QemuOpt *opt)
 
 
 static void
-opts_start_struct(Visitor *v, const char *name, void **obj, const char *kind,
+opts_start_struct(Visitor *v, const char *name, void **obj,
                   size_t size, Error **errp)
 {
     OptsVisitor *ov = to_ov(v);
qapi/qapi-dealloc-visitor.c +2 -4
index b521f7c..49e7cf0 100644
@@ -59,8 +59,7 @@ static void *qapi_dealloc_pop(QapiDeallocVisitor *qov)
 }
 
 static void qapi_dealloc_start_struct(Visitor *v, const char *name, void **obj,
-                                      const char *kind, size_t unused,
-                                      Error **errp)
+                                      size_t unused, Error **errp)
 {
     QapiDeallocVisitor *qov = to_qov(v);
     qapi_dealloc_push(qov, obj);
@@ -164,8 +163,7 @@ static void qapi_dealloc_type_anything(Visitor *v, const char *name,
 }
 
 static void qapi_dealloc_type_enum(Visitor *v, const char *name, int *obj,
-                                   const char * const strings[],
-                                   const char *kind, Error **errp)
+                                   const char * const strings[], Error **errp)
 {
 }
 
qapi/qapi-visit-core.c +7 -9
index 7bc3de6..b0452cf 100644
@@ -2,6 +2,7 @@
  * Core Definitions for QAPI Visitor Classes
  *
  * Copyright IBM, Corp. 2011
+ * Copyright (C) 2015 Red Hat, Inc.
  *
  * Authors:
  *  Anthony Liguori   <[email protected]>
@@ -18,9 +19,9 @@
 #include "qapi/visitor-impl.h"
 
 void visit_start_struct(Visitor *v, const char *name, void **obj,
-                        const char *kind, size_t size, Error **errp)
+                        size_t size, Error **errp)
 {
-    v->start_struct(v, name, obj, kind, size, errp);
+    v->start_struct(v, name, obj, size, errp);
 }
 
 void visit_end_struct(Visitor *v, Error **errp)
@@ -90,10 +91,9 @@ void visit_get_next_type(Visitor *v, const char *name, QType *type,
 }
 
 void visit_type_enum(Visitor *v, const char *name, int *obj,
-                     const char *const strings[], const char *kind,
-                     Error **errp)
+                     const char *const strings[], Error **errp)
 {
-    v->type_enum(v, name, obj, strings, kind, errp);
+    v->type_enum(v, name, obj, strings, errp);
 }
 
 void visit_type_int(Visitor *v, const char *name, int64_t *obj, Error **errp)
@@ -227,8 +227,7 @@ void visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp)
 }
 
 void output_type_enum(Visitor *v, const char *name, int *obj,
-                      const char * const strings[], const char *kind,
-                      Error **errp)
+                      const char * const strings[], Error **errp)
 {
     int i = 0;
     int value = *obj;
@@ -246,8 +245,7 @@ void output_type_enum(Visitor *v, const char *name, int *obj,
 }
 
 void input_type_enum(Visitor *v, const char *name, int *obj,
-                     const char * const strings[], const char *kind,
-                     Error **errp)
+                     const char * const strings[], Error **errp)
 {
     Error *local_err = NULL;
     int64_t value = 0;
qapi/qmp-input-visitor.c +1 -1
index de77740..bf25249 100644
@@ -115,7 +115,7 @@ static void qmp_input_pop(QmpInputVisitor *qiv, Error **errp)
 }
 
 static void qmp_input_start_struct(Visitor *v, const char *name, void **obj,
-                                   const char *kind, size_t size, Error **errp)
+                                   size_t size, Error **errp)
 {
     QmpInputVisitor *qiv = to_qiv(v);
     QObject *qobj = qmp_input_get_object(qiv, name, true);
qapi/qmp-output-visitor.c +1 -2
index af600a9..db5e618 100644
@@ -111,8 +111,7 @@ static void qmp_output_add_obj(QmpOutputVisitor *qov, const char *name,
 }
 
 static void qmp_output_start_struct(Visitor *v, const char *name, void **obj,
-                                    const char *kind, size_t unused,
-                                    Error **errp)
+                                    size_t unused, Error **errp)
 {
     QmpOutputVisitor *qov = to_qov(v);
     QDict *dict = qdict_new();
qom/object.c +4 -4
index 55b3955..e5b0566 100644
@@ -1244,7 +1244,7 @@ int object_property_get_enum(Object *obj, const char *name,
     siv = string_input_visitor_new(str);
     string_output_visitor_cleanup(sov);
     visit_type_enum(string_input_get_visitor(siv), name, &ret,
-                    enumprop->strings, NULL, errp);
+                    enumprop->strings, errp);
 
     g_free(str);
     string_input_visitor_cleanup(siv);
@@ -1915,7 +1915,7 @@ static void property_get_enum(Object *obj, Visitor *v, const char *name,
         return;
     }
 
-    visit_type_enum(v, name, &value, prop->strings, NULL, errp);
+    visit_type_enum(v, name, &value, prop->strings, errp);
 }
 
 static void property_set_enum(Object *obj, Visitor *v, const char *name,
@@ -1925,7 +1925,7 @@ static void property_set_enum(Object *obj, Visitor *v, const char *name,
     int value;
     Error *err = NULL;
 
-    visit_type_enum(v, name, &value, prop->strings, NULL, &err);
+    visit_type_enum(v, name, &value, prop->strings, &err);
     if (err) {
         error_propagate(errp, err);
         return;
@@ -2006,7 +2006,7 @@ static void property_get_tm(Object *obj, Visitor *v, const char *name,
         goto out;
     }
 
-    visit_start_struct(v, name, NULL, "struct tm", 0, &err);
+    visit_start_struct(v, name, NULL, 0, &err);
     if (err) {
         goto out;
     }
scripts/qapi-event.py +1 -1
index fd03e38..a1dca29 100644
@@ -63,7 +63,7 @@ def gen_event_send(name, arg_type):
     qov = qmp_output_visitor_new();
     v = qmp_output_get_visitor(qov);
 
-    visit_start_struct(v, "%(name)s", NULL, NULL, 0, &err);
+    visit_start_struct(v, "%(name)s", NULL, 0, &err);
 ''',
                      name=name)
         ret += gen_err_check()
scripts/qapi-visit.py +6 -6
index ca28b08..8a741b6 100644
@@ -122,7 +122,7 @@ void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error
 {
     Error *err = NULL;
 
-    visit_start_struct(v, name, (void **)obj, "%(name)s", sizeof(%(c_name)s), &err);
+    visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), &err);
     if (err) {
         goto out;
     }
@@ -138,7 +138,7 @@ out:
     error_propagate(errp, err);
 }
 ''',
-                 name=name, c_name=c_name(name))
+                 c_name=c_name(name))
 
     return ret
 
@@ -183,11 +183,11 @@ def gen_visit_enum(name):
 void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s *obj, Error **errp)
 {
     int tmp = *obj;
-    visit_type_enum(v, name, &tmp, %(c_name)s_lookup, "%(name)s", errp);
+    visit_type_enum(v, name, &tmp, %(c_name)s_lookup, errp);
     *obj = tmp;
 }
 ''',
-                 c_name=c_name(name), name=name)
+                 c_name=c_name(name))
 
 
 def gen_visit_alternate(name, variants):
@@ -259,7 +259,7 @@ void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error
 {
     Error *err = NULL;
 
-    visit_start_struct(v, name, (void **)obj, "%(name)s", sizeof(%(c_name)s), &err);
+    visit_start_struct(v, name, (void **)obj, sizeof(%(c_name)s), &err);
     if (err) {
         goto out;
     }
@@ -267,7 +267,7 @@ void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error
         goto out_obj;
     }
 ''',
-                 c_name=c_name(name), name=name)
+                 c_name=c_name(name))
 
     if base:
         ret += mcgen('''
vl.c +1 -1
index 49ec0de..22062b5 100644
@@ -2834,7 +2834,7 @@ static int object_create(void *opaque, QemuOpts *opts, Error **errp)
     pdict = qemu_opts_to_qdict(opts, NULL);
     v = opts_get_visitor(ov);
 
-    visit_start_struct(v, NULL, NULL, NULL, 0, &err);
+    visit_start_struct(v, NULL, NULL, 0, &err);
     if (err) {
         goto out;
     }
Signature · 1 line
2.5.0
#59 lore raw

Re: [Qemu-devel] [PATCH v9 17/37] qapi: Drop unused 'kind' for struct/enum visit

Quoted 33 lines · Eric Blake

visit_start_struct() and visit_type_enum() had a 'kind' argument that was usually set to either the stringized version of the corresponding qapi type name, or to NULL (although some clients didn't even get that right). But nothing ever used the argument. It's even hard to argue that it would be useful in a debugger, as a stack backtrace also tells which type is being visited.

Therefore, drop the 'kind' argument as dead.

---
v9: no change
v8: rebase to 'name' motion
v7: new patch

---
 hmp.c                       |  2 +-
 hw/core/qdev-properties.c   |  6 ++----
 hw/ppc/spapr_drc.c          |  4 ++--
 hw/virtio/virtio-balloon.c  |  4 ++--
 include/qapi/visitor-impl.h | 11 ++++-------
 include/qapi/visitor.h      |  5 ++---
 qapi/opts-visitor.c         |  2 +-
 qapi/qapi-dealloc-visitor.c |  6 ++----
 qapi/qapi-visit-core.c      | 16 +++++++---------
 qapi/qmp-input-visitor.c    |  2 +-
 qapi/qmp-output-visitor.c   |  3 +--
 qom/object.c                |  8 ++++----
 scripts/qapi-event.py       |  2 +-
 scripts/qapi-visit.py       | 12 ++++++------
 vl.c                        |  2 +-
 15 files changed, 37 insertions(+), 48 deletions(-)

[...]

Quoted 50 lines
include/qapi/visitor-impl.h +4 -7
index 0257359..6abfda7 100644
@@ -19,7 +19,7 @@ struct Visitor
 {
     /* Must be set */
     void (*start_struct)(Visitor *v, const char *name, void **obj,
-                         const char *kind, size_t size, Error **errp);
+                         size_t size, Error **errp);
     void (*end_struct)(Visitor *v, Error **errp);
 
     void (*start_implicit_struct)(Visitor *v, void **obj, size_t size,
@@ -31,8 +31,7 @@ struct Visitor
     void (*end_list)(Visitor *v, Error **errp);
 
     void (*type_enum)(Visitor *v, const char *name, int *obj,
-                      const char * const strings[], const char *kind,
-                      Error **errp);
+                      const char *const strings[], Error **errp);
     /* May be NULL; only needed for input visitors. */
     void (*get_next_type)(Visitor *v, const char *name, QType *type,
                           bool promote_int, Error **errp);
@@ -62,10 +61,8 @@ struct Visitor
 };
 
 void input_type_enum(Visitor *v, const char *name, int *obj,
-                     const char * const strings[], const char *kind,
-                     Error **errp);
+                     const char *const strings[], Error **errp);
 void output_type_enum(Visitor *v, const char *name, int *obj,
-                      const char * const strings[], const char *kind,
-                      Error **errp);
+                      const char *const strings[], Error **errp);
 
 #endif
include/qapi/visitor.h +1 -1
index eb50116..4abc180 100644
@@ -28,7 +28,7 @@ typedef struct GenericList
 } GenericList;
 
 void visit_start_struct(Visitor *v, const char *name, void **obj,
-                        const char *kind, size_t size, Error **errp);
+                        size_t size, Error **errp);
 void visit_end_struct(Visitor *v, Error **errp);
 void visit_start_implicit_struct(Visitor *v, void **obj, size_t size,
                                  Error **errp);

include/qapi/visitor.h bool visit_optional(Visitor *v, const char *name, bool *present); · line 60

Quoted 9 lines
include/qapi/visitor.h +1 -2
@@ -54,8 +54,7 @@ bool visit_optional(Visitor *v, const char *name, bool *present);
 void visit_get_next_type(Visitor *v, const char *name, QType *type,
                          bool promote_int, Error **errp);
 void visit_type_enum(Visitor *v, const char *name, int *obj,
-                     const char *const strings[], const char *kind,
-                     Error **errp);
+                     const char *const strings[], Error **errp);
 void visit_type_int(Visitor *v, const char *name, int64_t *obj, Error **errp);
 void visit_type_uint8(Visitor *v, const char *name, uint8_t *obj,
                       Error **errp);

Looks good. We should be able to rely on the compiler to check the changes to callers.

[...]

qapi/qapi-visit-core.c line 5

Quoted 9 lines
qapi/qapi-visit-core.c +1 -0
index 7bc3de6..b0452cf 100644
@@ -2,6 +2,7 @@
  * Core Definitions for QAPI Visitor Classes
  *
  * Copyright IBM, Corp. 2011
+ * Copyright (C) 2015 Red Hat, Inc.

2012-2015 would be more accurate.

Quoted 3 lines
qapi/qapi-visit-core.c +0 -0
  *
  * Authors:
  *  Anthony Liguori   <[email protected]>

[...]

author
#60 lore raw

PATCH v9 18/37 qapi: Drop unused error argument for list and implicit struct

In reply to Eric Blake

No backend was setting an error when ending the visit of a list or implicit struct. Make the callers a bit easier to follow by making this a part of the contract, and removing the errp argument - callers can then unconditionally end an object as part of cleanup without having to think about whether a second error is dominated by a first, because there is no second error.

The only addition of &error_abort in this patch, in the function qmp_input_end_list(), will never trigger unless a programming bug creates a push(struct)/pop(list) or push(list)/pop(struct) mismatch.

A later patch will then tackle the larger task of splitting visit_end_struct(), which can indeed set an error (and that cleanup will also have the side-effect of removing the use of error_abort added here).

---
v9: enhance commit message
v8: no change
v7: place earlier in series, rebase to earlier changes
v6: new patch, split from RFC on v5 7/46

---
 hw/ppc/spapr_drc.c           |  6 +-----
 include/qapi/visitor-impl.h  |  6 ++++--
 include/qapi/visitor.h       |  5 +++--
 qapi/opts-visitor.c          |  2 +-
 qapi/qapi-dealloc-visitor.c  |  4 ++--
 qapi/qapi-visit-core.c       |  8 ++++----
 qapi/qmp-input-visitor.c     |  9 ++-------
 qapi/qmp-output-visitor.c    |  2 +-
 qapi/string-input-visitor.c  |  2 +-
 qapi/string-output-visitor.c |  2 +-
 scripts/qapi-visit.py        | 10 +++-------
 11 files changed, 23 insertions(+), 33 deletions(-)
hw/ppc/spapr_drc.c +1 -5
index 78d71e2..ffc2cd9 100644
@@ -314,11 +314,7 @@ static void prop_get_fdt(Object *obj, Visitor *v, const char *name,
                     return;
                 }
             }
-            visit_end_list(v, &err);
-            if (err) {
-                error_propagate(errp, err);
-                return;
-            }
+            visit_end_list(v);
             break;
         }
         default:
include/qapi/visitor-impl.h +4 -2
index 6abfda7..7f512cf 100644
@@ -24,11 +24,13 @@ struct Visitor
 
     void (*start_implicit_struct)(Visitor *v, void **obj, size_t size,
                                   Error **errp);
-    void (*end_implicit_struct)(Visitor *v, Error **errp);
+    /* May be NULL */
+    void (*end_implicit_struct)(Visitor *v);
 
     void (*start_list)(Visitor *v, const char *name, Error **errp);
     GenericList *(*next_list)(Visitor *v, GenericList **list, Error **errp);
-    void (*end_list)(Visitor *v, Error **errp);
+    /* Must be set */
+    void (*end_list)(Visitor *v);
 
     void (*type_enum)(Visitor *v, const char *name, int *obj,
                       const char *const strings[], Error **errp);
include/qapi/visitor.h +3 -2
index 4abc180..10390d2 100644
@@ -32,10 +32,11 @@ void visit_start_struct(Visitor *v, const char *name, void **obj,
 void visit_end_struct(Visitor *v, Error **errp);
 void visit_start_implicit_struct(Visitor *v, void **obj, size_t size,
                                  Error **errp);
-void visit_end_implicit_struct(Visitor *v, Error **errp);
+void visit_end_implicit_struct(Visitor *v);
+
 void visit_start_list(Visitor *v, const char *name, Error **errp);
 GenericList *visit_next_list(Visitor *v, GenericList **list, Error **errp);
-void visit_end_list(Visitor *v, Error **errp);
+void visit_end_list(Visitor *v);
 
 /**
  * Check if an optional member @name of an object needs visiting.
qapi/opts-visitor.c +1 -1
index 6d4a91e..62ffdd4 100644
@@ -269,7 +269,7 @@ opts_next_list(Visitor *v, GenericList **list, Error **errp)
 
 
 static void
-opts_end_list(Visitor *v, Error **errp)
+opts_end_list(Visitor *v)
 {
     OptsVisitor *ov = to_ov(v);
 
qapi/qapi-dealloc-visitor.c +2 -2
index 49e7cf0..560feb3 100644
@@ -83,7 +83,7 @@ static void qapi_dealloc_start_implicit_struct(Visitor *v,
     qapi_dealloc_push(qov, obj);
 }
 
-static void qapi_dealloc_end_implicit_struct(Visitor *v, Error **errp)
+static void qapi_dealloc_end_implicit_struct(Visitor *v)
 {
     QapiDeallocVisitor *qov = to_qov(v);
     void **obj = qapi_dealloc_pop(qov);
@@ -119,7 +119,7 @@ static GenericList *qapi_dealloc_next_list(Visitor *v, GenericList **listp,
     return NULL;
 }
 
-static void qapi_dealloc_end_list(Visitor *v, Error **errp)
+static void qapi_dealloc_end_list(Visitor *v)
 {
     QapiDeallocVisitor *qov = to_qov(v);
     void *obj = qapi_dealloc_pop(qov);
qapi/qapi-visit-core.c +4 -4
index b0452cf..2d3743b 100644
@@ -37,10 +37,10 @@ void visit_start_implicit_struct(Visitor *v, void **obj, size_t size,
     }
 }
 
-void visit_end_implicit_struct(Visitor *v, Error **errp)
+void visit_end_implicit_struct(Visitor *v)
 {
     if (v->end_implicit_struct) {
-        v->end_implicit_struct(v, errp);
+        v->end_implicit_struct(v);
     }
 }
 
@@ -54,9 +54,9 @@ GenericList *visit_next_list(Visitor *v, GenericList **list, Error **errp)
     return v->next_list(v, list, errp);
 }
 
-void visit_end_list(Visitor *v, Error **errp)
+void visit_end_list(Visitor *v)
 {
-    v->end_list(v, errp);
+    v->end_list(v);
 }
 
 bool visit_start_union(Visitor *v, bool data_present, Error **errp)
qapi/qmp-input-visitor.c +2 -7
index bf25249..597652c 100644
@@ -153,10 +153,6 @@ static void qmp_input_start_implicit_struct(Visitor *v, void **obj,
     }
 }
 
-static void qmp_input_end_implicit_struct(Visitor *v, Error **errp)
-{
-}
-
 static void qmp_input_start_list(Visitor *v, const char *name, Error **errp)
 {
     QmpInputVisitor *qiv = to_qiv(v);
@@ -201,11 +197,11 @@ static GenericList *qmp_input_next_list(Visitor *v, GenericList **list,
     return entry;
 }
 
-static void qmp_input_end_list(Visitor *v, Error **errp)
+static void qmp_input_end_list(Visitor *v)
 {
     QmpInputVisitor *qiv = to_qiv(v);
 
-    qmp_input_pop(qiv, errp);
+    qmp_input_pop(qiv, &error_abort);
 }
 
 static void qmp_input_get_next_type(Visitor *v, const char *name, QType *type,
@@ -352,7 +348,6 @@ QmpInputVisitor *qmp_input_visitor_new(QObject *obj)
     v->visitor.start_struct = qmp_input_start_struct;
     v->visitor.end_struct = qmp_input_end_struct;
     v->visitor.start_implicit_struct = qmp_input_start_implicit_struct;
-    v->visitor.end_implicit_struct = qmp_input_end_implicit_struct;
     v->visitor.start_list = qmp_input_start_list;
     v->visitor.next_list = qmp_input_next_list;
     v->visitor.end_list = qmp_input_end_list;
qapi/qmp-output-visitor.c +1 -1
index db5e618..d367148 100644
@@ -151,7 +151,7 @@ static GenericList *qmp_output_next_list(Visitor *v, GenericList **listp,
     return list ? list->next : NULL;
 }
 
-static void qmp_output_end_list(Visitor *v, Error **errp)
+static void qmp_output_end_list(Visitor *v)
 {
     QmpOutputVisitor *qov = to_qov(v);
     qmp_output_pop(qov);
qapi/string-input-visitor.c +1 -1
index 5347b61..610c233 100644
@@ -178,7 +178,7 @@ next_list(Visitor *v, GenericList **list, Error **errp)
 }
 
 static void
-end_list(Visitor *v, Error **errp)
+end_list(Visitor *v)
 {
     StringInputVisitor *siv = to_siv(v);
     siv->head = true;
qapi/string-output-visitor.c +1 -1
index 74de6b6..fd917a4 100644
@@ -303,7 +303,7 @@ next_list(Visitor *v, GenericList **list, Error **errp)
 }
 
 static void
-end_list(Visitor *v, Error **errp)
+end_list(Visitor *v)
 {
     StringOutputVisitor *sov = to_sov(v);
 
scripts/qapi-visit.py +3 -7
index 8a741b6..573bb81 100644
@@ -62,7 +62,7 @@ static void visit_type_implicit_%(c_type)s(Visitor *v, %(c_type)s **obj, Error *
     visit_start_implicit_struct(v, (void **)obj, sizeof(%(c_type)s), &err);
     if (!err) {
         visit_type_%(c_type)s_fields(v, obj, errp);
-        visit_end_implicit_struct(v, &err);
+        visit_end_implicit_struct(v);
     }
     error_propagate(errp, err);
 }
@@ -167,9 +167,7 @@ void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error
         visit_type_%(c_elt_type)s(v, NULL, &native_i->value, &err);
     }
 
-    error_propagate(errp, err);
-    err = NULL;
-    visit_end_list(v, &err);
+    visit_end_list(v);
 out:
     error_propagate(errp, err);
 }
@@ -230,9 +228,7 @@ void visit_type_%(c_name)s(Visitor *v, const char *name, %(c_name)s **obj, Error
                    "%(name)s");
     }
 out_obj:
-    error_propagate(errp, err);
-    err = NULL;
-    visit_end_implicit_struct(v, &err);
+    visit_end_implicit_struct(v);
 out:
     error_propagate(errp, err);
 }
Signature · 1 line
2.5.0
#61 lore raw

Re: [Qemu-devel] [PATCH v9 18/37] qapi: Drop unused error argument for list and implicit struct

Quoted 2 lines · Eric Blake

No backend was setting an error when ending the visit of a list or implicit struct.

That's a lie: qmp_input_end_list() does. But it shouldn't, as you explain below. Rephrase the commit message?

Quoted 11 lines

Make the callers a bit easier to follow by
making this a part of the contract, and removing the errp argument - callers can then unconditionally end an object as part of cleanup without having to think about whether a second error is dominated by a first, because there is no second error.

The only addition of &error_abort in this patch, in the function qmp_input_end_list(), will never trigger unless a programming bug creates a push(struct)/pop(list) or push(list)/pop(struct) mismatch.

Quoted 7 lines

A later patch will then tackle the larger task of splitting visit_end_struct(), which can indeed set an error (and that cleanup will also have the side-effect of removing the use of error_abort added here).

Patch looks good. I like the simplification.

author
#62 lore raw

Re: [Qemu-devel] [PATCH v9 18/37] qapi: Drop unused error argument for list and implicit struct

Quoted 7 lines · Markus Armbruster
Quoted 2 lines · Eric Blake

No backend was setting an error when ending the visit of a list or implicit struct.

That's a lie: qmp_input_end_list() does. But it shouldn't, as you explain below. Rephrase the commit message?

I'm not sure why you call it a lie - qmp_input_end_list() will not set an error unless it is mistakenly paired with a push(struct), which none of our code base does. Or put another way, although qmp_input_pop() [called by qmp_input_end_list()] has a signature that can set an error, closer inspection shows that it will only do so when invoked to close out a struct, and not when closing out a list. But that's a blatant programmer mismatch, which none of our code base does, so no well-formed use of visitors can cause qmp_input_end_list() to set an error.

Quoted 11 lines
Quoted 11 lines

Make the callers a bit easier to follow by
making this a part of the contract, and removing the errp argument - callers can then unconditionally end an object as part of cleanup without having to think about whether a second error is dominated by a first, because there is no second error.

The only addition of &error_abort in this patch, in the function qmp_input_end_list(), will never trigger unless a programming bug creates a push(struct)/pop(list) or push(list)/pop(struct) mismatch.

I'm open to wording suggestions.

Maybe replace all of the above with:

None of the existing .end_implicit_struct() implementations use errp. And of the existing .end_list() implementations, only qmp_input_end_list() even uses errp, but closer inspection shows that it will never be modified (errp is only passed to qmp_input_pop(), which will only set an error if the corresponding push was a struct rather than a list). We can turn that internal usage into an &error_abort, to protect against programmer mistakes of push(struct)/pop(list) or push(list)/pop(struct) mismatch.

With that done, we can then make all public uses of visit_end_implicit_struct() and visit_end_list() easier to follow by removing the errp argument and making error-free operation part of the contract. Callers can then unconditionally end an object as part of cleanup without having to think about whether a second error is dominated by a first, because there is no possibility of a second error.

Quoted 10 lines
Quoted 8 lines

A later patch will then tackle the larger task of splitting visit_end_struct(), which can indeed set an error (and that cleanup will also have the side-effect of removing the use of error_abort added here).

Patch looks good. I like the simplification.

Would help to split this into two patches, one switching from qmp_input_pop(errp) into qmp_input_pop(&error_abort), and the other then removing unused errp argument?

Signature · 2 lines
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org
#63 lore raw

Re: [Qemu-devel] [PATCH v9 18/37] qapi: Drop unused error argument for list and implicit struct

Quoted 9 lines · Eric Blake
Quoted 7 lines · Markus Armbruster
Quoted 2 lines · Eric Blake

No backend was setting an error when ending the visit of a list or implicit struct.

That's a lie: qmp_input_end_list() does. But it shouldn't, as you explain below. Rephrase the commit message?

Quoted 8 lines

I'm not sure why you call it a lie - qmp_input_end_list() will not set an error unless it is mistakenly paired with a push(struct), which none of our code base does. Or put another way, although qmp_input_pop() [called by qmp_input_end_list()] has a signature that can set an error, closer inspection shows that it will only do so when invoked to close out a struct, and not when closing out a list. But that's a blatant programmer mismatch, which none of our code base does, so no well-formed use of visitors can cause qmp_input_end_list() to set an error.

Okay, it's not a lie if you consider the whole program. It looks like a lie locally.

Quoted 24 lines
Quoted 10 lines
Quoted 10 lines

Make the callers a bit easier to follow by
making this a part of the contract, and removing the errp argument - callers can then unconditionally end an object as part of cleanup without having to think about whether a second error is dominated by a first, because there is no second error.

The only addition of &error_abort in this patch, in the function qmp_input_end_list(), will never trigger unless a programming bug creates a push(struct)/pop(list) or push(list)/pop(struct) mismatch.

I'm open to wording suggestions.

Maybe replace all of the above with:

None of the existing .end_implicit_struct() implementations use errp. And of the existing .end_list() implementations, only qmp_input_end_list() even uses errp, but closer inspection shows that it will never be modified (errp is only passed to qmp_input_pop(), which will only set an error if the corresponding push was a struct rather than a list). We can turn that internal usage into an &error_abort, to protect against programmer mistakes of push(struct)/pop(list) or push(list)/pop(struct) mismatch.

Quoted 6 lines

With that done, we can then make all public uses of visit_end_implicit_struct() and visit_end_list() easier to follow by removing the errp argument and making error-free operation part of the contract. Callers can then unconditionally end an object as part of cleanup without having to think about whether a second error is dominated by a first, because there is no possibility of a second error.

Works for me.

Quoted 5 lines
Quoted 5 lines
Quoted 5 lines

A later patch will then tackle the larger task of splitting visit_end_struct(), which can indeed set an error (and that cleanup will also have the side-effect of removing the use of error_abort added here).

Quoted 8 lines
Quoted 4 lines
Quoted 2 lines

Patch looks good. I like the simplification.

Would help to split this into two patches, one switching from qmp_input_pop(errp) into qmp_input_pop(&error_abort), and the other then removing unused errp argument?

If it results in more readable commit messages.

author
#64 lore raw

PATCH v9 19/37 qmp: Fix reference-counting of qnull on empty output visit

In reply to Eric Blake

Commit 6c2f9a15 ensured that we would not return NULL when the caller used an output visitor but had nothing to visit. But in doing so, it added a FIXME about a reference count leak that could abort qemu in the (unlikely) case of SIZE_MAX such visits (more plausible on 32-bit). (Although that commit suggested we might fix it in time for 2.5, we ran out of time; fortunately, it is unlikely enough to bite that it was not worth worrying about during the 2.5 release.)

This fixes things by documenting the internal contracts, and explaining why the internal function can return NULL and only the public facing interface needs to worry about qnull(), thus avoiding over-referencing the qnull_ global object.

It does not, however, fix the stupidity of the stack mixing up two separate pieces of information; add a FIXME to explain that issue, which will be fixed shortly in a future patch.

---
v9: enhance commit message
v8: rebase to earlier changes
v7: cc qemu-stable, tweak some asserts, drop stale comment, add more comments
v6: no change

---
 qapi/qmp-output-visitor.c       | 39 ++++++++++++++++++++++++++++++++-------
 tests/test-qmp-output-visitor.c |  2 ++
 2 files changed, 34 insertions(+), 7 deletions(-)
qapi/qmp-output-visitor.c +32 -7
index d367148..316f4e4 100644
@@ -29,6 +29,15 @@ typedef QTAILQ_HEAD(QStack, QStackEntry) QStack;
 struct QmpOutputVisitor
 {
     Visitor visitor;
+    /* FIXME: we are abusing stack to hold two separate pieces of
+     * information: the current root object in slot 0, and the stack
+     * of N objects still being built in slots 1 through N (for N+1
+     * slots in use).  Worse, our behavior is inconsistent:
+     * qmp_output_add_obj() visiting two top-level scalars in a row
+     * discards the first in favor of the second, but visiting two
+     * top-level objects in a row tries to append the second object
+     * into the first (since the first object was placed in the stack
+     * in both slot 0 and 1, but only popped from slot 1).  */
     QStack stack;
 };
 
@@ -41,10 +50,12 @@ static QmpOutputVisitor *to_qov(Visitor *v)
     return container_of(v, QmpOutputVisitor, visitor);
 }
 
+/* Push @value onto the stack of current QObjects being built */
 static void qmp_output_push_obj(QmpOutputVisitor *qov, QObject *value)
 {
     QStackEntry *e = g_malloc0(sizeof(*e));
 
+    assert(value);
     e->value = value;
     if (qobject_type(e->value) == QTYPE_QLIST) {
         e->is_list_head = true;
@@ -52,44 +63,51 @@ static void qmp_output_push_obj(QmpOutputVisitor *qov, QObject *value)
     QTAILQ_INSERT_HEAD(&qov->stack, e, node);
 }
 
+/* Grab and remove the most recent QObject from the stack */
 static QObject *qmp_output_pop(QmpOutputVisitor *qov)
 {
     QStackEntry *e = QTAILQ_FIRST(&qov->stack);
     QObject *value;
+
+    assert(e);
     QTAILQ_REMOVE(&qov->stack, e, node);
     value = e->value;
     g_free(e);
     return value;
 }
 
+/* Grab the root QObject, if any, in preparation to empty the stack */
 static QObject *qmp_output_first(QmpOutputVisitor *qov)
 {
     QStackEntry *e = QTAILQ_LAST(&qov->stack, QStack);
 
-    /*
-     * FIXME Wrong, because qmp_output_get_qobject() will increment
-     * the refcnt *again*.  We need to think through how visitors
-     * handle null.
-     */
     if (!e) {
-        return qnull();
+        /* No root */
+        return NULL;
     }
-
+    assert(e->value);
     return e->value;
 }
 
+/* Grab the most recent QObject from the stack, which must exist */
 static QObject *qmp_output_last(QmpOutputVisitor *qov)
 {
     QStackEntry *e = QTAILQ_FIRST(&qov->stack);
+
+    assert(e && e->value);
     return e->value;
 }
 
+/* Add @value to the current QObject being built.
+ * If the stack is visiting a dictionary or list, @value is now owned
+ * by that container. Otherwise, @value is now the root.  */
 static void qmp_output_add_obj(QmpOutputVisitor *qov, const char *name,
                                QObject *value)
 {
     QObject *cur;
 
     if (QTAILQ_EMPTY(&qov->stack)) {
+        /* Stack was empty, track this object as root */
         qmp_output_push_obj(qov, value);
         return;
     }
@@ -98,13 +116,17 @@ static void qmp_output_add_obj(QmpOutputVisitor *qov, const char *name,
 
     switch (qobject_type(cur)) {
     case QTYPE_QDICT:
+        assert(name);
         qdict_put_obj(qobject_to_qdict(cur), name, value);
         break;
     case QTYPE_QLIST:
         qlist_append_obj(qobject_to_qlist(cur), value);
         break;
     default:
+        /* The previous root was a scalar, replace it with a new root */
+        /* FIXME this is abusing the stack; see comment above */
         qobject_decref(qmp_output_pop(qov));
+        assert(QTAILQ_EMPTY(&qov->stack));
         qmp_output_push_obj(qov, value);
         break;
     }
@@ -205,11 +227,14 @@ static void qmp_output_type_any(Visitor *v, const char *name, QObject **obj,
     qmp_output_add_obj(qov, name, *obj);
 }
 
+/* Finish building, and return the root object. Will not be NULL. */
 QObject *qmp_output_get_qobject(QmpOutputVisitor *qov)
 {
     QObject *obj = qmp_output_first(qov);
     if (obj) {
         qobject_incref(obj);
+    } else {
+        obj = qnull();
     }
     return obj;
 }
tests/test-qmp-output-visitor.c +2 -0
index 4df94bc..26dc752 100644
@@ -461,6 +461,8 @@ static void test_visitor_out_empty(TestOutputVisitorData *data,
 
     arg = qmp_output_get_qobject(data->qov);
     g_assert(qobject_type(arg) == QTYPE_QNULL);
+    /* Check that qnull reference counting is sane */
+    g_assert(arg->refcnt == 2);
     qobject_decref(arg);
 }
 
Signature · 1 line
2.5.0
#65 lore raw

Re: [Qemu-devel] [PATCH v9 19/37] qmp: Fix reference-counting of qnull on empty output visit

Quoted 71 lines · Eric Blake

Commit 6c2f9a15 ensured that we would not return NULL when the caller used an output visitor but had nothing to visit. But in doing so, it added a FIXME about a reference count leak that could abort qemu in the (unlikely) case of SIZE_MAX such visits (more plausible on 32-bit). (Although that commit suggested we might fix it in time for 2.5, we ran out of time; fortunately, it is unlikely enough to bite that it was not worth worrying about during the 2.5 release.)

This fixes things by documenting the internal contracts, and explaining why the internal function can return NULL and only the public facing interface needs to worry about qnull(), thus avoiding over-referencing the qnull_ global object.

It does not, however, fix the stupidity of the stack mixing up two separate pieces of information; add a FIXME to explain that issue, which will be fixed shortly in a future patch.

---
v9: enhance commit message
v8: rebase to earlier changes
v7: cc qemu-stable, tweak some asserts, drop stale comment, add more comments
v6: no change

---
 qapi/qmp-output-visitor.c       | 39 ++++++++++++++++++++++++++++++++-------
 tests/test-qmp-output-visitor.c |  2 ++
 2 files changed, 34 insertions(+), 7 deletions(-)
qapi/qmp-output-visitor.c +12 -0
index d367148..316f4e4 100644
@@ -29,6 +29,15 @@ typedef QTAILQ_HEAD(QStack, QStackEntry) QStack;
 struct QmpOutputVisitor
 {
     Visitor visitor;
+    /* FIXME: we are abusing stack to hold two separate pieces of
+     * information: the current root object in slot 0, and the stack
+     * of N objects still being built in slots 1 through N (for N+1
+     * slots in use).  Worse, our behavior is inconsistent:
+     * qmp_output_add_obj() visiting two top-level scalars in a row
+     * discards the first in favor of the second, but visiting two
+     * top-level objects in a row tries to append the second object
+     * into the first (since the first object was placed in the stack
+     * in both slot 0 and 1, but only popped from slot 1).  */
     QStack stack;
 };
 
@@ -41,10 +50,12 @@ static QmpOutputVisitor *to_qov(Visitor *v)
     return container_of(v, QmpOutputVisitor, visitor);
 }
 
+/* Push @value onto the stack of current QObjects being built */
 static void qmp_output_push_obj(QmpOutputVisitor *qov, QObject *value)
 {
     QStackEntry *e = g_malloc0(sizeof(*e));
 
+    assert(value);
     e->value = value;
     if (qobject_type(e->value) == QTYPE_QLIST) {
         e->is_list_head = true;
@@ -52,44 +63,51 @@ static void qmp_output_push_obj(QmpOutputVisitor *qov, QObject *value)
     QTAILQ_INSERT_HEAD(&qov->stack, e, node);
 }
 
+/* Grab and remove the most recent QObject from the stack */

qapi/qmp-output-visitor.c static void qmp_output_push_obj(QmpOutputVisitor *qov, QObject *value) · line 76

Quoted 10 lines
qapi/qmp-output-visitor.c +2 -0
 static QObject *qmp_output_pop(QmpOutputVisitor *qov)
 {
     QStackEntry *e = QTAILQ_FIRST(&qov->stack);
     QObject *value;
+
+    assert(e);
     QTAILQ_REMOVE(&qov->stack, e, node);
     value = e->value;
     g_free(e);
     return value;

@value cannot be null here, because we never push nulls. Worth an assertion, just to help readers?

qapi/qmp-output-visitor.c static void qmp_output_push_obj(QmpOutputVisitor *qov, QObject *value) · line 79

Quoted 3 lines
qapi/qmp-output-visitor.c +1 -0
 }
 
+/* Grab the root QObject, if any, in preparation to empty the stack */

Why is this "in preparation to empty the stack"?

Quoted 8 lines
qapi/qmp-output-visitor.c +0 -4
 static QObject *qmp_output_first(QmpOutputVisitor *qov)
 {
     QStackEntry *e = QTAILQ_LAST(&qov->stack, QStack);
 
-    /*
-     * FIXME Wrong, because qmp_output_get_qobject() will increment
-     * the refcnt *again*.  We need to think through how visitors
-     * handle null.

qapi/qmp-output-visitor.c static void qmp_output_push_obj(QmpOutputVisitor *qov, QObject *value) · line 90

Quoted 10 lines
qapi/qmp-output-visitor.c +3 -3
-     */
     if (!e) {
-        return qnull();
+        /* No root */
+        return NULL;
     }
-
+    assert(e->value);
     return e->value;
 }

Two callers to check: qmp_output_get_qobject() and qmp_output_visitor_cleanup(). See below.

Quoted 44 lines
qapi/qmp-output-visitor.c +11 -0
+/* Grab the most recent QObject from the stack, which must exist */
 static QObject *qmp_output_last(QmpOutputVisitor *qov)
 {
     QStackEntry *e = QTAILQ_FIRST(&qov->stack);
+
+    assert(e && e->value);
     return e->value;
 }
 
+/* Add @value to the current QObject being built.
+ * If the stack is visiting a dictionary or list, @value is now owned
+ * by that container. Otherwise, @value is now the root.  */
 static void qmp_output_add_obj(QmpOutputVisitor *qov, const char *name,
                                QObject *value)
 {
     QObject *cur;
 
     if (QTAILQ_EMPTY(&qov->stack)) {
+        /* Stack was empty, track this object as root */
         qmp_output_push_obj(qov, value);
         return;
     }
@@ -98,13 +116,17 @@ static void qmp_output_add_obj(QmpOutputVisitor *qov, const char *name,
 
     switch (qobject_type(cur)) {
     case QTYPE_QDICT:
+        assert(name);
         qdict_put_obj(qobject_to_qdict(cur), name, value);
         break;
     case QTYPE_QLIST:
         qlist_append_obj(qobject_to_qlist(cur), value);
         break;
     default:
+        /* The previous root was a scalar, replace it with a new root */
+        /* FIXME this is abusing the stack; see comment above */
         qobject_decref(qmp_output_pop(qov));
+        assert(QTAILQ_EMPTY(&qov->stack));
         qmp_output_push_obj(qov, value);
         break;
     }
@@ -205,11 +227,14 @@ static void qmp_output_type_any(Visitor *v, const char *name, QObject **obj,
     qmp_output_add_obj(qov, name, *obj);
 }

qapi/qmp-output-visitor.c static void qmp_output_type_any(Visitor *v, const char *name, QObject **obj, · line 238

Quoted 10 lines
qapi/qmp-output-visitor.c +3 -0
 
+/* Finish building, and return the root object. Will not be NULL. */
 QObject *qmp_output_get_qobject(QmpOutputVisitor *qov)
 {
     QObject *obj = qmp_output_first(qov);
     if (obj) {
         qobject_incref(obj);
+    } else {
+        obj = qnull();
     }

qmp_output_first() now returns NULL instead of qnull(). This changes compensates; taken together, the beavior is the same, except we avoid the qobject_incref() in the qnull() case. That's the bug fix.

Aside: I believe obj could not be null before this patch, so the conditional was redundant. No need to complicate the commit message with this, I think.

qapi/qmp-output-visitor.c static void qmp_output_type_any(Visitor *v, const char *name, QObject **obj, · line 240

Quoted 2 lines
qapi/qmp-output-visitor.c +0 -0
     return obj;
 }

Unchanged:

   void qmp_output_visitor_cleanup(QmpOutputVisitor *v)
   {
       QStackEntry *e, *tmp;
       /* The bottom QStackEntry, if any, owns the root QObject. See the
        * qmp_output_push_obj() invocations in qmp_output_add_obj(). */
       QObject *root = QTAILQ_EMPTY(&v->stack) ? NULL : qmp_output_first(v);

Calls qmp_output_first() only when the stack isn't empty, and then qmp_output_first() behaves exactly as before this patch. Good.

       QTAILQ_FOREACH_SAFE(e, &v->stack, node, tmp) {
           QTAILQ_REMOVE(&v->stack, e, node);
           g_free(e);
       }

       qobject_decref(root);
       g_free(v);

}

Quoted 12 lines
tests/test-qmp-output-visitor.c +2 -0
index 4df94bc..26dc752 100644
@@ -461,6 +461,8 @@ static void test_visitor_out_empty(TestOutputVisitorData *data,
 
     arg = qmp_output_get_qobject(data->qov);
     g_assert(qobject_type(arg) == QTYPE_QNULL);
+    /* Check that qnull reference counting is sane */
+    g_assert(arg->refcnt == 2);
     qobject_decref(arg);
 }
#66 lore raw

Re: [Qemu-devel] [PATCH v9 19/37] qmp: Fix reference-counting of qnull on empty output visit

Quoted 39 lines · Markus Armbruster
Quoted 37 lines · Eric Blake

Commit 6c2f9a15 ensured that we would not return NULL when the caller used an output visitor but had nothing to visit. But in doing so, it added a FIXME about a reference count leak that could abort qemu in the (unlikely) case of SIZE_MAX such visits (more plausible on 32-bit). (Although that commit suggested we might fix it in time for 2.5, we ran out of time; fortunately, it is unlikely enough to bite that it was not worth worrying about during the 2.5 release.)

This fixes things by documenting the internal contracts, and explaining why the internal function can return NULL and only the public facing interface needs to worry about qnull(), thus avoiding over-referencing the qnull_ global object.

It does not, however, fix the stupidity of the stack mixing up two separate pieces of information; add a FIXME to explain that issue, which will be fixed shortly in a future patch.

---
v9: enhance commit message
v8: rebase to earlier changes
v7: cc qemu-stable, tweak some asserts, drop stale comment, add more comments
v6: no change

---
 qapi/qmp-output-visitor.c       | 39 ++++++++++++++++++++++++++++++++-------
 tests/test-qmp-output-visitor.c |  2 ++
 2 files changed, 34 insertions(+), 7 deletions(-)
qapi/qmp-output-visitor.c +0 -0
index d367148..316f4e4 100644

[...]

Quoted 17 lines
Quoted 17 lines
qapi/qmp-output-visitor.c +2 -0
@@ -41,10 +50,12 @@ static QmpOutputVisitor *to_qov(Visitor *v)
     return container_of(v, QmpOutputVisitor, visitor);
 }
 
+/* Push @value onto the stack of current QObjects being built */
 static void qmp_output_push_obj(QmpOutputVisitor *qov, QObject *value)
 {
     QStackEntry *e = g_malloc0(sizeof(*e));
 
+    assert(value);
     e->value = value;
     if (qobject_type(e->value) == QTYPE_QLIST) {
         e->is_list_head = true;
@@ -52,44 +63,51 @@ static void qmp_output_push_obj(QmpOutputVisitor *qov, QObject *value)
     QTAILQ_INSERT_HEAD(&qov->stack, e, node);
 }
 
Quoted 1 line

qapi/qmp-output-visitor.c static void qmp_output_push_obj(QmpOutputVisitor *qov, QObject *value) · line 66

Quoted 1 line
qapi/qmp-output-visitor.c +1 -0
+/* Grab and remove the most recent QObject from the stack */

Let's stick to the stack terminology you used for qmp_output_push_obj():

/* Pop a value off the stack of QObjects being built, and return it */

Quoted 15 lines

qapi/qmp-output-visitor.c static void qmp_output_push_obj(QmpOutputVisitor *qov, QObject *value) · line 76

Quoted 10 lines
qapi/qmp-output-visitor.c +2 -0
 static QObject *qmp_output_pop(QmpOutputVisitor *qov)
 {
     QStackEntry *e = QTAILQ_FIRST(&qov->stack);
     QObject *value;
+
+    assert(e);
     QTAILQ_REMOVE(&qov->stack, e, node);
     value = e->value;
     g_free(e);
     return value;

@value cannot be null here, because we never push nulls. Worth an assertion, just to help readers?

Quoted 1 line
qapi/qmp-output-visitor.c +0 -0
 }

[...]

Quoted 1 line
Quoted 1 line

+/* Grab the most recent QObject from the stack, which must exist */

Stack terminology:

/*
* Peek at the top of the stack of QObject being built.
* The stack must not be empty.
*/

Quoted 7 lines
Quoted 7 lines

static QObject *qmp_output_last(QmpOutputVisitor *qov)

 {
     QStackEntry *e = QTAILQ_FIRST(&qov->stack);
qapi/qmp-output-visitor.c +2 -0
+
+    assert(e && e->value);
     return e->value;
 }

[...]

author
#67 lore raw

PATCH v9 20/37 qmp: Don't abuse stack to track qmp-output root

In reply to Eric Blake

The previous commit documented an inconsistency in how we are using the stack of qmp-output-visitor. Normally, pushing a single top-level object puts the object on the stack twice:
once as the root, and once as the current container being appended to; but popping that struct only pops once. However, qmp_ouput_add() was trying to either set up the added object as the new root (works if you parse two top-level scalars in a
row: the second replaces the first as the root) or as a member of the current container (works as long as you have an open container on the stack; but if you have popped the first top-level container, it then resolves to the root and still tries to add into that existing container).

Fix the stupidity by not tracking two separate things in the stack. Drop the now-useless qmp_output_first() while at it.

Saved for a later patch: we still are rather sloppy in that qmp_output_get_object() can be called in the middle of a parse, rather than requiring that a visit is complete.

---
v9: no change
v8: rebase to earlier changes
v7: retitle; rebase to earlier changes, drop qmp_output_first()
v6: no change

---
 qapi/qmp-output-visitor.c | 79 ++++++++++++++++-------------------------------
 1 file changed, 26 insertions(+), 53 deletions(-)
qapi/qmp-output-visitor.c +26 -53
index 316f4e4..df22999 100644
@@ -29,16 +29,8 @@ typedef QTAILQ_HEAD(QStack, QStackEntry) QStack;
 struct QmpOutputVisitor
 {
     Visitor visitor;
-    /* FIXME: we are abusing stack to hold two separate pieces of
-     * information: the current root object in slot 0, and the stack
-     * of N objects still being built in slots 1 through N (for N+1
-     * slots in use).  Worse, our behavior is inconsistent:
-     * qmp_output_add_obj() visiting two top-level scalars in a row
-     * discards the first in favor of the second, but visiting two
-     * top-level objects in a row tries to append the second object
-     * into the first (since the first object was placed in the stack
-     * in both slot 0 and 1, but only popped from slot 1).  */
-    QStack stack;
+    QStack stack; /* Stack of containers that haven't yet been finished */
+    QObject *root; /* Root of the output visit */
 };
 
 #define qmp_output_add(qov, name, value) \
@@ -55,6 +47,7 @@ static void qmp_output_push_obj(QmpOutputVisitor *qov, QObject *value)
 {
     QStackEntry *e = g_malloc0(sizeof(*e));
 
+    assert(qov->root);
     assert(value);
     e->value = value;
     if (qobject_type(e->value) == QTYPE_QLIST) {
@@ -76,26 +69,12 @@ static QObject *qmp_output_pop(QmpOutputVisitor *qov)
     return value;
 }
 
-/* Grab the root QObject, if any, in preparation to empty the stack */
-static QObject *qmp_output_first(QmpOutputVisitor *qov)
-{
-    QStackEntry *e = QTAILQ_LAST(&qov->stack, QStack);
-
-    if (!e) {
-        /* No root */
-        return NULL;
-    }
-    assert(e->value);
-    return e->value;
-}
-
-/* Grab the most recent QObject from the stack, which must exist */
+/* Grab the most recent QObject from the stack, if any */
 static QObject *qmp_output_last(QmpOutputVisitor *qov)
 {
     QStackEntry *e = QTAILQ_FIRST(&qov->stack);
 
-    assert(e && e->value);
-    return e->value;
+    return e ? e->value : NULL;
 }
 
 /* Add @value to the current QObject being built.
@@ -106,29 +85,25 @@ static void qmp_output_add_obj(QmpOutputVisitor *qov, const char *name,
 {
     QObject *cur;
 
-    if (QTAILQ_EMPTY(&qov->stack)) {
-        /* Stack was empty, track this object as root */
-        qmp_output_push_obj(qov, value);
-        return;
-    }
-
     cur = qmp_output_last(qov);
 
-    switch (qobject_type(cur)) {
-    case QTYPE_QDICT:
-        assert(name);
-        qdict_put_obj(qobject_to_qdict(cur), name, value);
-        break;
-    case QTYPE_QLIST:
-        qlist_append_obj(qobject_to_qlist(cur), value);
-        break;
-    default:
-        /* The previous root was a scalar, replace it with a new root */
-        /* FIXME this is abusing the stack; see comment above */
-        qobject_decref(qmp_output_pop(qov));
-        assert(QTAILQ_EMPTY(&qov->stack));
-        qmp_output_push_obj(qov, value);
-        break;
+    if (!cur) {
+        /* FIXME we should require the user to reset the visitor, rather
+         * than throwing away the previous root */
+        qobject_decref(qov->root);
+        qov->root = value;
+    } else {
+        switch (qobject_type(cur)) {
+        case QTYPE_QDICT:
+            assert(name);
+            qdict_put_obj(qobject_to_qdict(cur), name, value);
+            break;
+        case QTYPE_QLIST:
+            qlist_append_obj(qobject_to_qlist(cur), value);
+            break;
+        default:
+            g_assert_not_reached();
+        }
     }
 }
 
@@ -230,7 +205,9 @@ static void qmp_output_type_any(Visitor *v, const char *name, QObject **obj,
 /* Finish building, and return the root object. Will not be NULL. */
 QObject *qmp_output_get_qobject(QmpOutputVisitor *qov)
 {
-    QObject *obj = qmp_output_first(qov);
+    /* FIXME: we should require that a visit occurred, and that it is
+     * complete (no starts without a matching end) */
+    QObject *obj = qov->root;
     if (obj) {
         qobject_incref(obj);
     } else {
@@ -248,16 +225,12 @@ void qmp_output_visitor_cleanup(QmpOutputVisitor *v)
 {
     QStackEntry *e, *tmp;
 
-    /* The bottom QStackEntry, if any, owns the root QObject. See the
-     * qmp_output_push_obj() invocations in qmp_output_add_obj(). */
-    QObject *root = QTAILQ_EMPTY(&v->stack) ? NULL : qmp_output_first(v);
-
     QTAILQ_FOREACH_SAFE(e, &v->stack, node, tmp) {
         QTAILQ_REMOVE(&v->stack, e, node);
         g_free(e);
     }
 
-    qobject_decref(root);
+    qobject_decref(v->root);
     g_free(v);
 }
 
Signature · 1 line
2.5.0
#68 lore raw

Re: [Qemu-devel] [PATCH v9 20/37] qmp: Don't abuse stack to track qmp-output root

Quoted 56 lines · Eric Blake

The previous commit documented an inconsistency in how we are using the stack of qmp-output-visitor. Normally, pushing a single top-level object puts the object on the stack twice:
once as the root, and once as the current container being appended to; but popping that struct only pops once. However, qmp_ouput_add() was trying to either set up the added object as the new root (works if you parse two top-level scalars in a
row: the second replaces the first as the root) or as a member of the current container (works as long as you have an open container on the stack; but if you have popped the first top-level container, it then resolves to the root and still tries to add into that existing container).

Fix the stupidity by not tracking two separate things in the stack. Drop the now-useless qmp_output_first() while at it.

Saved for a later patch: we still are rather sloppy in that qmp_output_get_object() can be called in the middle of a parse, rather than requiring that a visit is complete.

---
v9: no change
v8: rebase to earlier changes
v7: retitle; rebase to earlier changes, drop qmp_output_first()
v6: no change

---
 qapi/qmp-output-visitor.c | 79 ++++++++++++++++-------------------------------
 1 file changed, 26 insertions(+), 53 deletions(-)
qapi/qmp-output-visitor.c +2 -10
index 316f4e4..df22999 100644
@@ -29,16 +29,8 @@ typedef QTAILQ_HEAD(QStack, QStackEntry) QStack;
 struct QmpOutputVisitor
 {
     Visitor visitor;
-    /* FIXME: we are abusing stack to hold two separate pieces of
-     * information: the current root object in slot 0, and the stack
-     * of N objects still being built in slots 1 through N (for N+1
-     * slots in use).  Worse, our behavior is inconsistent:
-     * qmp_output_add_obj() visiting two top-level scalars in a row
-     * discards the first in favor of the second, but visiting two
-     * top-level objects in a row tries to append the second object
-     * into the first (since the first object was placed in the stack
-     * in both slot 0 and 1, but only popped from slot 1).  */
-    QStack stack;
+    QStack stack; /* Stack of containers that haven't yet been finished */
+    QObject *root; /* Root of the output visit */
 };
 
 #define qmp_output_add(qov, name, value) \

qapi/qmp-output-visitor.c static void qmp_output_push_obj(QmpOutputVisitor *qov, QObject *value) · line 50

Quoted 4 lines
qapi/qmp-output-visitor.c +1 -0
@@ -55,6 +47,7 @@ static void qmp_output_push_obj(QmpOutputVisitor *qov, QObject *value)
 {
     QStackEntry *e = g_malloc0(sizeof(*e));
 
+    assert(qov->root);

This is safe because every call is preceded by qmp_output_add(), which creates the root if we don't have one, yet.

Quoted 20 lines
qapi/qmp-output-visitor.c +0 -13
     assert(value);
     e->value = value;
     if (qobject_type(e->value) == QTYPE_QLIST) {
@@ -76,26 +69,12 @@ static QObject *qmp_output_pop(QmpOutputVisitor *qov)
     return value;
 }
 
-/* Grab the root QObject, if any, in preparation to empty the stack */
-static QObject *qmp_output_first(QmpOutputVisitor *qov)
-{
-    QStackEntry *e = QTAILQ_LAST(&qov->stack, QStack);
-
-    if (!e) {
-        /* No root */
-        return NULL;
-    }
-    assert(e->value);
-    return e->value;
-}
-

qapi/qmp-output-visitor.c static QObject *qmp_output_pop(QmpOutputVisitor *qov) · line 78

Quoted 10 lines
qapi/qmp-output-visitor.c +2 -3
-/* Grab the most recent QObject from the stack, which must exist */
+/* Grab the most recent QObject from the stack, if any */
 static QObject *qmp_output_last(QmpOutputVisitor *qov)
 {
     QStackEntry *e = QTAILQ_FIRST(&qov->stack);
 
-    assert(e && e->value);
-    return e->value;
+    return e ? e->value : NULL;
 }

Okay, because...

qapi/qmp-output-visitor.c static void qmp_output_add_obj(QmpOutputVisitor *qov, const char *name, · line 88

Quoted 13 lines
qapi/qmp-output-visitor.c +0 -6
 /* Add @value to the current QObject being built.
@@ -106,29 +85,25 @@ static void qmp_output_add_obj(QmpOutputVisitor *qov, const char *name,
 {
     QObject *cur;
 
-    if (QTAILQ_EMPTY(&qov->stack)) {
-        /* Stack was empty, track this object as root */
-        qmp_output_push_obj(qov, value);
-        return;
-    }
-
     cur = qmp_output_last(qov);

... this is the only caller, and...

Quoted 7 lines
qapi/qmp-output-visitor.c +0 -6
-    switch (qobject_type(cur)) {
-    case QTYPE_QDICT:
-        assert(name);
-        qdict_put_obj(qobject_to_qdict(cur), name, value);
-        break;
-    case QTYPE_QLIST:

qapi/qmp-output-visitor.c static void qmp_output_add_obj(QmpOutputVisitor *qov, const char *name, · line 90

Quoted 10 lines
qapi/qmp-output-visitor.c +1 -9
-        qlist_append_obj(qobject_to_qlist(cur), value);
-        break;
-    default:
-        /* The previous root was a scalar, replace it with a new root */
-        /* FIXME this is abusing the stack; see comment above */
-        qobject_decref(qmp_output_pop(qov));
-        assert(QTAILQ_EMPTY(&qov->stack));
-        qmp_output_push_obj(qov, value);
-        break;
+    if (!cur) {

... you add the null check.

Quoted 5 lines
qapi/qmp-output-visitor.c +5 -0
+        /* FIXME we should require the user to reset the visitor, rather
+         * than throwing away the previous root */
+        qobject_decref(qov->root);
+        qov->root = value;
+    } else {

qapi/qmp-output-visitor.c static void qmp_output_add_obj(QmpOutputVisitor *qov, const char *name, · line 105

Quoted 10 lines
qapi/qmp-output-visitor.c +10 -0
+        switch (qobject_type(cur)) {
+        case QTYPE_QDICT:
+            assert(name);
+            qdict_put_obj(qobject_to_qdict(cur), name, value);
+            break;
+        case QTYPE_QLIST:
+            qlist_append_obj(qobject_to_qlist(cur), value);
+            break;
+        default:
+            g_assert_not_reached();

We usually just abort().

qapi/qmp-output-visitor.c static void qmp_output_add_obj(QmpOutputVisitor *qov, const char *name, · line 108

Quoted 3 lines
qapi/qmp-output-visitor.c +1 -0
+        }
     }
 }

Let's see how this works.

We have a root and a stack of containers.

qmp_output_visitor_new() creates no root and an empty stack.

qmp_output_visitor_cleanup() empties the stack and throws away the root.

Visitors of scalars call qmp_output_add_obj(). Visitors of containers (object a.k.a. struct or array a.k.a. list) do the same, and additionally call qmp_output_push_obj(), in their start method. They call qmp_output_pop() in their end method. What does this do?

If the stack is empty (!cur), visiting a value replaces the root, if any. Begs the question how can we have a root, but let's ignore that for now.

If the stack isn't empty, we add to the container on the top of the stack.

If we're starting to visit a container, we push it onto the stack. It remains there until we end the container's visit.

Okay, this works.

After an outermost visit completes, the stack is empty, but the root lingers. It gets thrown away only when you reuse the visitor for another visit (do we do that?), or you destroy the visitor. Letting the root linger that way isn't nice, and that's what your FIXME points out.

If you abort a visit half-way through, the stack may be non-empty. You can't just start another visit then. You have to destroy the visitor and create a new one.

If we required a "reset" between visits, as your FIXME suggests, the difference between completed and aborted visits can be removed.

qapi/qmp-output-visitor.c static void qmp_output_type_any(Visitor *v, const char *name, QObject **obj, · line 209

Quoted 8 lines
qapi/qmp-output-visitor.c +2 -1
@@ -230,7 +205,9 @@ static void qmp_output_type_any(Visitor *v, const char *name, QObject **obj,
 /* Finish building, and return the root object. Will not be NULL. */
 QObject *qmp_output_get_qobject(QmpOutputVisitor *qov)
 {
-    QObject *obj = qmp_output_first(qov);
+    /* FIXME: we should require that a visit occurred, and that it is
+     * complete (no starts without a matching end) */

I agree the visit must complete before you can retrieve the value.

I think there are two sane ways to recover from errors:

1. Require the client to empty the stack by calling the necessary end methods.

2. Allow the client to reset or destroy the visitor without calling end methods.

*This* visitor would be fine with either. I guess the others would be fine, too. So it's a question of interface design.

I'm currently leaning towards 2, because "you must do A, B and C before you can destroy this object" would be weird. What do you think?

qapi/qmp-output-visitor.c void qmp_output_visitor_cleanup(QmpOutputVisitor *v) · line 254

Quoted 12 lines
qapi/qmp-output-visitor.c +1 -4
+    QObject *obj = qov->root;
     if (obj) {
         qobject_incref(obj);
     } else {
@@ -248,16 +225,12 @@ void qmp_output_visitor_cleanup(QmpOutputVisitor *v)
 {
     QStackEntry *e, *tmp;
 
-    /* The bottom QStackEntry, if any, owns the root QObject. See the
-     * qmp_output_push_obj() invocations in qmp_output_add_obj(). */
-    QObject *root = QTAILQ_EMPTY(&v->stack) ? NULL : qmp_output_first(v);
-

If we require end methods to be called, the stack must be empty here, rendering the following loop useless.

Quoted 9 lines
qapi/qmp-output-visitor.c +1 -1
     QTAILQ_FOREACH_SAFE(e, &v->stack, node, tmp) {
         QTAILQ_REMOVE(&v->stack, e, node);
         g_free(e);
     }
 
-    qobject_decref(root);
+    qobject_decref(v->root);
     g_free(v);
 }
author
#69 lore raw

Re: [Qemu-devel] [PATCH v9 20/37] qmp: Don't abuse stack to track qmp-output root

Quoted 34 lines · Markus Armbruster
Quoted 21 lines · Eric Blake

The previous commit documented an inconsistency in how we are using the stack of qmp-output-visitor. Normally, pushing a single top-level object puts the object on the stack twice:
once as the root, and once as the current container being appended to; but popping that struct only pops once. However, qmp_ouput_add() was trying to either set up the added object as the new root (works if you parse two top-level scalars in a
row: the second replaces the first as the root) or as a member of the current container (works as long as you have an open container on the stack; but if you have popped the first top-level container, it then resolves to the root and still tries to add into that existing container).

Fix the stupidity by not tracking two separate things in the stack. Drop the now-useless qmp_output_first() while at it.

Saved for a later patch: we still are rather sloppy in that qmp_output_get_object() can be called in the middle of a parse, rather than requiring that a visit is complete.

qapi/qmp-output-visitor.c static void qmp_output_add_obj(QmpOutputVisitor *qov, const char *name, · line 105

Quoted 10 lines
qapi/qmp-output-visitor.c +10 -0
+        switch (qobject_type(cur)) {
+        case QTYPE_QDICT:
+            assert(name);
+            qdict_put_obj(qobject_to_qdict(cur), name, value);
+            break;
+        case QTYPE_QLIST:
+            qlist_append_obj(qobject_to_qlist(cur), value);
+            break;
+        default:
+            g_assert_not_reached();
Quoted 1 line

We usually just abort().

But there are definitely existing examples, and it is a bit more self-documenting.

Quoted 16 lines

qapi/qmp-output-visitor.c static void qmp_output_type_any(Visitor *v, const char *name, QObject **obj, · line 209

Quoted 8 lines
qapi/qmp-output-visitor.c +2 -1
@@ -230,7 +205,9 @@ static void qmp_output_type_any(Visitor *v, const char *name, QObject **obj,
 /* Finish building, and return the root object. Will not be NULL. */
 QObject *qmp_output_get_qobject(QmpOutputVisitor *qov)
 {
-    QObject *obj = qmp_output_first(qov);
+    /* FIXME: we should require that a visit occurred, and that it is
+     * complete (no starts without a matching end) */

I agree the visit must complete before you can retrieve the value.

I think there are two sane ways to recover from errors:

1. Require the client to empty the stack by calling the necessary end methods.

Quoted 8 lines

2. Allow the client to reset or destroy the visitor without calling end methods.

*This* visitor would be fine with either. I guess the others would be fine, too. So it's a question of interface design.

I'm currently leaning towards 2, because "you must do A, B and C before you can destroy this object" would be weird. What do you think?

Patches later in the series revisit the question, and adding a reset also makes it more interesting to be able to reset at any point in a partial visit. For _this_ patch, I think we're okay, but this is probably the cutoff for what I'm sending in the first round of v10, saving all the trickier stuff for later.

Quoted 9 lines
Quoted 9 lines
qapi/qmp-output-visitor.c +1 -0
+    QObject *obj = qov->root;
     if (obj) {
         qobject_incref(obj);
     } else {
@@ -248,16 +225,12 @@ void qmp_output_visitor_cleanup(QmpOutputVisitor *v)
 {
     QStackEntry *e, *tmp;
 
Quoted 7 lines

qapi/qmp-output-visitor.c void qmp_output_visitor_cleanup(QmpOutputVisitor *v) · line 254

Quoted 4 lines
qapi/qmp-output-visitor.c +0 -4
-    /* The bottom QStackEntry, if any, owns the root QObject. See the
-     * qmp_output_push_obj() invocations in qmp_output_add_obj(). */
-    QObject *root = QTAILQ_EMPTY(&v->stack) ? NULL : qmp_output_first(v);
-

If we require end methods to be called, the stack must be empty here, rendering the following loop useless.

Yeah, an interesting observation that will affect what I do in 24/37.

Signature · 2 lines
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org
author
#70 lore raw

PATCH v9 21/37 qapi: Document visitor interfaces, add assertions

In reply to Eric Blake

The visitor interface for mapping between QObject/QemuOpts/string and qapi has formerly been documented only by reading source code, making it difficult to propose changes to either scripts/qapi*.py or to clients without knowing whether those changes would be safe. This adds documentation, including mentioning when parameters can be NULL, and where there are still some interface warts that would be nice to remove. In particular, I have plans to remove visit_start_union() in a future patch.

Add some asserts to strengthen the claims of the documentation; some of these were only made possible by recent cleanup commits. These were made easier with the addition of a new visit_is_output() helper (since all 2 output visitors of our 6 overall visitors use the same .type_enum() callback).

---
v9: no change
v8: rebase to 'name' motion
v7: retitle; more wording changes, add asserts to enforce the wording, place later in series to rebase on fixes that would otherwise trip the new assertions
v6: mention that input visitors blindly assign over *obj; wording improvements

---
 include/qapi/visitor-impl.h |  31 ++++++-
 include/qapi/visitor.h      | 196 ++++++++++++++++++++++++++++++++++++++++++++
 qapi/qapi-visit-core.c      |  39 ++++++++-
 3 files changed, 262 insertions(+), 4 deletions(-)
include/qapi/visitor-impl.h +30 -1
index 7f512cf..aab46bc 100644
@@ -15,23 +15,37 @@
 #include "qapi/error.h"
 #include "qapi/visitor.h"
 
+/* This file describes the callback interface for implementing a
+ * QObject visitor.  For the client interface, see visitor.h.  When
+ * implementing the callbacks, it is easiest to declare a struct with
+ * 'Visitor visitor;' as the first member.  Semantics for the
+ * callbacks are generally similar to the counterpart public
+ * interface.  */
+
 struct Visitor
 {
-    /* Must be set */
+    /* Must be provided to visit structs (the string visitors do not
+     * currently visit structs). */
     void (*start_struct)(Visitor *v, const char *name, void **obj,
                          size_t size, Error **errp);
+    /* Must be provided if start_struct is present. */
     void (*end_struct)(Visitor *v, Error **errp);
 
+    /* May be NULL; most useful for input visitors. */
     void (*start_implicit_struct)(Visitor *v, void **obj, size_t size,
                                   Error **errp);
     /* May be NULL */
     void (*end_implicit_struct)(Visitor *v);
 
+    /* Must be set */
     void (*start_list)(Visitor *v, const char *name, Error **errp);
+    /* Must be set */
     GenericList *(*next_list)(Visitor *v, GenericList **list, Error **errp);
     /* Must be set */
     void (*end_list)(Visitor *v);
 
+    /* Must be set, although the helpers input_type_enum() and
+     * output_type_enum() should be used if appropriate.  */
     void (*type_enum)(Visitor *v, const char *name, int *obj,
                       const char *const strings[], Error **errp);
     /* May be NULL; only needed for input visitors. */
@@ -47,23 +61,38 @@ struct Visitor
     /* Optional; fallback is type_uint64().  */
     void (*type_size)(Visitor *v, const char *name, uint64_t *obj,
                       Error **errp);
+
     /* Must be set. */
     void (*type_bool)(Visitor *v, const char *name, bool *obj, Error **errp);
+    /* Must be set */
     void (*type_str)(Visitor *v, const char *name, char **obj, Error **errp);
+
+    /* Must be provided to visit numbers (the opts visitor does not
+     * currently visit non-integers). */
     void (*type_number)(Visitor *v, const char *name, double *obj,
                         Error **errp);
+    /* Must be provided to visit arbitrary QTypes (the opts and string
+     * visitors do not currently visit arbitrary types).  */
     void (*type_any)(Visitor *v, const char *name, QObject **obj,
                      Error **errp);
 
     /* May be NULL; most useful for input visitors. */
     void (*optional)(Visitor *v, const char *name, bool *present);
 
+    /* FIXME - needs to be removed */
     bool (*start_union)(Visitor *v, bool data_present, Error **errp);
+    /* FIXME - needs to be removed */
     void (*end_union)(Visitor *v, bool data_present, Error **errp);
 };
 
+/**
+ * A generic visitor.type_enum suitable for input visitors.
+ */
 void input_type_enum(Visitor *v, const char *name, int *obj,
                      const char *const strings[], Error **errp);
+/**
+ * A generic visitor.type_enum suitable for output visitors.
+ */
 void output_type_enum(Visitor *v, const char *name, int *obj,
                       const char *const strings[], Error **errp);
 
include/qapi/visitor.h +196 -0

249 lines not on this page · raw message

qapi/qapi-visit-core.c +36 -3
index 2d3743b..1612d0d 100644
@@ -18,9 +18,21 @@
 #include "qapi/visitor.h"
 #include "qapi/visitor-impl.h"
 
+/* Determine if this is an output visitor.
+ * Useful for making some tighter assertions that hold for output
+ * visitors, but not for input or dealloc visitors. */
+static bool visit_is_output(Visitor *v)
+{
+    return v->type_enum == output_type_enum;
+}
+
 void visit_start_struct(Visitor *v, const char *name, void **obj,
                         size_t size, Error **errp)
 {
+    assert(obj ? size : !size);
+    if (obj && visit_is_output(v)) {
+        assert(*obj);
+    }
     v->start_struct(v, name, obj, size, errp);
 }
 
@@ -32,6 +44,10 @@ void visit_end_struct(Visitor *v, Error **errp)
 void visit_start_implicit_struct(Visitor *v, void **obj, size_t size,
                                  Error **errp)
 {
+    assert(obj && size);
+    if (visit_is_output(v)) {
+        assert(*obj);
+    }
     if (v->start_implicit_struct) {
         v->start_implicit_struct(v, obj, size, errp);
     }
@@ -51,6 +67,7 @@ void visit_start_list(Visitor *v, const char *name, Error **errp)
 
 GenericList *visit_next_list(Visitor *v, GenericList **list, Error **errp)
 {
+    assert(list);
     return v->next_list(v, list, errp);
 }
 
@@ -85,6 +102,7 @@ bool visit_optional(Visitor *v, const char *name, bool *present)
 void visit_get_next_type(Visitor *v, const char *name, QType *type,
                          bool promote_int, Error **errp)
 {
+    assert(type);
     if (v->get_next_type) {
         v->get_next_type(v, name, type, promote_int, errp);
     }
@@ -93,11 +111,13 @@ void visit_get_next_type(Visitor *v, const char *name, QType *type,
 void visit_type_enum(Visitor *v, const char *name, int *obj,
                      const char *const strings[], Error **errp)
 {
+    assert(obj && strings);
     v->type_enum(v, name, obj, strings, errp);
 }
 
 void visit_type_int(Visitor *v, const char *name, int64_t *obj, Error **errp)
 {
+    assert(obj);
     v->type_int64(v, name, obj, errp);
 }
 
@@ -145,6 +165,7 @@ void visit_type_uint32(Visitor *v, const char *name, uint32_t *obj,
 void visit_type_uint64(Visitor *v, const char *name, uint64_t *obj,
                        Error **errp)
 {
+    assert(obj);
     v->type_uint64(v, name, obj, errp);
 }
 
@@ -192,12 +213,14 @@ void visit_type_int32(Visitor *v, const char *name, int32_t *obj,
 void visit_type_int64(Visitor *v, const char *name, int64_t *obj,
                       Error **errp)
 {
+    assert(obj);
     v->type_int64(v, name, obj, errp);
 }
 
 void visit_type_size(Visitor *v, const char *name, uint64_t *obj,
                      Error **errp)
 {
+    assert(obj);
     if (v->type_size) {
         v->type_size(v, name, obj, errp);
     } else {
@@ -207,22 +230,35 @@ void visit_type_size(Visitor *v, const char *name, uint64_t *obj,
 
 void visit_type_bool(Visitor *v, const char *name, bool *obj, Error **errp)
 {
+    assert(obj);
     v->type_bool(v, name, obj, errp);
 }
 
 void visit_type_str(Visitor *v, const char *name, char **obj, Error **errp)
 {
+    assert(obj);
+    /* TODO: Fix callers to not pass NULL when they mean "", so that we
+     * can enable:
+    if (visit_is_output(v)) {
+        assert(*obj);
+    }
+     */
     v->type_str(v, name, obj, errp);
 }
 
 void visit_type_number(Visitor *v, const char *name, double *obj,
                        Error **errp)
 {
+    assert(obj);
     v->type_number(v, name, obj, errp);
 }
 
 void visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp)
 {
+    assert(obj);
+    if (visit_is_output(v)) {
+        assert(*obj);
+    }
     v->type_any(v, name, obj, errp);
 }
 
@@ -233,7 +269,6 @@ void output_type_enum(Visitor *v, const char *name, int *obj,
     int value = *obj;
     char *enum_str;
 
-    assert(strings);
     while (strings[i++] != NULL);
     if (value < 0 || value >= i - 1) {
         error_setg(errp, QERR_INVALID_PARAMETER, name ? name : "null");
@@ -251,8 +286,6 @@ void input_type_enum(Visitor *v, const char *name, int *obj,
     int64_t value = 0;
     char *enum_str;
 
-    assert(strings);
-
     visit_type_str(v, name, &enum_str, &local_err);
     if (local_err) {
         error_propagate(errp, local_err);
Signature · 1 line
2.5.0
#71 lore raw

Re: [Qemu-devel] [PATCH v9 21/37] qapi: Document visitor interfaces, add assertions

All right, this one's a bear. Not because the patch is bad, but because what it tries to do is bloody difficult.

Quoted 2 lines · Eric Blake

The visitor interface for mapping between QObject/QemuOpts/string and qapi has formerly been documented only by reading source code,

Polite way to say "is scandalously undocumented".

Quoted 6 lines

making it difficult to propose changes to either scripts/qapi*.py or to clients without knowing whether those changes would be safe. This adds documentation, including mentioning when parameters can be NULL, and where there are still some interface warts that would be nice to remove. In particular, I have plans to remove visit_start_union() in a future patch.

Suggest

The visitor interface for mapping between QObject/QemuOpts/string and QAPI is pretty much undocumented, making changes to visitor core, individual visitors, and users of visitors difficult.

Correct this by retrofitting proper contracts. Document some interface warts that would be nice to remove. In particular, I have plans to remove visit_start_union() in a future patch.

Quoted 5 lines

Add some asserts to strengthen the claims of the documentation; some of these were only made possible by recent cleanup commits. These were made easier with the addition of a new visit_is_output() helper (since all 2 output visitors of our 6 overall visitors use the same .type_enum() callback).

I find past tense confusing here, it makes me think visit_is_output() was added in a previous patch. Perhaps:

Add assertions to (partially) enforce the contract. Some of these were only made possible by recent cleanup commits.

Add a new visit_is_output() helper to make the assertions more readable. Its implementation is a bit hacky: it relies on the fact that all output visitors use the same .type_enum() callback.

Quoted 11 lines

---
v9: no change
v8: rebase to 'name' motion
v7: retitle; more wording changes, add asserts to enforce the wording, place later in series to rebase on fixes that would otherwise trip the new assertions
v6: mention that input visitors blindly assign over *obj; wording improvements

Quoted 6 lines
---
 include/qapi/visitor-impl.h |  31 ++++++-
 include/qapi/visitor.h      | 196 ++++++++++++++++++++++++++++++++++++++++++++
 qapi/qapi-visit-core.c      |  39 ++++++++-
 3 files changed, 262 insertions(+), 4 deletions(-)

My review probably makes more sense if you skip ahead to visitor.h, then come back here.

include/qapi/visitor-impl.h line 19

Quoted 10 lines
include/qapi/visitor-impl.h +2 -0
index 7f512cf..aab46bc 100644
@@ -15,23 +15,37 @@
 #include "qapi/error.h"
 #include "qapi/visitor.h"
 
+/* This file describes the callback interface for implementing a
+ * QObject visitor.  For the client interface, see visitor.h.  When

"QAPI visitor", for consistency with visitor.h's and qapi-visit-core.c's file comment.

include/qapi/visitor-impl.h line 23

Quoted 4 lines
include/qapi/visitor-impl.h +4 -0
+ * implementing the callbacks, it is easiest to declare a struct with
+ * 'Visitor visitor;' as the first member.  Semantics for the
+ * callbacks are generally similar to the counterpart public
+ * interface.  */

Thanks for adding this overview comment.

Suggest to say "A callback's contract matches the corresponding public functions' contract unless stated otherwise." Then state otherwise where needed.

include/qapi/visitor-impl.h line 28

Quoted 6 lines
include/qapi/visitor-impl.h +3 -1
+
 struct Visitor
 {
-    /* Must be set */
+    /* Must be provided to visit structs (the string visitors do not
+     * currently visit structs). */

Uh, the string visitors don't decide what gets visited, their users do. The string visitors don't support visiting structs. The restriction needs to be documented, but this isn't the place to do it, is it? Suggest to drop the parenthesis.

include/qapi/visitor-impl.h line 34

Quoted 6 lines
include/qapi/visitor-impl.h +2 -0
     void (*start_struct)(Visitor *v, const char *name, void **obj,
                          size_t size, Error **errp);
+    /* Must be provided if start_struct is present. */
     void (*end_struct)(Visitor *v, Error **errp);
 
+    /* May be NULL; most useful for input visitors. */

"Optional" would be a bit terser than "May be NULL".

Why is it "most useful for input visitors"? For what it's worth, the dealloc visitor finds it useful, too...

include/qapi/visitor-impl.h line 45

Quoted 11 lines
include/qapi/visitor-impl.h +2 -0
     void (*start_implicit_struct)(Visitor *v, void **obj, size_t size,
                                   Error **errp);
     /* May be NULL */
     void (*end_implicit_struct)(Visitor *v);
 
+    /* Must be set */
     void (*start_list)(Visitor *v, const char *name, Error **errp);
+    /* Must be set */
     GenericList *(*next_list)(Visitor *v, GenericList **list, Error **errp);
     /* Must be set */
     void (*end_list)(Visitor *v);

A visitor could omit these two with similar consequences to omitting start_struct() and end_struct(): attempts to visit lists crash then. In fact, the string visitors omitted them until commit 659268f and 69e2556, respectively.

include/qapi/visitor-impl.h line 48

Quoted 3 lines
include/qapi/visitor-impl.h +2 -0
+    /* Must be set, although the helpers input_type_enum() and
+     * output_type_enum() should be used if appropriate.  */

Suggest

Must be set. See also helpers input_type_enum(), output_type_enum().

include/qapi/visitor-impl.h line 51

Quoted 3 lines
include/qapi/visitor-impl.h +0 -0
     void (*type_enum)(Visitor *v, const char *name, int *obj,
                       const char *const strings[], Error **errp);
     /* May be NULL; only needed for input visitors. */

void (*get_next_type)(Visitor *v, const char *name, QType *type,
bool promote_int, Error **errp);

I figure it must be set for input visitors, because without it, the generated visit function will assume QTYPE_NONE, and fail.

Suggest "Must be set for input visitors."

include/qapi/visitor-impl.h struct Visitor · line 71

Quoted 12 lines
include/qapi/visitor-impl.h +5 -0
@@ -47,23 +61,38 @@ struct Visitor
     /* Optional; fallback is type_uint64().  */
     void (*type_size)(Visitor *v, const char *name, uint64_t *obj,
                       Error **errp);
+
     /* Must be set. */
     void (*type_bool)(Visitor *v, const char *name, bool *obj, Error **errp);
+    /* Must be set */
     void (*type_str)(Visitor *v, const char *name, char **obj, Error **errp);
+
+    /* Must be provided to visit numbers (the opts visitor does not
+     * currently visit non-integers). */

The restriction needs to be documented, but this isn't the place to do it. Suggest to drop the parenthesis.

include/qapi/visitor-impl.h struct Visitor · line 75

Quoted 4 lines
include/qapi/visitor-impl.h +2 -0
     void (*type_number)(Visitor *v, const char *name, double *obj,
                         Error **errp);
+    /* Must be provided to visit arbitrary QTypes (the opts and string
+     * visitors do not currently visit arbitrary types).  */

Likewise.

Looks like we say "must be set to visit this" when at least one visitor doesn't provide, and "must be set" when all our current visitors provide. Hmm.

include/qapi/visitor-impl.h struct Visitor · line 88

Quoted 13 lines
include/qapi/visitor-impl.h +3 -0
     void (*type_any)(Visitor *v, const char *name, QObject **obj,
                      Error **errp);
 
     /* May be NULL; most useful for input visitors. */
     void (*optional)(Visitor *v, const char *name, bool *present);
 
+    /* FIXME - needs to be removed */
     bool (*start_union)(Visitor *v, bool data_present, Error **errp);
+    /* FIXME - needs to be removed */
     void (*end_union)(Visitor *v, bool data_present, Error **errp);
 };
 
+/**

The /** is a marker for GTK-Doc. We don't actually follow GTK-Doc conventions, however (they suck). Sure we want the extra * anyway?

Quoted 15 lines
include/qapi/visitor-impl.h +5 -0
+ * A generic visitor.type_enum suitable for input visitors.
+ */
 void input_type_enum(Visitor *v, const char *name, int *obj,
                      const char *const strings[], Error **errp);
+/**
+ * A generic visitor.type_enum suitable for output visitors.
+ */
 void output_type_enum(Visitor *v, const char *name, int *obj,
                       const char *const strings[], Error **errp);
 
include/qapi/visitor.h +0 -0
index 10390d2..5349a64 100644

include/qapi/visitor.h line 23

Quoted 6 lines
include/qapi/visitor.h +3 -0
@@ -18,6 +18,20 @@
 #include "qapi/error.h"
 #include <stdlib.h>
 
+/* This file describes the client view for visiting a map between
+ * generated QAPI C structs and another representation (command line
+ * options, strings, or QObjects).

"visiting a map"?

include/qapi/visitor.h line 26

Quoted 3 lines
include/qapi/visitor.h +2 -0
                                     An input visitor converts from
+ * some other form into QAPI representation; an output visitor
+ * converts from QAPI back into another form.

Let me try to work out what this visitor thingy is about.

The QAPI schema defines a set of QAPI types. QAPI types can have members of QAPI type. A value of such a type is actually a root of a graph of QAPI values.

QAPI generates visitor functions to walk these graphs. They currently work only for trees, because that's all we need.

Walking a tree (or graph for that matter) is useful only to actually do something with the nodes. The generated visitor functions do the walking and the visitor classes do the doing. This is the visitor pattern at work: we factor walking the data structure out of the various tasks that need to walk it to do something.

Three kinds of visitor classes exist: two output visitors (QMP and string), three input visitors (QMP, string and QemuOpts), and the dealloc visitor.

With an output visitor, the visitor functions walk a tree, and the output visitor builds up some output. QmpOutputVisitor builds a QObject matching QMP wire format,, and StringOutputVisitor builds a C string. Both convert a QAPI tree to another representation.

Similarly with the QapiDeallocVisitor, except nothing gets built. Instead, the tree gets destroyed node by node.

With an input visitor, the visitor functions walk a tree as the input visitor constructs it. QmpInputVisitor constructs it from a QObject matching QMP wire format, StringInputVisitor from a C string, and OptsVisitor from a QemuOpts. All three convert from another representation to a QAPI tree.

The Qmp visitors and the dealloc visitor a general: they can walk / build any QAPI tree.

The string visitors and the QemuOpts visitor have restrictions: they can walk / build only a subset.

include/qapi/visitor.h line 29

Quoted 3 lines
include/qapi/visitor.h +2 -0
                                                In the descriptions
+ * below, an object or dictionary refers to a JSON '{}', and a list
+ * refers to a JSON '[]'.

We usually call these "JSON object" and "JSON array", following RFC 7159.

include/qapi/visitor.h line 34

Quoted 8 lines
include/qapi/visitor.h +7 -0
                            These functions seldom need to be called
+ * directly, but are instead used by code generated by
+ * scripts/qapi-visit.py.  For the visitor callback contracts, see
+ * visitor-impl.h.
+ */
+
+/* This struct is layout-compatible with all other *List structs
+ * created by the qapi generator. */

QAPI

More instances elsewhere.

include/qapi/visitor.h typedef struct GenericList · line 45

Quoted 9 lines

typedef struct GenericList

 {
     union {
include/qapi/visitor.h +2 -0
@@ -27,15 +41,101 @@ typedef struct GenericList
     struct GenericList *next;
 } GenericList;
 
+/**
+ * Prepare to visit an object tied to key @name.

Not just any object, but a *struct*. Suggest:

* Start visiting struct value @obj.

include/qapi/visitor.h typedef struct GenericList · line 46

Quoted 1 line
include/qapi/visitor.h +1 -0
+ * @name will be NULL if this is visited as part of a list.

I'm afraid reality is a bit messier.

If the visited object is a member of struct or union, @name is its member name.

If it's a member of a list, @name is null.

If it's a command argument, @name is its parameter name.

If it's a command's result, @name is a meaningless string (qmp-marshal.c currently uses "unused").

Else, @name can be a meaningless string or null.

Same for other visit functions.

include/qapi/visitor.h typedef struct GenericList · line 50

Quoted 5 lines
include/qapi/visitor.h +4 -0
                                                              The
+ * caller then makes a series of visit calls for each key expected in
+ * the object, where those visits set their respective obj parameter
+ * to the address of a member of the qapi struct, and follows
+ * everything by a call to visit_end_struct() to clean up resources.

I'd explain intended use after the parameters.

include/qapi/visitor.h typedef struct GenericList · line 52

Quoted 2 lines
include/qapi/visitor.h +2 -0
+ *
+ * @obj can be NULL (in which case @size should also be 0) to indicate

"must be 0", because you assert that below.

Actually, I find this @size contract weird. Passing the type's actual size would make at least as much sense as passing 0. We generally pass 0 when the size isn't used, but that's just because it's the easiest value to pass.

include/qapi/visitor.h typedef struct GenericList · line 55

Quoted 3 lines
include/qapi/visitor.h +3 -0
+ * that there is no qapi C struct, and that the upcoming visit calls
+ * are parsing input to or creating output from some other
+ * representation.

This is very vague.

Can you point me to code passing null @obj?

I suspect only some visitors accept null @obj. Which ones?

include/qapi/visitor.h typedef struct GenericList · line 59

Quoted 4 lines
include/qapi/visitor.h +4 -0
+ *
+ * If @obj is not NULL, then input visitors malloc a qapi struct of
+ * @size bytes into *@obj on success, and output visitors expect *@obj
+ * to be a fully-populated qapi struct.

Only input visitors and the dealloc visitor use @obj. The dealloc visitor doesn't need it in start_struct(), but has to save it for end_struct(), because that one doesn't get it passed. Aside: feels stupid.

Only input visitors use @size, and they use it only when @obj isn't null.

We could make visitors check the member pointers passed to the member visits actually point into (@obj, @size). Then *all* visitors would use @obj and @size. I'm not asking for that to be done, I'm just providing an argument for a tighter contract. The simplest one would be "Some visitors permit @obj to be null. @size must be the struct value's size." Except that doesn't match existing usage. Unless we change it to match, we need to hedge "except @size is unused and may be anything when @obj is null", or "except @size is unused and must be zero when @obj is null".

This method is an awful mess. Probably because it's serving quite different purposes in the different visitors.

include/qapi/visitor.h typedef struct GenericList · line 62

Quoted 3 lines
include/qapi/visitor.h +3 -0
+ *
+ * Set *@errp on failure; for example, if the input stream does not
+ * have a member @name or if the member is not an object.

What do you mean by "if the member is not an object"?

Any other ways to fail?

This is the only function comment that says anything about @errp. Should we document the various failure modes everywhere?

include/qapi/visitor.h typedef struct GenericList · line 66

Quoted 4 lines
include/qapi/visitor.h +4 -0
+ *
+ * FIXME: For input visitors, *@obj can be assigned here even if later
+ * visits will fail; this can lead to memory leaks if clients aren't
+ * careful.

Why is this a FIXME? How could it be fixed? More of the same below.

My attempt at explaining intended use:

After visit_start_struct() succeeds, the caller may visit its members one after the other, passing the member's name and address within the struct. Finally, visit_end_struct() needs to be called to clean up.

I guess what the reader really needs here to understand intended use is example code. qapi-code-gen.txt has some. Add a pointer?

include/qapi/visitor.h typedef struct GenericList · line 69

Quoted 3 lines
include/qapi/visitor.h +1 -0
+ */
 void visit_start_struct(Visitor *v, const char *name, void **obj,
                         size_t size, Error **errp);

Please separate each commented declaration with a blank line. Not flagging further instances.

include/qapi/visitor.h typedef struct GenericList · line 74

Quoted 5 lines
include/qapi/visitor.h +5 -0
+/**
+ * Complete a struct visit started earlier.
+ * Must be called after any successful use of visit_start_struct(),
+ * even if intermediate processing was skipped due to errors, to allow
+ * the backend to release any resources.

Actually, destroying the visitor is safe even without calling the remaining visit_end_struct(). If we introduce a visitor reset as discussed elsewhere, that could probably be made safe, too.

Same for the other visit_end_FOO().

include/qapi/visitor.h typedef struct GenericList · line 83

Quoted 9 lines
include/qapi/visitor.h +8 -0
+ */
 void visit_end_struct(Visitor *v, Error **errp);
+
+/**
+ * Prepare to visit an implicit struct.
+ * Similar to visit_start_struct(), except that an implicit struct
+ * represents a subset of keys that are present at the same nesting level
+ * of a common object but as a separate qapi C struct, rather than a new
+ * object at a deeper nesting level.

I'm afraid this is impenetrable.

I tried to refresh my memory on visit_start_implicit_struct()'s purpose by reading code, but that's pretty impenetrable, too.

include/qapi/visitor.h typedef struct GenericList · line 86

Quoted 3 lines
include/qapi/visitor.h +3 -0
+ *
+ * @obj must not be NULL, since this function is only called when
+ * visiting with qapi structs.

Really? Why does qmp_input_start_implicit_struct() check for null then?

Quoted 13 lines
include/qapi/visitor.h +11 -0
+ *
+ * FIXME: For input visitors, *@obj can be assigned here even if later
+ * visits will fail; this can lead to memory leaks if clients aren't
+ * careful.
+ */
 void visit_start_implicit_struct(Visitor *v, void **obj, size_t size,
                                  Error **errp);
+/**
+ * Complete an implicit struct visit started earlier.
+ * Must be called after any successful use of visit_start_implicit_struct(),
+ * even if intermediate processing was skipped due to errors, to allow
+ * the backend to release any resources.  Unlike visit_end_struct(), this
+ * does not need to check for errors (detection of unused keys is only

include/qapi/visitor.h typedef struct GenericList · line 109

Quoted 10 lines
include/qapi/visitor.h +8 -0
+ * possible for the overall struct, not a subset).
+ */
 void visit_end_implicit_struct(Visitor *v);
 
+/**
+ * Prepare to visit a list tied to an object key @name.
+ * @name will be NULL if this is visited as part of another list.
+ * After calling this, the elements must be collected until
+ * visit_next_list() returns NULL, then visit_end_list() must be
+ * used to complete the visit.

I'm afraid this doesn't really tell me how to visit a list. Perhaps:

After visit_start_list() succeeds, the caller may visit its members one after the other, passing the value of visit_next_list() as @obj, until visit_next_list() returns NULL. Finally, visit_end_list() needs to be called to clean up.

May want to add a pointer to example code in qapi-code-gen.txt.

include/qapi/visitor.h typedef struct GenericList · line 119

Quoted 10 lines
include/qapi/visitor.h +9 -0
+ */
 void visit_start_list(Visitor *v, const char *name, Error **errp);
+/**
+ * Iterate over a GenericList during a list visit.
+ * @list must not be NULL; on the first call, @list contains the
+ * address of the list head, and on subsequent calls *@list must be
+ * the previously returned value.  Must be called in a loop until a
+ * NULL return or error occurs; for each non-NULL return, the caller
+ * must then call the appropriate visit_type_*() for the element type
+ * of the list, with that function's name parameter set to NULL.

Isn't must too strong? Anything horrible's going to happen when you stop visiting list members early? I believe not visiting some list members behaves the same not visiting some struct members: you won't get the skipped visits' side effects (obviously). While that may be bad, it's not *necessarily* bad. The visitor machinery should cope just fine regardless.

include/qapi/visitor.h typedef struct GenericList · line 126

Quoted 7 lines
include/qapi/visitor.h +7 -0
+ *
+ * Note that for some visitors (qapi-dealloc and qmp-output), when a
+ * qapi GenericList linked list is not being used (comparable to when
+ * a NULL obj is used for visit_start_struct()), it is acceptable to
+ * bypass the use of visit_next_list() and just directly call the
+ * appropriate visit_type_*() for each element in between the
+ * visit_start_list() and visit_end_list() calls.

I'm confused. Can you point me to code bypassing visit_next_list()?

Quoted 14 lines
include/qapi/visitor.h +11 -0
+ *
+ * FIXME: For input visitors, *@list can be assigned here even if
+ * later visits will fail; this can lead to memory leaks if clients
+ * aren't careful.
+ */
 GenericList *visit_next_list(Visitor *v, GenericList **list, Error **errp);
+/**
+ * Complete the list started earlier.
+ * Must be called after any successful use of visit_start_list(),
+ * even if intermediate processing was skipped due to errors, to allow
+ * the backend to release any resources.
+ */
 void visit_end_list(Visitor *v);
 
Quoted 1 line

/**

* Check if an optional member @name of an object needs visiting.
* For input visitors, set *@present according to whether the
* corresponding visit_type_*() needs calling; for other visitors,
* leave *@present unchanged. Return *@present for convenience.
bool visit_optional(Visitor *v, const char *name, bool *present);

Suggest to clarify:

Does optional struct member @name need visiting? @present points to the optional member's has_ flag. Input visitors set *@present according to their input. Other visitors leave it unchanged.
In either case, return *@present.

include/qapi/visitor.h bool visit_optional(Visitor *v, const char *name, bool *present);

Quoted 1 line
include/qapi/visitor.h +0 -0
@@ -54,32 +154,128 @@ bool visit_optional(Visitor *v, const char *name, bool *present);

/**
* Determine the qtype of the item @name in the current object visit.
* For input visitors, set *@type to the correct qtype of a qapi
* alternate type; for other visitors, leave *@type unchanged.
* If @promote_int, treat integers as QTYPE_FLOAT.

include/qapi/visitor.h bool visit_optional(Visitor *v, const char *name, bool *present); · line 156

Quoted 3 lines
include/qapi/visitor.h +0 -0
  */
 void visit_get_next_type(Visitor *v, const char *name, QType *type,
                          bool promote_int, Error **errp);

Suggest to clarify:

Determine a visited alternate's QType.
[Common description of @name goes here]
@type points to the alternate's type member. Input visitors set *@type according to their input. If @promote_int, integer input results in QTYPE_FLOAT. Other visitors leave it unchanged.

include/qapi/visitor.h bool visit_optional(Visitor *v, const char *name, bool *present); · line 164

Quoted 8 lines
include/qapi/visitor.h +8 -0
+
+/**
+ * Visit an enum value tied to @name in the current object visit.
+ * @name will be NULL if this is visited as part of a list.
+ * For input visitors, parse a string and set *@obj to the numeric
+ * value of the enum type using @strings as the mapping, leaving @obj
+ * unchanged on error; for output visitors, reverse the mapping and
+ * visit the output string determined by *@obj.

Not covered: dealloc visitor. It does nothing, of course.

Our current input / output visitors indeed parse from / unparse to a string, and but isn't this a *visitor* detail that doesn't belong here? We could theoretically do binary serialization with a pair of visitors, where the output visitor writes the numeric encoding, and the input visitor reads it back.

Suggest:

Input visitors set *@obj according to their input. Other visitors leave it unchanged.

include/qapi/visitor.h bool visit_optional(Visitor *v, const char *name, bool *present); · line 173

Quoted 9 lines
include/qapi/visitor.h +7 -0
+ */
 void visit_type_enum(Visitor *v, const char *name, int *obj,
                      const char *const strings[], Error **errp);
+
+/**
+ * Visit an integer value tied to @name in the current object visit.
+ * @name will be NULL if this is visited as part of a list.
+ * For input visitors, set *@obj to the parsed value; for other visitors,
+ * leave *@obj unchanged.

Here, your text is very close to what I suggested for enums :)

Quoted 14 lines
include/qapi/visitor.h +9 -0
+ */
 void visit_type_int(Visitor *v, const char *name, int64_t *obj, Error **errp);
+/**
+ * Visit a uint8_t value tied to @name in the current object visit.
+ * Like visit_type_int(), except clamps the value to uint8_t range.
+ */
 void visit_type_uint8(Visitor *v, const char *name, uint8_t *obj,
                       Error **errp);
+/**
+ * Visit a uint16_t value tied to @name in the current object visit.
+ * Like visit_type_int(), except clamps the value to uint16_t range.
+ */
 void visit_type_uint16(Visitor *v, const char *name, uint16_t *obj,
                        Error **errp);

include/qapi/visitor.h bool visit_optional(Visitor *v, const char *name, bool *present); · line 197

Quoted 10 lines
include/qapi/visitor.h +8 -0
+/**
+ * Visit a uint32_t value tied to @name in the current object visit.
+ * Like visit_type_int(), except clamps the value to uint32_t range.
+ */
 void visit_type_uint32(Visitor *v, const char *name, uint32_t *obj,
                        Error **errp);
+/**
+ * Visit a uint64_t value tied to @name in the current object visit.
+ * Like visit_type_int(), except clamps the value to uint64_t range
+ * (that is, ensures it is unsigned).

I'd scratch the parenthesis.

Quoted 20 lines
include/qapi/visitor.h +13 -0
+ */
 void visit_type_uint64(Visitor *v, const char *name, uint64_t *obj,
                        Error **errp);
+/**
+ * Visit an int8_t value tied to @name in the current object visit.
+ * Like visit_type_int(), except clamps the value to int8_t range.
+ */
 void visit_type_int8(Visitor *v, const char *name, int8_t *obj, Error **errp);
+/**
+ * Visit an int16_t value tied to @name in the current object visit.
+ * Like visit_type_int(), except clamps the value to int16_t range.
+ */
 void visit_type_int16(Visitor *v, const char *name, int16_t *obj,
                       Error **errp);
+/**
+ * Visit an int32_t value tied to @name in the current object visit.
+ * Like visit_type_int(), except clamps the value to int32_t range.
+ */
 void visit_type_int32(Visitor *v, const char *name, int32_t *obj,
                       Error **errp);

include/qapi/visitor.h bool visit_optional(Visitor *v, const char *name, bool *present); · line 227

Quoted 10 lines
include/qapi/visitor.h +8 -0
+/**
+ * Visit an int64_t value tied to @name in the current object visit.
+ * Identical to visit_type_int().
+ */
 void visit_type_int64(Visitor *v, const char *name, int64_t *obj,
                       Error **errp);
+/**
+ * Visit a uint64_t value tied to @name in the current object visit.
+ * Like visit_type_uint64(), except that some visitors may choose to
+ * recognize additional suffixes for easily scaling input values.

"use different syntax, say suffixes for scaling values."

include/qapi/visitor.h bool visit_optional(Visitor *v, const char *name, bool *present); · line 236

Quoted 9 lines
include/qapi/visitor.h +7 -0
+ */
 void visit_type_size(Visitor *v, const char *name, uint64_t *obj,
                      Error **errp);
+
+/**
+ * Visit a boolean value tied to @name in the current object visit.
+ * @name will be NULL if this is visited as part of a list.
+ * Input visitors set *@obj to the value; other visitors will leave
+ * *@obj unchanged.

You're getting closer and closer to my version of this clause :)

include/qapi/visitor.h bool visit_optional(Visitor *v, const char *name, bool *present);

Quoted 7 lines
include/qapi/visitor.h +6 -0
+ */
 void visit_type_bool(Visitor *v, const char *name, bool *obj, Error **errp);
+
+/**
+ * Visit a string value tied to @name in the current object visit.
+ * @name will be NULL if this is visited as part of a list.
+ * @obj must be non-NULL.

Same for the other visit_type_T(), but not specified there.

include/qapi/visitor.h bool visit_optional(Visitor *v, const char *name, bool *present); · line 245

Quoted 3 lines
include/qapi/visitor.h +2 -0
                            Input visitors set *@obj to the parsed
+ * string (never NULL); while output visitors leave *@obj unchanged,
+ * except that a NULL *@obj will be treated the same as "".

Suggest:

Input visitors set *@obj according to their input (never NULL). Other visitors leave it unchanged. They commonly treat NULL like "".

include/qapi/visitor.h bool visit_optional(Visitor *v, const char *name, bool *present); · line 247

Quoted 2 lines
include/qapi/visitor.h +2 -0
+ *
+ * FIXME: Unfortunately not const-correct for output visitors.

Is that fixable?

Quoted 5 lines
include/qapi/visitor.h +4 -0
+ * FIXME: Callers that try to output NULL *obj should not be allowed.
+ */
 void visit_type_str(Visitor *v, const char *name, char **obj, Error **errp);
+
+/**

include/qapi/visitor.h bool visit_optional(Visitor *v, const char *name, bool *present); · line 262

Quoted 10 lines
include/qapi/visitor.h +8 -0
+ * Visit a number value tied to @name in the current object visit.
+ * @name will be NULL if this is visited as part of a list.
+ * Input visitors set *@obj to the value; other visitors will leave
+ * *@obj unchanged.
+ */
 void visit_type_number(Visitor *v, const char *name, double *obj,
                        Error **errp);
+
+/**
+ * Visit an arbitrary qtype value tied to @name in the current object visit.

Scratch qtype?

include/qapi/visitor.h bool visit_optional(Visitor *v, const char *name, bool *present); · line 265

Quoted 3 lines
include/qapi/visitor.h +3 -0
+ * @name will be NULL if this is visited as part of a list.
+ * Input visitors set *@obj to the value; other visitors will leave
+ * *@obj (which must not be NULL) unchanged.

Should specify that input visitors never set it to null. Suggest:

Input visitors set *@obj according to their input (never NULL). Other visitors leave it unchanged. It must not be NULL then.

include/qapi/visitor.h bool visit_optional(Visitor *v, const char *name, bool *present); · line 271

Quoted 6 lines
include/qapi/visitor.h +5 -0
+ */
 void visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp);
+
+/**
+ * Mark the start of visiting the branches of a union. Return true if
+ * @data_present.

Not quite. Actually returns true when the visitor doesn't provide this callback, or else whatever its callback returns. Only the dealloc visitor provides it, and it returns @data_present.

You remove the function along with visit_end_union() in PATCH 32. I'd be okay with leaving them undocumented apart from the FIXME until then. But if we add a contract now, it better be correct.

Quoted 15 lines
include/qapi/visitor.h +6 -0
+ * FIXME: Should not be needed
+ */
 bool visit_start_union(Visitor *v, bool data_present, Error **errp);
+/**
+ * Mark the end of union branches, after visit_start_union().
+ * FIXME: Should not be needed
+ */
 void visit_end_union(Visitor *v, bool data_present, Error **errp);
 

#endif

qapi/qapi-visit-core.c +0 -0
index 2d3743b..1612d0d 100644

qapi/qapi-visit-core.c line 26

Quoted 9 lines
qapi/qapi-visit-core.c +6 -0
@@ -18,9 +18,21 @@
 #include "qapi/visitor.h"
 #include "qapi/visitor-impl.h"
 
+/* Determine if this is an output visitor.
+ * Useful for making some tighter assertions that hold for output
+ * visitors, but not for input or dealloc visitors. */
+static bool visit_is_output(Visitor *v)
+{
+    return v->type_enum == output_type_enum;

This is a hack. As mentioned above, we could have an output visitor doing binary serialization, which would need a different type_enum. I'm okay with the hack for now, but it needs a scary comment.

qapi/qapi-visit-core.c line 35

Quoted 9 lines
qapi/qapi-visit-core.c +6 -0
+}
+
 void visit_start_struct(Visitor *v, const char *name, void **obj,
                         size_t size, Error **errp)
 {
+    assert(obj ? size : !size);
+    if (obj && visit_is_output(v)) {
+        assert(*obj);
+    }

This needs to match the contract specified in visitor.h, but so far the contract is too confusing for me to judge. I'm skipping review of this and the following assertion changes for now.

Quoted 120 lines
qapi/qapi-visit-core.c +24 -3
     v->start_struct(v, name, obj, size, errp);
 }
 
@@ -32,6 +44,10 @@ void visit_end_struct(Visitor *v, Error **errp)
 void visit_start_implicit_struct(Visitor *v, void **obj, size_t size,
                                  Error **errp)
 {
+    assert(obj && size);
+    if (visit_is_output(v)) {
+        assert(*obj);
+    }
     if (v->start_implicit_struct) {
         v->start_implicit_struct(v, obj, size, errp);
     }
@@ -51,6 +67,7 @@ void visit_start_list(Visitor *v, const char *name, Error **errp)
 
 GenericList *visit_next_list(Visitor *v, GenericList **list, Error **errp)
 {
+    assert(list);
     return v->next_list(v, list, errp);
 }
 
@@ -85,6 +102,7 @@ bool visit_optional(Visitor *v, const char *name, bool *present)
 void visit_get_next_type(Visitor *v, const char *name, QType *type,
                          bool promote_int, Error **errp)
 {
+    assert(type);
     if (v->get_next_type) {
         v->get_next_type(v, name, type, promote_int, errp);
     }
@@ -93,11 +111,13 @@ void visit_get_next_type(Visitor *v, const char *name, QType *type,
 void visit_type_enum(Visitor *v, const char *name, int *obj,
                      const char *const strings[], Error **errp)
 {
+    assert(obj && strings);
     v->type_enum(v, name, obj, strings, errp);
 }
 
 void visit_type_int(Visitor *v, const char *name, int64_t *obj, Error **errp)
 {
+    assert(obj);
     v->type_int64(v, name, obj, errp);
 }
 
@@ -145,6 +165,7 @@ void visit_type_uint32(Visitor *v, const char *name, uint32_t *obj,
 void visit_type_uint64(Visitor *v, const char *name, uint64_t *obj,
                        Error **errp)
 {
+    assert(obj);
     v->type_uint64(v, name, obj, errp);
 }
 
@@ -192,12 +213,14 @@ void visit_type_int32(Visitor *v, const char *name, int32_t *obj,
 void visit_type_int64(Visitor *v, const char *name, int64_t *obj,
                       Error **errp)
 {
+    assert(obj);
     v->type_int64(v, name, obj, errp);
 }
 
 void visit_type_size(Visitor *v, const char *name, uint64_t *obj,
                      Error **errp)
 {
+    assert(obj);
     if (v->type_size) {
         v->type_size(v, name, obj, errp);
     } else {
@@ -207,22 +230,35 @@ void visit_type_size(Visitor *v, const char *name, uint64_t *obj,
 
 void visit_type_bool(Visitor *v, const char *name, bool *obj, Error **errp)
 {
+    assert(obj);
     v->type_bool(v, name, obj, errp);
 }
 
 void visit_type_str(Visitor *v, const char *name, char **obj, Error **errp)
 {
+    assert(obj);
+    /* TODO: Fix callers to not pass NULL when they mean "", so that we
+     * can enable:
+    if (visit_is_output(v)) {
+        assert(*obj);
+    }
+     */
     v->type_str(v, name, obj, errp);
 }
 
 void visit_type_number(Visitor *v, const char *name, double *obj,
                        Error **errp)
 {
+    assert(obj);
     v->type_number(v, name, obj, errp);
 }
 
 void visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp)
 {
+    assert(obj);
+    if (visit_is_output(v)) {
+        assert(*obj);
+    }
     v->type_any(v, name, obj, errp);
 }
 
@@ -233,7 +269,6 @@ void output_type_enum(Visitor *v, const char *name, int *obj,
     int value = *obj;
     char *enum_str;
 
-    assert(strings);
     while (strings[i++] != NULL);
     if (value < 0 || value >= i - 1) {
         error_setg(errp, QERR_INVALID_PARAMETER, name ? name : "null");
@@ -251,8 +286,6 @@ void input_type_enum(Visitor *v, const char *name, int *obj,
     int64_t value = 0;
     char *enum_str;
 
-    assert(strings);
-
     visit_type_str(v, name, &enum_str, &local_err);
     if (local_err) {
         error_propagate(errp, local_err);
author
#72 lore raw

Re: [Qemu-devel] [PATCH v9 21/37] qapi: Document visitor interfaces, add assertions

Quoted 2 lines · Markus Armbruster

All right, this one's a bear. Not because the patch is bad, but because what it tries to do is bloody difficult.

Is there any reasonable split (such as adding some of the assertions in earlier patches) that would make it any easier? Or do we just bite the bullet and do it?

Quoted 7 lines
Quoted 2 lines · Eric Blake

The visitor interface for mapping between QObject/QemuOpts/string and qapi has formerly been documented only by reading source code,

Polite way to say "is scandalously undocumented".

Indeed.

Quoted 10 lines
Quoted 7 lines

making it difficult to propose changes to either scripts/qapi*.py or to clients without knowing whether those changes would be safe. This adds documentation, including mentioning when parameters can be NULL, and where there are still some interface warts that would be nice to remove. In particular, I have plans to remove visit_start_union() in a future patch.

Suggest

Quoted 7 lines

The visitor interface for mapping between QObject/QemuOpts/string and QAPI is pretty much undocumented, making changes to visitor core, individual visitors, and users of visitors difficult.

Correct this by retrofitting proper contracts. Document some interface warts that would be nice to remove. In particular, I have plans to remove visit_start_union() in a future patch.

Your suggestions here, and elsewhere, are good and will be in my next spin. I'll trim to just the places where you have more than just a wording suggestion.

Quoted 8 lines
Quoted 5 lines
 include/qapi/visitor-impl.h |  31 ++++++-
 include/qapi/visitor.h      | 196 ++++++++++++++++++++++++++++++++++++++++++++
 qapi/qapi-visit-core.c      |  39 ++++++++-
 3 files changed, 262 insertions(+), 4 deletions(-)

My review probably makes more sense if you skip ahead to visitor.h, then come back here.

If I remember, I'll use -O when generating v10 to force visitor.h first, other .h second, and .c last (I don't always remember to do it; maybe I should add it into my handy .git alias that I use for firing off long series). [I really wish the git people would make it possible to automate -O via 'git config', and to make it easier to have a per-project preferred order file]

Quoted 11 lines

include/qapi/visitor-impl.h line 28

Quoted 7 lines
include/qapi/visitor-impl.h +3 -1
+
 struct Visitor
 {
-    /* Must be set */
+    /* Must be provided to visit structs (the string visitors do not
+     * currently visit structs). */

Uh, the string visitors don't decide what gets visited, their users do. The string visitors don't support visiting structs. The restriction needs to be documented, but this isn't the place to do it, is it?

Good point. I think what I will do is split out a separate patch that documents, per visitor with limitation, what callers cannot (yet) do with that visitor.

Quoted 6 lines
Quoted 1 line

+ /* May be NULL; most useful for input visitors. */

"Optional" would be a bit terser than "May be NULL".

Why is it "most useful for input visitors"? For what it's worth, the dealloc visitor finds it useful, too...

and a later patch adds it to the QemuOpts input visitor (Zoltan's patch has been sitting for how many months now?). I'll come up with something.

Quoted 13 lines

include/qapi/visitor-impl.h line 45

Quoted 12 lines
     void (*start_implicit_struct)(Visitor *v, void **obj, size_t size,
                                   Error **errp);
     /* May be NULL */
     void (*end_implicit_struct)(Visitor *v);
include/qapi/visitor-impl.h +2 -0
+    /* Must be set */
     void (*start_list)(Visitor *v, const char *name, Error **errp);
+    /* Must be set */
     GenericList *(*next_list)(Visitor *v, GenericList **list, Error **errp);
     /* Must be set */
     void (*end_list)(Visitor *v);
Quoted 4 lines

A visitor could omit these two with similar consequences to omitting start_struct() and end_struct(): attempts to visit lists crash then. In fact, the string visitors omitted them until commit 659268f and 69e2556, respectively.

Which is why, as you pointed out, it may be better to document the limitations in the string visitor rather than here, and in this file maybe just mention at the top something along the lines that "must be set" really means that "only needs to be set if your callers are expecting a visit to encounter this type; the corresponding crash on calling NULL is your hint to write missing functionality in your visitor".

Quoted 8 lines
Quoted 1 line
     /* May be NULL; only needed for input visitors. */

void (*get_next_type)(Visitor *v, const char *name, QType *type,
bool promote_int, Error **errp);

I figure it must be set for input visitors, because without it, the generated visit function will assume QTYPE_NONE, and fail.

Suggest "Must be set for input visitors."

Correct, and nice wording.

Quoted 17 lines

Looks like we say "must be set to visit this" when at least one visitor doesn't provide, and "must be set" when all our current visitors provide. Hmm.

Quoted 12 lines
     void (*type_any)(Visitor *v, const char *name, QObject **obj,
                      Error **errp);

     /* May be NULL; most useful for input visitors. */
     void (*optional)(Visitor *v, const char *name, bool *present);
include/qapi/visitor-impl.h +2 -0
+    /* FIXME - needs to be removed */
     bool (*start_union)(Visitor *v, bool data_present, Error **errp);
+    /* FIXME - needs to be removed */
     void (*end_union)(Visitor *v, bool data_present, Error **errp);
 };
Quoted 4 lines
Quoted 1 line

+/**

The /** is a marker for GTK-Doc. We don't actually follow GTK-Doc conventions, however (they suck). Sure we want the extra * anyway?

I don't mind dropping it.

Quoted 10 lines

include/qapi/visitor.h line 23

Quoted 8 lines

+++ b/include/qapi/visitor.h

include/qapi/visitor.h +3 -0
@@ -18,6 +18,20 @@
 #include "qapi/error.h"
 #include <stdlib.h>
 
+/* This file describes the client view for visiting a map between
+ * generated QAPI C structs and another representation (command line
+ * options, strings, or QObjects).

"visiting a map"?

I'm a victim of too much rebasing. I think I meant:

...the client view for mapping between generated QAPI C structs and another representation...

Quoted 11 lines

Review line 26

Quoted 4 lines
(quoted diff) +2 -0
                                     An input visitor converts from
+ * some other form into QAPI representation; an output visitor
+ * converts from QAPI back into another form.

Let me try to work out what this visitor thingy is about.

The QAPI schema defines a set of QAPI types. QAPI types can have members of QAPI type. A value of such a type is actually a root of a graph of QAPI values.

Quoted 8 lines

QAPI generates visitor functions to walk these graphs. They currently work only for trees, because that's all we need.

Walking a tree (or graph for that matter) is useful only to actually do something with the nodes. The generated visitor functions do the walking and the visitor classes do the doing. This is the visitor pattern at work: we factor walking the data structure out of the various tasks that need to walk it to do something.

Additionally, it is possible to use the visitor without a qapi struct, purely for their side effects of translation to or from the alternative representation of that visitor, by manually calling visitor functions in the same order that generated QAPI structs would use.

Quoted 9 lines

Three kinds of visitor classes exist: two output visitors (QMP and string), three input visitors (QMP, string and QemuOpts), and the dealloc visitor.

With an output visitor, the visitor functions walk a tree, and the output visitor builds up some output. QmpOutputVisitor builds a QObject matching QMP wire format,, and StringOutputVisitor builds a C string. Both convert a QAPI tree to another representation.

Or, when passed NULL obj, create the other representation out of thin air from the manual visit.

Quoted 9 lines

Similarly with the QapiDeallocVisitor, except nothing gets built. Instead, the tree gets destroyed node by node.

With an input visitor, the visitor functions walk a tree as the input visitor constructs it. QmpInputVisitor constructs it from a QObject matching QMP wire format, StringInputVisitor from a C string, and OptsVisitor from a QemuOpts. All three convert from another representation to a QAPI tree.

Or, when passed NULL obj, parse the other representation via a manual visit with no QAPI object involved.

Quoted 6 lines

The Qmp visitors and the dealloc visitor a general: they can walk / build any QAPI tree.

The string visitors and the QemuOpts visitor have restrictions: they can walk / build only a subset.

Yes.

Quoted 7 lines

include/qapi/visitor.h typedef struct GenericList · line 45

Quoted 2 lines
include/qapi/visitor.h +2 -0
+/**
+ * Prepare to visit an object tied to key @name.

Not just any object, but a *struct*. Suggest:

* Start visiting struct value @obj.

Quoted 8 lines

Review line 29

Quoted 1 line
(quoted diff) +1 -0
+ * @name will be NULL if this is visited as part of a list.

I'm afraid reality is a bit messier.

If the visited object is a member of struct or union, @name is its member name.

If it's a member of a list, @name is null.

[side thread in earlier message about possibly using "name[0]" instead of NULL, as a later improvement]

Quoted 2 lines

If it's a command argument, @name is its parameter name.

But this is a special case of "visiting as part of a struct", since we have a (possibly-implicit) QAPI struct for parameters.

Quoted 3 lines

If it's a command's result, @name is a meaningless string (qmp-marshal.c currently uses "unused").

But this is a special case of a root visit (the command result is the top of a visit, so @name is meaningless).

Quoted 2 lines

Else, @name can be a meaningless string or null.

And this sentence is reached only for a root visit. So now I'm thinking along these lines:

As the first object in a visit (the root of a QAPI struct), @name is meaningless. It is typically set to NULL or a descriptive string, although some callers pass "unused".

At all other points of the visit, @name reflects the relationship of this visit to the parent. Either the visited object is a member of a struct or union, and @name is its member name; or the visited object is the member of a list and @name is NULL.

Quoted 2 lines

Same for other visit functions.

Is it okay to write it out once, and then have all other functions refer back to the common location?

Quoted 12 lines

include/qapi/visitor.h typedef struct GenericList · line 50

Quoted 6 lines
include/qapi/visitor.h +4 -0
                                                              The
+ * caller then makes a series of visit calls for each key expected in
+ * the object, where those visits set their respective obj parameter
+ * to the address of a member of the qapi struct, and follows
+ * everything by a call to visit_end_struct() to clean up resources.

I'd explain intended use after the parameters.

include/qapi/visitor.h typedef struct GenericList · line 52

Quoted 2 lines
include/qapi/visitor.h +2 -0
+ *
+ * @obj can be NULL (in which case @size should also be 0) to indicate
Quoted 6 lines

"must be 0", because you assert that below.

Actually, I find this @size contract weird. Passing the type's actual size would make at least as much sense as passing 0. We generally pass 0 when the size isn't used, but that's just because it's the easiest value to pass.

We pass 0 precisely when @obj is NULL because that is the usage pattern where we do NOT have a QAPI struct, but are manually using the visitor for its side effects. It's hard to have a non-zero size of a non-existent struct.

Quoted 8 lines

include/qapi/visitor.h typedef struct GenericList · line 55

Quoted 4 lines
include/qapi/visitor.h +3 -0
+ * that there is no qapi C struct, and that the upcoming visit calls
+ * are parsing input to or creating output from some other
+ * representation.

This is very vague.

Can you point me to code passing null @obj?

Easiest example: hw/ppc/spapr_drc.c. Maybe I should follow danpb's lead and actually put some <example> usage of the visitors in the comments.

Quoted 2 lines

I suspect only some visitors accept null @obj. Which ones?

I didn't check that; will do.

Quoted 10 lines
Quoted 5 lines

+ *
+ * If @obj is not NULL, then input visitors malloc a qapi struct of
+ * @size bytes into *@obj on success, and output visitors expect *@obj
+ * to be a fully-populated qapi struct.

Only input visitors and the dealloc visitor use @obj. The dealloc visitor doesn't need it in start_struct(), but has to save it for end_struct(), because that one doesn't get it passed. Aside: feels stupid.

Probably possible to change, although none of my patches do it yet.

Quoted 4 lines

Only input visitors use @size, and they use it only when @obj isn't null.

Quoted 9 lines

We could make visitors check the member pointers passed to the member visits actually point into (@obj, @size). Then *all* visitors would use @obj and @size. I'm not asking for that to be done, I'm just providing an argument for a tighter contract. The simplest one would be "Some visitors permit @obj to be null. @size must be the struct value's size." Except that doesn't match existing usage. Unless we change it to match, we need to hedge "except @size is unused and may be anything when @obj is null", or "except @size is unused and must be zero when @obj is null".

My intent was the latter - @size is unused and must be zero when @obj is NULL. Also, rather than making every visitor track that @obj for the current visit lies within (@obj, @size) of the parent struct, I'm wondering if it would be better to do that tracking at the qapi-visit-core level - but then we'd have two levels of code tracking a stack of information instead of one.

Quoted 3 lines

This method is an awful mess. Probably because it's serving quite different purposes in the different visitors.

Indeed. visit_type_str() is the best example of the conflict of interest between input and output visitors, in that we can't be const-correct.

At one point, I was half-tempted to split input and output visitors into two separate contracts, rather than trying to merge both types of visits through a single interface and having the interface become a bit unwieldy. But as currently written, it's kind of convenient that a single function in generated qapi-visit.c can handle all the visitors.

Quoted 6 lines
Quoted 4 lines

+ *
+ * Set *@errp on failure; for example, if the input stream does not
+ * have a member @name or if the member is not an object.

What do you mean by "if the member is not an object"?

s/object/struct/

If I'm using the QMP input visitor to parse the string "{ \"a\": 1 }", and call visit_start_struct("a"), I expect an error because "1" is not a struct.

Quoted 2 lines

Any other ways to fail?

I don't think so.

Quoted 3 lines

This is the only function comment that says anything about @errp. Should we document the various failure modes everywhere?

Probably useful. More work, but worth doing.

Quoted 7 lines
Quoted 5 lines

+ *
+ * FIXME: For input visitors, *@obj can be assigned here even if later
+ * visits will fail; this can lead to memory leaks if clients aren't
+ * careful.

Why is this a FIXME? How could it be fixed? More of the same below.

Fixed by 35/37, where we change the return type here, and fix all the visit_type_FOO() functions to use that return type to properly use the dealloc visitor on any partial *@obj, so that the callers of visit_type_FOO() no longer have to worry about partial allocation.

Maybe my wording could be improved here.

Quoted 10 lines

My attempt at explaining intended use:

After visit_start_struct() succeeds, the caller may visit its members one after the other, passing the member's name and address within the struct. Finally, visit_end_struct() needs to be called to clean up.

I guess what the reader really needs here to understand intended use is example code. qapi-code-gen.txt has some. Add a pointer?

Hmm, a pointer to qapi-code-gen would be shorter than an inline <example> blurb. But it only lists the generated usage; I may also want to document the no-QAPI-struct usage (our friend spapr_drc.c again).

Quoted 7 lines
Quoted 4 lines

+ */
void visit_start_struct(Visitor *v, const char *name, void **obj,

                         size_t size, Error **errp);

Please separate each commented declaration with a blank line. Not flagging further instances.

I was trying to group related functions; will switch to one blank in related sets, and two blanks between sets (instead of zero/one).

Quoted 10 lines
Quoted 6 lines

+/**
+ * Complete a struct visit started earlier.
+ * Must be called after any successful use of visit_start_struct(),
+ * even if intermediate processing was skipped due to errors, to allow
+ * the backend to release any resources.

Actually, destroying the visitor is safe even without calling the remaining visit_end_struct(). If we introduce a visitor reset as discussed elsewhere, that could probably be made safe, too.

Except that patch 33/37 asserts that destroying the visitor is only ever done after all visit_end_struct()s have been paired, as a tighter contract which will then let us free up some resources during the end_struct() without having to track them for a potentially-early visitor destruction.

And yes, I already have a followup series posted that introduces a visitor reset, at least for the QMP output visitor (I wasn't sure whether to generalize it to all visitors).

Quoted 11 lines
Quoted 6 lines

+/**
+ * Prepare to visit an implicit struct.
+ * Similar to visit_start_struct(), except that an implicit struct
+ * represents a subset of keys that are present at the same nesting level
+ * of a common object but as a separate qapi C struct, rather than a new
+ * object at a deeper nesting level.

I'm afraid this is impenetrable.

I tried to refresh my memory on visit_start_implicit_struct()'s purpose by reading code, but that's pretty impenetrable, too.

Consider the input string { "a":1, "b":2 }.

With a normal QAPI struct, all fields of the JSON object are part of the same C struct:
Foo { int a; int b; };

and it is visited with:
visit_start_struct(); visit_type_int("a", &a); visit_type_int("b", &b); visit_end_struct();

But with an implicit struct (namely, a branch of a QAPI union type or a member of a QAPI alternate type; we used to also do it for base classes but changed that to inline fields instead), we have more than one C struct that map to the same flat JSON object:
Bar { int b; };
Foo { int a; Bar *sub; }

which is visited with:
visit_start_struct(); visit_type_int("a", &b); visit_start_implicit_struct(&sub); visit_type_int("b", &sub.b); visit_end_implicit_struct(); visit_end_struct();

Suggestions on how to better word it are welcome. I'm basically trying to describe that this function marks the start of a new C struct used as a sub-object while still conceptually parsing the same top-level QAPI struct.

Quoted 6 lines
Quoted 4 lines

+ *
+ * @obj must not be NULL, since this function is only called when
+ * visiting with qapi structs.

Really? Why does qmp_input_start_implicit_struct() check for null then?

Probably worth an independent cleanup. The assertions added in this patch prove that that check is dead.

Quoted 7 lines
Quoted 6 lines

+/**
+ * Prepare to visit a list tied to an object key @name.
+ * @name will be NULL if this is visited as part of another list.
+ * After calling this, the elements must be collected until
+ * visit_next_list() returns NULL, then visit_end_list() must be
+ * used to complete the visit.

Quoted 8 lines

I'm afraid this doesn't really tell me how to visit a list. Perhaps:

After visit_start_list() succeeds, the caller may visit its members one after the other, passing the value of visit_next_list() as @obj, until visit_next_list() returns NULL. Finally, visit_end_list() needs to be called to clean up.

May want to add a pointer to example code in qapi-code-gen.txt.

And it changes again in 34/37.

We have two styles; our generated code, which is roughly:

visit_start_list(&obj);

while (visit_next_list()) {
    visit_type_FOO(element);
}

visit_end_list()

and the manual style of our friend hw/ppc/spapr_drc.c:

visit_start_list(NULL);
while (some other way to decide if data available) {

    visit_type_FOO(element);
}

visit_end_list()

That is, the use of visit_next_list() is optional depending on whether a QAPI list is in use, but the visit_type_FOO() per element is necessary.
We'll see if I can get the next wording attempt a bit easier to understand.

Quoted 13 lines
Quoted 5 lines

+ */
void visit_start_list(Visitor *v, const char *name, Error **errp);
+/**

Quoted 7 lines

+ *
+ * Note that for some visitors (qapi-dealloc and qmp-output), when a
+ * qapi GenericList linked list is not being used (comparable to when
+ * a NULL obj is used for visit_start_struct()), it is acceptable to
+ * bypass the use of visit_next_list() and just directly call the
+ * appropriate visit_type_*() for each element in between the
+ * visit_start_list() and visit_end_list() calls.

Quoted 1 line

I'm confused. Can you point me to code bypassing visit_next_list()?

See above; spapr_drc.c.

Quoted 8 lines
Quoted 1 line

/**

* Check if an optional member @name of an object needs visiting.
* For input visitors, set *@present according to whether the
* corresponding visit_type_*() needs calling; for other visitors,
* leave *@present unchanged. Return *@present for convenience.
bool visit_optional(Visitor *v, const char *name, bool *present);

Quoted 7 lines

Suggest to clarify:

Does optional struct member @name need visiting? @present points to the optional member's has_ flag. Input visitors set *@present according to their input. Other visitors leave it unchanged.
In either case, return *@present.

Thanks. I originally added all the docs in one pass, but some of the docs snuck in via earlier patches during rebase churn, so reviewing it again here helps.

Quoted 13 lines
Quoted 4 lines

+/**
+ * Visit a string value tied to @name in the current object visit.
+ * @name will be NULL if this is visited as part of a list.
+ * @obj must be non-NULL.

Same for the other visit_type_T(), but not specified there.

Quoted 3 lines

Input visitors set *@obj to the parsed
+ * string (never NULL); while output visitors leave *@obj unchanged,
+ * except that a NULL *@obj will be treated the same as "".

Suggest:

Quoted 7 lines

Input visitors set *@obj according to their input (never NULL). Other visitors leave it unchanged. They commonly treat NULL like "".

Quoted 2 lines

+ *
+ * FIXME: Unfortunately not const-correct for output visitors.

Is that fixable?

Not easily, and certainly not as part of this series. The best I can think of is either two interfaces:

char *visit_input_type_str(Visitor *v, const char *name, Error **errp); void visit_output_type_str(Visitor *v, const char *name, const char *value, Error **errp);

used as:

obj.str = visit_input_type_str(v, "foo", &err);
visit_output_type_str(v, "foo", obj.str, &err);

or to make the single interface have more parameters:

void visit_type_str(Visitor *v, const char *name, const char *value_in, char **value_out, Error **errp);

used as:

visit_type_str(v, "foo", obj.str, &obj.str, &err);

where input visits could pass NULL instead of value_in, and output visits could pass NULL instead of value_out.

But either way, consistency would then argue that ALL visit_type_FOO() interfaces should either have two forms (one for input, one for output) or have more parameters (with input distinct from output), and it would allow const-correctness on output visits of more than just strings. And which form would a dealloc visitor use?

Quoted 11 lines
Quoted 3 lines

+/**
+ * Mark the start of visiting the branches of a union. Return true if
+ * @data_present.

Not quite. Actually returns true when the visitor doesn't provide this callback, or else whatever its callback returns. Only the dealloc visitor provides it, and it returns @data_present.

You remove the function along with visit_end_union() in PATCH 32. I'd be okay with leaving them undocumented apart from the FIXME until then. But if we add a contract now, it better be correct.

I like the 'FIXME'-only approach.

Signature · 2 lines
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org
#73 lore raw

Re: [Qemu-devel] [PATCH v9 21/37] qapi: Document visitor interfaces, add assertions

Quoted 7 lines · Eric Blake
Quoted 2 lines · Markus Armbruster

All right, this one's a bear. Not because the patch is bad, but because what it tries to do is bloody difficult.

Is there any reasonable split (such as adding some of the assertions in earlier patches) that would make it any easier? Or do we just bite the bullet and do it?

I think the difficulty is in finding a contract that fits the current code and makes sense.

Assertions and contract overlap: assertions partly enforce the contract. Separating the two won't help.

We could try to split along sub-interface boundaries, say scalars, structs, unions, alternates, lists. Several smaller patches, but to ensure overall consistency, you have to mentally merge them again. Doesn't seem helpful.

Let's bite the bullet.

Quoted 56 lines
Quoted 6 lines
Quoted 2 lines · Eric Blake

The visitor interface for mapping between QObject/QemuOpts/string and qapi has formerly been documented only by reading source code,

Polite way to say "is scandalously undocumented".

Indeed.

Quoted 10 lines
Quoted 7 lines

making it difficult to propose changes to either scripts/qapi*.py or to clients without knowing whether those changes would be safe. This adds documentation, including mentioning when parameters can be NULL, and where there are still some interface warts that would be nice to remove. In particular, I have plans to remove visit_start_union() in a future patch.

Suggest

Quoted 7 lines

The visitor interface for mapping between QObject/QemuOpts/string and QAPI is pretty much undocumented, making changes to visitor core, individual visitors, and users of visitors difficult.

Correct this by retrofitting proper contracts. Document some interface warts that would be nice to remove. In particular, I have plans to remove visit_start_union() in a future patch.

Your suggestions here, and elsewhere, are good and will be in my next spin. I'll trim to just the places where you have more than just a wording suggestion.

Quoted 8 lines
Quoted 5 lines
 include/qapi/visitor-impl.h |  31 ++++++-
 include/qapi/visitor.h      | 196 ++++++++++++++++++++++++++++++++++++++++++++
 qapi/qapi-visit-core.c      |  39 ++++++++-
 3 files changed, 262 insertions(+), 4 deletions(-)

My review probably makes more sense if you skip ahead to visitor.h, then come back here.

If I remember, I'll use -O when generating v10 to force visitor.h first, other .h second, and .c last (I don't always remember to do it; maybe I should add it into my handy .git alias that I use for firing off long series). [I really wish the git people would make it possible to automate -O via 'git config', and to make it easier to have a per-project preferred order file]

Quoted 8 lines
Quoted 7 lines
include/qapi/visitor-impl.h +3 -1
+
 struct Visitor
 {
-    /* Must be set */
+    /* Must be provided to visit structs (the string visitors do not
+     * currently visit structs). */
Quoted 7 lines
Quoted 3 lines

Uh, the string visitors don't decide what gets visited, their users do. The string visitors don't support visiting structs. The restriction needs to be documented, but this isn't the place to do it, is it?

Good point. I think what I will do is split out a separate patch that documents, per visitor with limitation, what callers cannot (yet) do with that visitor.

Makes sense.

Quoted 28 lines
Quoted 6 lines
Quoted 1 line

+ /* May be NULL; most useful for input visitors. */

"Optional" would be a bit terser than "May be NULL".

Why is it "most useful for input visitors"? For what it's worth, the dealloc visitor finds it useful, too...

and a later patch adds it to the QemuOpts input visitor (Zoltan's patch has been sitting for how many months now?). I'll come up with something.

Quoted 13 lines

include/qapi/visitor-impl.h line 45

Quoted 12 lines
     void (*start_implicit_struct)(Visitor *v, void **obj, size_t size,
                                   Error **errp);
     /* May be NULL */
     void (*end_implicit_struct)(Visitor *v);
include/qapi/visitor-impl.h +2 -0
+    /* Must be set */
     void (*start_list)(Visitor *v, const char *name, Error **errp);
+    /* Must be set */
     GenericList *(*next_list)(Visitor *v, GenericList **list, Error **errp);
     /* Must be set */
     void (*end_list)(Visitor *v);
Quoted 4 lines

A visitor could omit these two with similar consequences to omitting start_struct() and end_struct(): attempts to visit lists crash then. In fact, the string visitors omitted them until commit 659268f and 69e2556, respectively.

Quoted 6 lines

Which is why, as you pointed out, it may be better to document the limitations in the string visitor rather than here, and in this file maybe just mention at the top something along the lines that "must be set" really means that "only needs to be set if your callers are expecting a visit to encounter this type; the corresponding crash on calling NULL is your hint to write missing functionality in your visitor".

Good idea.

Perhaps say "Must be set for $TYPE visits to work" in each applicable place, and explain what that means just once.

Quoted 28 lines
Quoted 8 lines
Quoted 1 line
     /* May be NULL; only needed for input visitors. */

void (*get_next_type)(Visitor *v, const char *name, QType *type,
bool promote_int, Error **errp);

I figure it must be set for input visitors, because without it, the generated visit function will assume QTYPE_NONE, and fail.

Suggest "Must be set for input visitors."

Correct, and nice wording.

Quoted 17 lines

Looks like we say "must be set to visit this" when at least one visitor doesn't provide, and "must be set" when all our current visitors provide. Hmm.

Quoted 12 lines
     void (*type_any)(Visitor *v, const char *name, QObject **obj,
                      Error **errp);

     /* May be NULL; most useful for input visitors. */
     void (*optional)(Visitor *v, const char *name, bool *present);
include/qapi/visitor-impl.h +2 -0
+    /* FIXME - needs to be removed */
     bool (*start_union)(Visitor *v, bool data_present, Error **errp);
+    /* FIXME - needs to be removed */
     void (*end_union)(Visitor *v, bool data_present, Error **errp);
 };
Quoted 6 lines
Quoted 4 lines
Quoted 1 line

+/**

The /** is a marker for GTK-Doc. We don't actually follow GTK-Doc conventions, however (they suck). Sure we want the extra * anyway?

I don't mind dropping it.

Please do.

Quoted 11 lines
Quoted 10 lines

include/qapi/visitor.h line 23

Quoted 8 lines

+++ b/include/qapi/visitor.h

include/qapi/visitor.h +3 -0
@@ -18,6 +18,20 @@
 #include "qapi/error.h"
 #include <stdlib.h>
 
+/* This file describes the client view for visiting a map between
+ * generated QAPI C structs and another representation (command line
+ * options, strings, or QObjects).

"visiting a map"?

Quoted 4 lines

I'm a victim of too much rebasing. I think I meant:

...the client view for mapping between generated QAPI C structs and another representation...

That makes more sense. It's rather terse, though. I explained the purpose and structur more verbosely below. Perhaps we can and adapt that into an introductory comment. But let's figure out the contract before we worry about the introduction.

Quoted 19 lines
Quoted 10 lines

Review line 26

Quoted 3 lines
(quoted diff) +2 -0
                                     An input visitor converts from
+ * some other form into QAPI representation; an output visitor
+ * converts from QAPI back into another form.

Let me try to work out what this visitor thingy is about.

The QAPI schema defines a set of QAPI types. QAPI types can have members of QAPI type. A value of such a type is actually a root of a graph of QAPI values.

Quoted 8 lines

QAPI generates visitor functions to walk these graphs. They currently work only for trees, because that's all we need.

Walking a tree (or graph for that matter) is useful only to actually do something with the nodes. The generated visitor functions do the walking and the visitor classes do the doing. This is the visitor pattern at work: we factor walking the data structure out of the various tasks that need to walk it to do something.

Quoted 4 lines

Additionally, it is possible to use the visitor without a qapi struct, purely for their side effects of translation to or from the alternative representation of that visitor, by manually calling visitor functions in the same order that generated QAPI structs would use.

This is like walking a virtual tree.

Virtual walks add complexity:

* When we walk a real tree, we pass real @obj pointers. When we walk a virtual tree, we pass null pointers.

Example: we pass null to visit_start_struct() when we have no real QAPI struct. However, we *can't* pass null to visits of scalars like visit_type_int(). Scalars must be real.

When exactly are null pointers okay? Or in other words, which parts of the tree may be virtual? Needs to be spelled out.

Does "may be virtual" depend on the actual visitor?

* When we walk a real tree, we use in-tree information to find optional
stuff: visit_optional() for optional members, visit_next_list() for remaining list members, visit_get_next_type() to help find the alternate member in use. When we walk a virtual tree, we make those decisions ourselves.

* Anything else?

Not documenting interfaces breeds interface complexity.

Related complication: the generated visitor functions accept half-constructed trees, because we need to be able to destroy such trees with the dealloc visitor. If you visit a half-constructed tree with an output visitor, the visit function doesn't flag the misuse, and the output will be garbage.

Quoted 11 lines
Quoted 8 lines

Three kinds of visitor classes exist: two output visitors (QMP and string), three input visitors (QMP, string and QemuOpts), and the dealloc visitor.

With an output visitor, the visitor functions walk a tree, and the output visitor builds up some output. QmpOutputVisitor builds a QObject matching QMP wire format,, and StringOutputVisitor builds a C string. Both convert a QAPI tree to another representation.

Or, when passed NULL obj, create the other representation out of thin air from the manual visit.

Mind, I'm talking about the generated visitor

With an output visitor, the visitor functions walk a tree (real or virtual), and...

Quoted 11 lines
Quoted 8 lines

Similarly with the QapiDeallocVisitor, except nothing gets built. Instead, the tree gets destroyed node by node.

With an input visitor, the visitor functions walk a tree as the input visitor constructs it. QmpInputVisitor constructs it from a QObject matching QMP wire format, StringInputVisitor from a C string, and OptsVisitor from a QemuOpts. All three convert from another representation to a QAPI tree.

Or, when passed NULL obj, parse the other representation via a manual visit with no QAPI object involved.

Actually, the generated visitor functions assume real trees. Possibly half-constructed ones (see "related complication" above). Null should only occur in a half-constructed tree. The generated visitor functions then skip over that part.

To walk the virtual part of a tree, you need to stitch together calls of the visitor.h interface yourself. I guess that's what you call "manual visit".

I think the introduction should explain visiting real trees first, and virtual trees second, to keep complexity under control.

Quoted 24 lines
Quoted 5 lines

The Qmp visitors and the dealloc visitor a general: they can walk / build any QAPI tree.

The string visitors and the QemuOpts visitor have restrictions: they can walk / build only a subset.

Yes.

Quoted 7 lines

include/qapi/visitor.h typedef struct GenericList · line 45

Quoted 2 lines
include/qapi/visitor.h +2 -0
+/**
+ * Prepare to visit an object tied to key @name.

Not just any object, but a *struct*. Suggest:

* Start visiting struct value @obj.

Quoted 8 lines

Review line 29

Quoted 1 line
(quoted diff) +1 -0
+ * @name will be NULL if this is visited as part of a list.

I'm afraid reality is a bit messier.

If the visited object is a member of struct or union, @name is its member name.

If it's a member of a list, @name is null.

Quoted 8 lines

[side thread in earlier message about possibly using "name[0]" instead of NULL, as a later improvement]

Quoted 2 lines

If it's a command argument, @name is its parameter name.

But this is a special case of "visiting as part of a struct", since we have a (possibly-implicit) QAPI struct for parameters.

Conceptually, yes. In actual code, the struct need not exist, and then the name comes from different code, which could result in different @name. That's why I made it a separate clause. Turns out @name is the same, i.e. we didn't screw that one up.

Quoted 5 lines
Quoted 2 lines

If it's a command's result, @name is a meaningless string (qmp-marshal.c currently uses "unused").

But this is a special case of a root visit (the command result is the top of a visit, so @name is meaningless).

In actual code, this is a differnet root visit, and it actually does things differently: "unused" rather than NULL. The difference is of course pointless.

Quoted 3 lines
Quoted 1 line

Else, @name can be a meaningless string or null.

And this sentence is reached only for a root visit.

Unless I missed a case. I wasn't quite sure, so I used a catch-all clause.

Quoted 6 lines

So now I'm thinking
along these lines:

As the first object in a visit (the root of a QAPI struct), @name is meaningless. It is typically set to NULL or a descriptive string, although some callers pass "unused".

Scratch "or a descriptive string".

Quoted 3 lines

At all other points of the visit, @name reflects the relationship of this visit to the parent. Either the visited object is a member of a struct or union,

alternate?

Quoted 2 lines

and @name is its member name; or the visited object is
the member of a list and @name is NULL.

Works for me.

We'll likely have to change it to get sane error messages, but let's not worry about that now.

Quoted 4 lines
Quoted 1 line

Same for other visit functions.

Is it okay to write it out once, and then have all other functions refer back to the common location?

Yes, please.

Quoted 18 lines
Quoted 11 lines

include/qapi/visitor.h typedef struct GenericList · line 50

Quoted 5 lines
include/qapi/visitor.h +4 -0
                                                              The
+ * caller then makes a series of visit calls for each key expected in
+ * the object, where those visits set their respective obj parameter
+ * to the address of a member of the qapi struct, and follows
+ * everything by a call to visit_end_struct() to clean up resources.

I'd explain intended use after the parameters.

include/qapi/visitor.h typedef struct GenericList · line 52

Quoted 2 lines
include/qapi/visitor.h +2 -0
+ *
+ * @obj can be NULL (in which case @size should also be 0) to indicate
Quoted 6 lines

"must be 0", because you assert that below.

Actually, I find this @size contract weird. Passing the type's actual size would make at least as much sense as passing 0. We generally pass 0 when the size isn't used, but that's just because it's the easiest value to pass.

Quoted 4 lines

We pass 0 precisely when @obj is NULL because that is the usage pattern where we do NOT have a QAPI struct, but are manually using the visitor for its side effects. It's hard to have a non-zero size of a non-existent struct.

"I don't have a struct, and therefore I don't have a size, and therefore the size must be zero" isn't exactly impeccable logic, but defensible.

Equally defensible, at least for me: "my struct is virtual, and its size is the same as if it was real".

Why constrain @size when it's not used? Just document that it's not used.

Quoted 21 lines
Quoted 7 lines

include/qapi/visitor.h typedef struct GenericList · line 55

Quoted 3 lines
include/qapi/visitor.h +3 -0
+ * that there is no qapi C struct, and that the upcoming visit calls
+ * are parsing input to or creating output from some other
+ * representation.

This is very vague.

Can you point me to code passing null @obj?

Easiest example: hw/ppc/spapr_drc.c. Maybe I should follow danpb's lead and actually put some <example> usage of the visitors in the comments.

Quoted 1 line

I suspect only some visitors accept null @obj. Which ones?

I didn't check that; will do.

Quoted 6 lines
Quoted 5 lines

+ *
+ * If @obj is not NULL, then input visitors malloc a qapi struct of
+ * @size bytes into *@obj on success, and output visitors expect *@obj
+ * to be a fully-populated qapi struct.

Quoted 6 lines
Quoted 4 lines

Only input visitors and the dealloc visitor use @obj. The dealloc visitor doesn't need it in start_struct(), but has to save it for end_struct(), because that one doesn't get it passed. Aside: feels stupid.

Probably possible to change, although none of my patches do it yet.

Please think twice before from growing the QAPI patch queue further. We really, really need to clear it. A TODO comment would be welcome, though.

Quoted 13 lines
Quoted 12 lines

Only input visitors use @size, and they use it only when @obj isn't null.

We could make visitors check the member pointers passed to the member visits actually point into (@obj, @size). Then *all* visitors would use @obj and @size. I'm not asking for that to be done, I'm just providing an argument for a tighter contract. The simplest one would be "Some visitors permit @obj to be null. @size must be the struct value's size." Except that doesn't match existing usage. Unless we change it to match, we need to hedge "except @size is unused and may be anything when @obj is null", or "except @size is unused and must be zero when @obj is null".

Quoted 6 lines

My intent was the latter - @size is unused and must be zero when @obj is NULL. Also, rather than making every visitor track that @obj for the current visit lies within (@obj, @size) of the parent struct, I'm wondering if it would be better to do that tracking at the qapi-visit-core level - but then we'd have two levels of code tracking a stack of information instead of one.

I don't think we should do this tracking now. This is just about figuring out a sensible contract without undue clinging to what the current code does.

Quoted 7 lines
Quoted 2 lines

This method is an awful mess. Probably because it's serving quite different purposes in the different visitors.

Indeed. visit_type_str() is the best example of the conflict of interest between input and output visitors, in that we can't be const-correct.

Quoted 5 lines

At one point, I was half-tempted to split input and output visitors into two separate contracts, rather than trying to merge both types of visits through a single interface and having the interface become a bit unwieldy. But as currently written, it's kind of convenient that a single function in generated qapi-visit.c can handle all the visitors.

It's a tradeoff. The generated visitor code is repetitive enough as it is.

Quoted 15 lines
Quoted 5 lines
Quoted 3 lines

+ *
+ * Set *@errp on failure; for example, if the input stream does not
+ * have a member @name or if the member is not an object.

What do you mean by "if the member is not an object"?

s/object/struct/

If I'm using the QMP input visitor to parse the string "{ \"a\": 1 }", and call visit_start_struct("a"), I expect an error because "1" is not a struct.

Quoted 2 lines

Any other ways to fail?

Quoted 7 lines

I don't think so.

Quoted 3 lines

This is the only function comment that says anything about @errp. Should we document the various failure modes everywhere?

Probably useful. More work, but worth doing.

I think documenting the failure modes is something we could split off this patch.

Quoted 7 lines
Quoted 6 lines
Quoted 4 lines

+ *
+ * FIXME: For input visitors, *@obj can be assigned here even if later
+ * visits will fail; this can lead to memory leaks if clients aren't
+ * careful.

Why is this a FIXME? How could it be fixed? More of the same below.

Quoted 8 lines

Fixed by 35/37, where we change the return type here, and fix all the visit_type_FOO() functions to use that return type to properly use the dealloc visitor on any partial *@obj, so that the callers of visit_type_FOO() no longer have to worry about partial allocation.

Maybe my wording could be improved here.

From the current wording, I gather the interface is needlessly hard to

use correctly, but I don't understand how exactly users can screw up. I hope I will after review of PATCH 35. Perhaps I can suggest clearer wording then.

Quoted 7 lines
Quoted 7 lines

My attempt at explaining intended use:

After visit_start_struct() succeeds, the caller may visit its members one after the other, passing the member's name and address within the struct. Finally, visit_end_struct() needs to be called to clean up.

Quoted 6 lines
Quoted 2 lines

I guess what the reader really needs here to understand intended use is example code. qapi-code-gen.txt has some. Add a pointer?

Hmm, a pointer to qapi-code-gen would be shorter than an inline <example> blurb. But it only lists the generated usage; I may also want to document the no-QAPI-struct usage (our friend spapr_drc.c again).

That's an argument against doing it in qapi-code-gen.txt, because walking virtual trees is probably out of scope there.

Quoted 21 lines
Quoted 6 lines
Quoted 3 lines

+ */
void visit_start_struct(Visitor *v, const char *name, void **obj,

                         size_t size, Error **errp);

Please separate each commented declaration with a blank line. Not flagging further instances.

I was trying to group related functions; will switch to one blank in related sets, and two blanks between sets (instead of zero/one).

Quoted 10 lines
Quoted 6 lines

+/**
+ * Complete a struct visit started earlier.
+ * Must be called after any successful use of visit_start_struct(),
+ * even if intermediate processing was skipped due to errors, to allow
+ * the backend to release any resources.

Actually, destroying the visitor is safe even without calling the remaining visit_end_struct(). If we introduce a visitor reset as discussed elsewhere, that could probably be made safe, too.

Quoted 5 lines

Except that patch 33/37 asserts that destroying the visitor is only ever done after all visit_end_struct()s have been paired, as a tighter contract which will then let us free up some resources during the end_struct() without having to track them for a potentially-early visitor destruction.

Requiring all outstanding end_FOO()s to be called before you may destroy or reset makes the interface harder to use. Moreover, not being able to destroy at any time is unusual. I can accept this if it makes the code substantially simpler.

Quoted 39 lines

And yes, I already have a followup series posted that introduces a visitor reset, at least for the QMP output visitor (I wasn't sure whether to generalize it to all visitors).

Quoted 11 lines
Quoted 6 lines

+/**
+ * Prepare to visit an implicit struct.
+ * Similar to visit_start_struct(), except that an implicit struct
+ * represents a subset of keys that are present at the same nesting level
+ * of a common object but as a separate qapi C struct, rather than a new
+ * object at a deeper nesting level.

I'm afraid this is impenetrable.

I tried to refresh my memory on visit_start_implicit_struct()'s purpose by reading code, but that's pretty impenetrable, too.

Consider the input string { "a":1, "b":2 }.

With a normal QAPI struct, all fields of the JSON object are part of the same C struct:
Foo { int a; int b; };

and it is visited with:
visit_start_struct(); visit_type_int("a", &a); visit_type_int("b", &b); visit_end_struct();

But with an implicit struct (namely, a branch of a QAPI union type or a member of a QAPI alternate type; we used to also do it for base classes but changed that to inline fields instead), we have more than one C struct that map to the same flat JSON object:
Bar { int b; };
Foo { int a; Bar *sub; }

which is visited with:
visit_start_struct(); visit_type_int("a", &b); visit_start_implicit_struct(&sub); visit_type_int("b", &sub.b); visit_end_implicit_struct(); visit_end_struct();

Quoted 4 lines

Suggestions on how to better word it are welcome. I'm basically trying to describe that this function marks the start of a new C struct used as a sub-object while still conceptually parsing the same top-level QAPI struct.

Thinking aloud...

QAPI defines both C data types and a QMP wire format.

The work of mapping between the two is split between generated visitor functions and the QMP visitors. Roughly, the visitor functions direct the mapping of the tree structure, and the QMP visitors take care of the leaves.

The QAPI tree structure and the QMP tree structure are roughly the same.
Exception: some structs are inlined into a parent struct in QMP, but stored as a separate, boxed struct in QAPI. We call them "implicit" structs. We got rid of one case (base structs), but we still got two (flat union and alternate members). I dislike the exception, but we need to document what we've got.

It's mostly handled by the visitor functions, but two visitors need to hook into their handling, because they allocate / free the boxed struct:
the QMP input visitor and the dealloc visitor.

The QMP output visitor doesn't. The effect is that the members of the implicit struct get inlined into the explicit struct that surrounds it.

I oversimplified when I said "and a QMP wire format": since we acquired string and QemuOpts visitors, we also have a string and QemuOpts format. Both are partial: they don't support all of QAPI.

However, these formats aren't independent of the QMP wire format. Since we use the same visitor functions, and the visitor functions map the tree structure, the tree structure gets mapped just like for QMP. Almost theoretical, because these visitors don't support most of the structure.

If we wanted a format that doesn't inline implicit structs, the visitor would want to implement visit_start_implicit_struct() and visit_end_implicit_struct() just like visit_start_struct() and visit_end_struct(). Differences:

* start_implicit_struct() lacks the @name parameter.

* end_implicit_struct() lacks the @errp now. Later in this series, this
becomes: there is no check_implicit_struct().

Not inlining implicit structs seems impossible with the current API. I'm *not* asking for a change that makes it possible. Instead, my point
is: the inlining of implicit structs is baked into the visitor interfaces.

I'm afraid I can't turn this into a reasonable function comment without first amending the introduction comment to cover tree structure mapping. Ugh.

Crazy thought: unboxing the implicit struct should make this interface wart go away. If we commit to do that later, we can "solve" our documentation problem the same way as for visit_start_union(): FIXME should not be needed.

Quoted 8 lines
Quoted 5 lines
Quoted 3 lines

+ *
+ * @obj must not be NULL, since this function is only called when
+ * visiting with qapi structs.

Really? Why does qmp_input_start_implicit_struct() check for null then?

Probably worth an independent cleanup. The assertions added in this patch prove that that check is dead.

Please do that; such contradictions can be terribly confusing.

Quoted 9 lines
Quoted 9 lines
Quoted 6 lines

+/**
+ * Prepare to visit a list tied to an object key @name.
+ * @name will be NULL if this is visited as part of another list.
+ * After calling this, the elements must be collected until
+ * visit_next_list() returns NULL, then visit_end_list() must be
+ * used to complete the visit.

I'm afraid this doesn't really tell me how to visit a list. Perhaps:

Quoted 8 lines
Quoted 6 lines

After visit_start_list() succeeds, the caller may visit its members one after the other, passing the value of visit_next_list() as @obj, until visit_next_list() returns NULL. Finally, visit_end_list() needs to be called to clean up.

May want to add a pointer to example code in qapi-code-gen.txt.

And it changes again in 34/37.

Reviewers are too myopic to see beyond the current patch, let alone 13 patches ahead :)

Quoted 7 lines

We have two styles; our generated code, which is roughly:

visit_start_list(&obj);

while (visit_next_list()) {
    visit_type_FOO(element);
}

visit_end_list()

Here, the list is real, i.e. an instance of a QAPI list type.

Quoted 7 lines

and the manual style of our friend hw/ppc/spapr_drc.c:

visit_start_list(NULL);
while (some other way to decide if data available) {

    visit_type_FOO(element);
}

visit_end_list()

Here, the list is virtual, but the list elements are real.

Quoted 16 lines

That is, the use of visit_next_list() is optional depending on whether a QAPI list is in use, but the visit_type_FOO() per element is necessary.
We'll see if I can get the next wording attempt a bit easier to understand.

Quoted 13 lines
Quoted 12 lines

+ */
void visit_start_list(Visitor *v, const char *name, Error **errp);
+/**

+ *
+ * Note that for some visitors (qapi-dealloc and qmp-output), when a
+ * qapi GenericList linked list is not being used (comparable to when
+ * a NULL obj is used for visit_start_struct()), it is acceptable to
+ * bypass the use of visit_next_list() and just directly call the
+ * appropriate visit_type_*() for each element in between the
+ * visit_start_list() and visit_end_list() calls.

Quoted 3 lines
Quoted 1 line

I'm confused. Can you point me to code bypassing visit_next_list()?

See above; spapr_drc.c.

I see clearer now, thanks.

I think the documentation needs to explain the difference between walking a real tree and walking a virtual tree, how to do either, and what visitors need to implement to support either.

Quoted 62 lines
Quoted 8 lines
Quoted 1 line

/**

* Check if an optional member @name of an object needs visiting.
* For input visitors, set *@present according to whether the
* corresponding visit_type_*() needs calling; for other visitors,
* leave *@present unchanged. Return *@present for convenience.
bool visit_optional(Visitor *v, const char *name, bool *present);

Quoted 7 lines

Suggest to clarify:

Does optional struct member @name need visiting? @present points to the optional member's has_ flag. Input visitors set *@present according to their input. Other visitors leave it unchanged.
In either case, return *@present.

Thanks. I originally added all the docs in one pass, but some of the docs snuck in via earlier patches during rebase churn, so reviewing it again here helps.

Quoted 13 lines
Quoted 4 lines

+/**
+ * Visit a string value tied to @name in the current object visit.
+ * @name will be NULL if this is visited as part of a list.
+ * @obj must be non-NULL.

Same for the other visit_type_T(), but not specified there.

Quoted 3 lines

Input visitors set *@obj to the parsed
+ * string (never NULL); while output visitors leave *@obj unchanged,
+ * except that a NULL *@obj will be treated the same as "".

Suggest:

Quoted 7 lines

Input visitors set *@obj according to their input (never NULL). Other visitors leave it unchanged. They commonly treat NULL like "".

Quoted 2 lines

+ *
+ * FIXME: Unfortunately not const-correct for output visitors.

Is that fixable?

Not easily, and certainly not as part of this series. The best I can think of is either two interfaces:

char *visit_input_type_str(Visitor *v, const char *name, Error **errp); void visit_output_type_str(Visitor *v, const char *name, const char *value, Error **errp);

used as:

obj.str = visit_input_type_str(v, "foo", &err);
visit_output_type_str(v, "foo", obj.str, &err);

or to make the single interface have more parameters:

void visit_type_str(Visitor *v, const char *name, const char *value_in, char **value_out, Error **errp);

used as:

visit_type_str(v, "foo", obj.str, &obj.str, &err);

Quoted 8 lines

where input visits could pass NULL instead of value_in, and output visits could pass NULL instead of value_out.

But either way, consistency would then argue that ALL visit_type_FOO() interfaces should either have two forms (one for input, one for output) or have more parameters (with input distinct from output), and it would allow const-correctness on output visits of more than just strings. And which form would a dealloc visitor use?

What a headache...

I asked whether its fixable, because I don't like FIXMEs we can't or don't intend to fix.

Quoted 8 lines
Quoted 8 lines
Quoted 3 lines

+/**
+ * Mark the start of visiting the branches of a union. Return true if
+ * @data_present.

Not quite. Actually returns true when the visitor doesn't provide this callback, or else whatever its callback returns. Only the dealloc visitor provides it, and it returns @data_present.

Quoted 5 lines
Quoted 3 lines

You remove the function along with visit_end_union() in PATCH 32. I'd be okay with leaving them undocumented apart from the FIXME until then. But if we add a contract now, it better be correct.

I like the 'FIXME'-only approach.

Me too.

author
#74 lore raw

Re: [Qemu-devel] [PATCH v9 21/37] qapi: Document visitor interfaces, add assertions

Quoted 3 lines · Markus Armbruster

Please think twice before from growing the QAPI patch queue further. We really, really need to clear it. A TODO comment would be welcome, though.

Yes, especially with 2.6 soft freeze fast approaching.

Quoted 67 lines
Quoted 14 lines
Quoted 11 lines
Quoted 6 lines

+/**
+ * Prepare to visit an implicit struct.
+ * Similar to visit_start_struct(), except that an implicit struct
+ * represents a subset of keys that are present at the same nesting level
+ * of a common object but as a separate qapi C struct, rather than a new
+ * object at a deeper nesting level.

I'm afraid this is impenetrable.

I tried to refresh my memory on visit_start_implicit_struct()'s purpose by reading code, but that's pretty impenetrable, too.

Quoted 4 lines

Suggestions on how to better word it are welcome. I'm basically trying to describe that this function marks the start of a new C struct used as a sub-object while still conceptually parsing the same top-level QAPI struct.

Thinking aloud...

QAPI defines both C data types and a QMP wire format.

The work of mapping between the two is split between generated visitor functions and the QMP visitors. Roughly, the visitor functions direct the mapping of the tree structure, and the QMP visitors take care of the leaves.

The QAPI tree structure and the QMP tree structure are roughly the same.
Exception: some structs are inlined into a parent struct in QMP, but stored as a separate, boxed struct in QAPI. We call them "implicit" structs. We got rid of one case (base structs), but we still got two (flat union and alternate members). I dislike the exception, but we need to document what we've got.

It's mostly handled by the visitor functions, but two visitors need to hook into their handling, because they allocate / free the boxed struct:
the QMP input visitor and the dealloc visitor.

The QMP output visitor doesn't. The effect is that the members of the implicit struct get inlined into the explicit struct that surrounds it.

I oversimplified when I said "and a QMP wire format": since we acquired string and QemuOpts visitors, we also have a string and QemuOpts format. Both are partial: they don't support all of QAPI.

However, these formats aren't independent of the QMP wire format. Since we use the same visitor functions, and the visitor functions map the tree structure, the tree structure gets mapped just like for QMP. Almost theoretical, because these visitors don't support most of the structure.

If we wanted a format that doesn't inline implicit structs, the visitor would want to implement visit_start_implicit_struct() and visit_end_implicit_struct() just like visit_start_struct() and visit_end_struct(). Differences:

* start_implicit_struct() lacks the @name parameter.

* end_implicit_struct() lacks the @errp now. Later in this series, this
becomes: there is no check_implicit_struct().

Not inlining implicit structs seems impossible with the current API. I'm *not* asking for a change that makes it possible. Instead, my point
is: the inlining of implicit structs is baked into the visitor interfaces.

Quoted 8 lines

I'm afraid I can't turn this into a reasonable function comment without first amending the introduction comment to cover tree structure mapping. Ugh.

Crazy thought: unboxing the implicit struct should make this interface wart go away. If we commit to do that later, we can "solve" our documentation problem the same way as for visit_start_union(): FIXME should not be needed.

I _want_ to get rid of the boxing. But as it is not in my current queue of pending patches, it will have to wait until the current queue is flushed; so I'm going for documenting it with FIXMEs for now.

Basically, our current flat union representation is:

struct Union {
    Type tag;
    union {
        Subtype1 *one;
        Subtype2 *two;
    } u;
};

which requires two malloc's to completely populate the struct, and where we access union->u.one->member, or pass union->u.one to a function taking Subtype1*. But it _should_ be:

struct Union {
    Type tag;
    union {
        Subtype1 one;
        Subtype2 two;
    } u;
};

where a single malloc is sufficient, and where we access union->u.one.member, or pass &union->u.one to a function taking Subtype1*.

It's a tree-wide conversion; and may be easier if done in stages (fix the generator to take a temporary boolean flag on whether a particular structure uses inline or boxing, then a series of patches adding that flag to a few QMP commands at a time, then a final patch to clear out the temporary flag support) rather than all at once. I'm not sure how much Coccinelle will help, because I specifically haven't started the conversion work until after we can get the current backlog flushed.

Signature · 2 lines
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org
#75 lore raw

Re: [Qemu-devel] [PATCH v9 21/37] qapi: Document visitor interfaces, add assertions

Quoted 1 line · Eric Blake

On 01/22/2016 05:18 AM, Markus Armbruster wrote:

[...]

Quoted 34 lines
Quoted 4 lines

Crazy thought: unboxing the implicit struct should make this interface wart go away. If we commit to do that later, we can "solve" our documentation problem the same way as for visit_start_union(): FIXME should not be needed.

I _want_ to get rid of the boxing. But as it is not in my current queue of pending patches, it will have to wait until the current queue is flushed; so I'm going for documenting it with FIXMEs for now.

Basically, our current flat union representation is:

struct Union {
    Type tag;
    union {
        Subtype1 *one;
        Subtype2 *two;
    } u;
};

which requires two malloc's to completely populate the struct, and where we access union->u.one->member, or pass union->u.one to a function taking Subtype1*. But it _should_ be:

struct Union {
    Type tag;
    union {
        Subtype1 one;
        Subtype2 two;
    } u;
};

where a single malloc is sufficient, and where we access union->u.one.member, or pass &union->u.one to a function taking Subtype1*.

Quoted 7 lines

It's a tree-wide conversion; and may be easier if done in stages (fix the generator to take a temporary boolean flag on whether a particular structure uses inline or boxing, then a series of patches adding that flag to a few QMP commands at a time, then a final patch to clear out the temporary flag support) rather than all at once. I'm not sure how much Coccinelle will help, because I specifically haven't started the conversion work until after we can get the current backlog flushed.

I hope the use of unions in C code is localized enough to do it in one step.

author
#76 lore raw

PATCH v9 22/37 qapi: Add visit_type_null() visitor

In reply to Eric Blake

Right now, qmp-output-visitor happens to produce a QNull result if nothing is actually visited between the creation of the visitor and the request for the resulting QObject. A stronger protocol would require that a QMP output visit MUST visit something. But to still be able to produce a JSON 'null' output, we need a new visitor function that states our intentions.

This patch introduces the new visit_type_null() interface, and later patches will then wire it up into the qmp visitors.

---
v9: no change
v8: rebase to 'name' motion
v7: new patch, based on discussion about spapr_drc.c

---
 include/qapi/visitor-impl.h | 3 +++
 include/qapi/visitor.h      | 8 ++++++++
 qapi/qapi-dealloc-visitor.c | 5 +++++
 qapi/qapi-visit-core.c      | 5 +++++
 4 files changed, 21 insertions(+)
include/qapi/visitor-impl.h +3 -0
index aab46bc..8705136 100644
@@ -75,6 +75,9 @@ struct Visitor
      * visitors do not currently visit arbitrary types).  */
     void (*type_any)(Visitor *v, const char *name, QObject **obj,
                      Error **errp);
+    /* Must be provided to visit explicit null values (right now, only the
+     * dealloc visitor supports this).  */
+    void (*type_null)(Visitor *v, const char *name, Error **errp);
 
     /* May be NULL; most useful for input visitors. */
     void (*optional)(Visitor *v, const char *name, bool *present);
include/qapi/visitor.h +8 -0
index 5349a64..6e49b51 100644
@@ -267,6 +267,14 @@ void visit_type_number(Visitor *v, const char *name, double *obj,
 void visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp);
 
 /**
+ * Visit a JSON null value tied to @name in the current object visit.
+ * @name will be NULL if this is visited as part of a list.
+ * No obj parameter is needed; rather, this is a witness that an
+ * explicit null value is expected rather than any other type.
+ */
+void visit_type_null(Visitor *v, const char *name, Error **errp);
+
+/**
  * Mark the start of visiting the branches of a union. Return true if
  * @data_present.
  * FIXME: Should not be needed
qapi/qapi-dealloc-visitor.c +5 -0
index 560feb3..ede1703 100644
@@ -162,6 +162,10 @@ static void qapi_dealloc_type_anything(Visitor *v, const char *name,
     }
 }
 
+static void qapi_dealloc_type_null(Visitor *v, const char *name, Error **errp)
+{
+}
+
 static void qapi_dealloc_type_enum(Visitor *v, const char *name, int *obj,
                                    const char * const strings[], Error **errp)
 {
@@ -222,6 +226,7 @@ QapiDeallocVisitor *qapi_dealloc_visitor_new(void)
     v->visitor.type_str = qapi_dealloc_type_str;
     v->visitor.type_number = qapi_dealloc_type_number;
     v->visitor.type_any = qapi_dealloc_type_anything;
+    v->visitor.type_null = qapi_dealloc_type_null;
     v->visitor.start_union = qapi_dealloc_start_union;
 
     QTAILQ_INIT(&v->stack);
qapi/qapi-visit-core.c +5 -0
index 1612d0d..399256b 100644
@@ -262,6 +262,11 @@ void visit_type_any(Visitor *v, const char *name, QObject **obj, Error **errp)
     v->type_any(v, name, obj, errp);
 }
 
+void visit_type_null(Visitor *v, const char *name, Error **errp)
+{
+    v->type_null(v, name, errp);
+}
+
 void output_type_enum(Visitor *v, const char *name, int *obj,
                       const char * const strings[], Error **errp)
 {
Signature · 1 line
2.5.0
#77 lore raw

Re: [Qemu-devel] [PATCH v9 22/37] qapi: Add visit_type_null() visitor

Quoted 6 lines · Eric Blake

Right now, qmp-output-visitor happens to produce a QNull result if nothing is actually visited between the creation of the visitor and the request for the resulting QObject. A stronger protocol would require that a QMP output visit MUST visit something. But to still be able to produce a JSON 'null' output, we need a new visitor function that states our intentions.

Overdue. When we extended the json-parser to accept null, we neglected to extend visitors accordingly. We need to:

* Extend the visitor core (this patch).

* Implement it in at least the visitors that aren't restricted to a
subset: dealloc (this patch), QMP input (next patch), QMP output (patch after next, together with other stuff).

* Update users, if any.

* If QAPI had a 'null' type, we'd also have to use it in the generated visitor functions. It doesn't. I think the 'any' type can hold a null, but that's it. A 'null' type might be useful as an alternate member type. We'll create one when we need it.

Quoted 22 lines

This patch introduces the new visit_type_null() interface, and later patches will then wire it up into the qmp visitors.

---
v9: no change
v8: rebase to 'name' motion
v7: new patch, based on discussion about spapr_drc.c

---
 include/qapi/visitor-impl.h | 3 +++
 include/qapi/visitor.h      | 8 ++++++++
 qapi/qapi-dealloc-visitor.c | 5 +++++
 qapi/qapi-visit-core.c      | 5 +++++
 4 files changed, 21 insertions(+)
include/qapi/visitor-impl.h +0 -0
index aab46bc..8705136 100644

include/qapi/visitor-impl.h struct Visitor · line 79

Quoted 5 lines
include/qapi/visitor-impl.h +2 -0
@@ -75,6 +75,9 @@ struct Visitor
      * visitors do not currently visit arbitrary types).  */
     void (*type_any)(Visitor *v, const char *name, QObject **obj,
                      Error **errp);
+    /* Must be provided to visit explicit null values (right now, only the
+     * dealloc visitor supports this).  */

Will need updating to match whatever convention we pick in the previous patch for documenting "mandatory to visit X", and the restrictions on visitor use resulting from some of them not implementing it.

Quoted 4 lines
include/qapi/visitor-impl.h +1 -0
+    void (*type_null)(Visitor *v, const char *name, Error **errp);
 
     /* May be NULL; most useful for input visitors. */
     void (*optional)(Visitor *v, const char *name, bool *present);

[...]

author
#78 lore raw

PATCH v9 23/37 qmp: Support explicit null during input visit

In reply to Eric Blake

Implement the new type_null() callback for the qmp input visitor. While we don't yet have a use for this in qapi (the generator will need some tweaks first), one usage is already envisioned:
when changing blockdev parameters, it would be nice to have a difference between leaving a tuning parameter unchanged (omit that parameter from the struct) and to explicitly reset the parameter to its default without having to know what the default value is (specify the parameter with an explicit null value, which will require us to allow a qapi alternate that chooses between the normal value and an explicit null).

At any rate, we can test this without the use of generated qapi by manually using visit_start_struct()/visit_end_struct().

---
v9: new patch

---
 include/qapi/visitor-impl.h    |  2 +-
 qapi/qmp-input-visitor.c       | 14 ++++++++++++++
 tests/test-qmp-input-visitor.c | 26 ++++++++++++++++++++++++++
 3 files changed, 41 insertions(+), 1 deletion(-)
include/qapi/visitor-impl.h +1 -1
index 8705136..95408a5 100644
@@ -76,7 +76,7 @@ struct Visitor
     void (*type_any)(Visitor *v, const char *name, QObject **obj,
                      Error **errp);
     /* Must be provided to visit explicit null values (right now, only the
-     * dealloc visitor supports this).  */
+     * dealloc and qmp-input visitors support this).  */
     void (*type_null)(Visitor *v, const char *name, Error **errp);
 
     /* May be NULL; most useful for input visitors. */
qapi/qmp-input-visitor.c +14 -0
index 597652c..ad23bec 100644
@@ -315,6 +315,19 @@ static void qmp_input_type_any(Visitor *v, const char *name, QObject **obj,
     *obj = qobj;
 }
 
+static void qmp_input_type_null(Visitor *v, const char *name, Error **errp)
+{
+    QmpInputVisitor *qiv = to_qiv(v);
+    QObject *qobj = qmp_input_get_object(qiv, name, true);
+
+    if (qobject_type(qobj) == QTYPE_QNULL) {
+        return;
+    }
+
+    error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
+               "null");
+}
+
 static void qmp_input_optional(Visitor *v, const char *name, bool *present)
 {
     QmpInputVisitor *qiv = to_qiv(v);
@@ -358,6 +371,7 @@ QmpInputVisitor *qmp_input_visitor_new(QObject *obj)
     v->visitor.type_str = qmp_input_type_str;
     v->visitor.type_number = qmp_input_type_number;
     v->visitor.type_any = qmp_input_type_any;
+    v->visitor.type_null = qmp_input_type_null;
     v->visitor.optional = qmp_input_optional;
     v->visitor.get_next_type = qmp_input_get_next_type;
 
tests/test-qmp-input-visitor.c +26 -0
index f6bd408..6489e4a 100644
@@ -278,6 +278,30 @@ static void test_visitor_in_any(TestInputVisitorData *data,
     qobject_decref(res);
 }
 
+static void test_visitor_in_null(TestInputVisitorData *data,
+                                 const void *unused)
+{
+    Visitor *v;
+    QObject *null;
+
+    v = visitor_input_test_init(data, "null");
+    visit_type_null(v, NULL, &error_abort);
+
+    v = visitor_input_test_init(data, "{ 'a': null }");
+    visit_start_struct(v, NULL, NULL, 0, &error_abort);
+    visit_type_null(v, "a", &error_abort);
+    visit_end_struct(v, &error_abort);
+
+    /* Check that qnull reference counting is sane:
+     * 1 for global use, 1 for our qnull() use, and 1 still owned by 'v'
+     * until it is torn down */
+    null = qnull();
+    g_assert(null->refcnt == 3);
+    visitor_input_teardown(data, NULL);
+    g_assert(null->refcnt == 2);
+    qobject_decref(null);
+}
+
 static void test_visitor_in_union_flat(TestInputVisitorData *data,
                                        const void *unused)
 {
@@ -792,6 +816,8 @@ int main(int argc, char **argv)
                            &in_visitor_data, test_visitor_in_list);
     input_visitor_test_add("/visitor/input/any",
                            &in_visitor_data, test_visitor_in_any);
+    input_visitor_test_add("/visitor/input/null",
+                           &in_visitor_data, test_visitor_in_null);
     input_visitor_test_add("/visitor/input/union-flat",
                            &in_visitor_data, test_visitor_in_union_flat);
     input_visitor_test_add("/visitor/input/alternate",
Signature · 1 line
2.5.0
#79 lore raw

Re: [Qemu-devel] [PATCH v9 23/37] qmp: Support explicit null during input visit

Quoted 11 lines · Eric Blake

Implement the new type_null() callback for the qmp input visitor. While we don't yet have a use for this in qapi (the generator will need some tweaks first), one usage is already envisioned:
when changing blockdev parameters, it would be nice to have a difference between leaving a tuning parameter unchanged (omit that parameter from the struct) and to explicitly reset the parameter to its default without having to know what the default value is (specify the parameter with an explicit null value, which will require us to allow a qapi alternate that chooses between the normal value and an explicit null).

Quoted 2 lines

At any rate, we can test this without the use of generated qapi by manually using visit_start_struct()/visit_end_struct().

Well, we test by calling visit_type_null() manually. We choose to wrap it in a visit_start_struct() ... visit_end_struct() pair, but that's detail. Actually, we do an unwrapped root visit first, and then a struct-wrapped visit.

Suggest "by calling visit_type_null() manually."

Quoted 15 lines

---
v9: new patch

---
 include/qapi/visitor-impl.h    |  2 +-
 qapi/qmp-input-visitor.c       | 14 ++++++++++++++
 tests/test-qmp-input-visitor.c | 26 ++++++++++++++++++++++++++
 3 files changed, 41 insertions(+), 1 deletion(-)
include/qapi/visitor-impl.h +0 -0
index 8705136..95408a5 100644

include/qapi/visitor-impl.h struct Visitor · line 79

Quoted 5 lines
include/qapi/visitor-impl.h +1 -1
@@ -76,7 +76,7 @@ struct Visitor
     void (*type_any)(Visitor *v, const char *name, QObject **obj,
                      Error **errp);
     /* Must be provided to visit explicit null values (right now, only the
-     * dealloc visitor supports this).  */
+     * dealloc and qmp-input visitors support this).  */

Will need updating.

Quoted 12 lines
include/qapi/visitor-impl.h +0 -0
     void (*type_null)(Visitor *v, const char *name, Error **errp);
 
     /* May be NULL; most useful for input visitors. */
qapi/qmp-input-visitor.c +1 -0
index 597652c..ad23bec 100644
@@ -315,6 +315,19 @@ static void qmp_input_type_any(Visitor *v, const char *name, QObject **obj,
     *obj = qobj;
 }
 
+static void qmp_input_type_null(Visitor *v, const char *name, Error **errp)

qapi/qmp-input-visitor.c static void qmp_input_type_any(Visitor *v, const char *name, QObject **obj, · line 328

Quoted 10 lines
qapi/qmp-input-visitor.c +10 -0
+{
+    QmpInputVisitor *qiv = to_qiv(v);
+    QObject *qobj = qmp_input_get_object(qiv, name, true);
+
+    if (qobject_type(qobj) == QTYPE_QNULL) {
+        return;
+    }
+
+    error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
+               "null");

Recommend to put the error in the conditional:

    if (qobject_type(qobj) != QTYPE_QNULL) {
        error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
                   "null");
    }
Quoted 33 lines
qapi/qmp-input-visitor.c +3 -0
+}
+
 static void qmp_input_optional(Visitor *v, const char *name, bool *present)
 {
     QmpInputVisitor *qiv = to_qiv(v);
@@ -358,6 +371,7 @@ QmpInputVisitor *qmp_input_visitor_new(QObject *obj)
     v->visitor.type_str = qmp_input_type_str;
     v->visitor.type_number = qmp_input_type_number;
     v->visitor.type_any = qmp_input_type_any;
+    v->visitor.type_null = qmp_input_type_null;
     v->visitor.optional = qmp_input_optional;
     v->visitor.get_next_type = qmp_input_get_next_type;
 
tests/test-qmp-input-visitor.c +12 -0
index f6bd408..6489e4a 100644
@@ -278,6 +278,30 @@ static void test_visitor_in_any(TestInputVisitorData *data,
     qobject_decref(res);
 }
 
+static void test_visitor_in_null(TestInputVisitorData *data,
+                                 const void *unused)
+{
+    Visitor *v;
+    QObject *null;
+
+    v = visitor_input_test_init(data, "null");
+    visit_type_null(v, NULL, &error_abort);
+
+    v = visitor_input_test_init(data, "{ 'a': null }");
+    visit_start_struct(v, NULL, NULL, 0, &error_abort);
+    visit_type_null(v, "a", &error_abort);

tests/test-qmp-input-visitor.c static void test_visitor_in_any(TestInputVisitorData *data, · line 302

Quoted 10 lines
tests/test-qmp-input-visitor.c +10 -0
+    visit_end_struct(v, &error_abort);
+
+    /* Check that qnull reference counting is sane:
+     * 1 for global use, 1 for our qnull() use, and 1 still owned by 'v'
+     * until it is torn down */
+    null = qnull();
+    g_assert(null->refcnt == 3);
+    visitor_input_teardown(data, NULL);
+    g_assert(null->refcnt == 2);
+    qobject_decref(null);

For other kinds of QObject, we leave the testing of reference counting to the check-qKIND.c, and don't bother with it when testing the visitors. Any particular reason to do null differently?

Quoted 14 lines
tests/test-qmp-input-visitor.c +4 -0
+}
+
 static void test_visitor_in_union_flat(TestInputVisitorData *data,
                                        const void *unused)
 {
@@ -792,6 +816,8 @@ int main(int argc, char **argv)
                            &in_visitor_data, test_visitor_in_list);
     input_visitor_test_add("/visitor/input/any",
                            &in_visitor_data, test_visitor_in_any);
+    input_visitor_test_add("/visitor/input/null",
+                           &in_visitor_data, test_visitor_in_null);
     input_visitor_test_add("/visitor/input/union-flat",
                            &in_visitor_data, test_visitor_in_union_flat);
     input_visitor_test_add("/visitor/input/alternate",
author
#80 lore raw

Re: [Qemu-devel] [PATCH v9 23/37] qmp: Support explicit null during input visit

Quoted 41 lines · Markus Armbruster
Quoted 11 lines · Eric Blake

Implement the new type_null() callback for the qmp input visitor. While we don't yet have a use for this in qapi (the generator will need some tweaks first), one usage is already envisioned:
when changing blockdev parameters, it would be nice to have a difference between leaving a tuning parameter unchanged (omit that parameter from the struct) and to explicitly reset the parameter to its default without having to know what the default value is (specify the parameter with an explicit null value, which will require us to allow a qapi alternate that chooses between the normal value and an explicit null).

Quoted 2 lines

At any rate, we can test this without the use of generated qapi by manually using visit_start_struct()/visit_end_struct().

Well, we test by calling visit_type_null() manually. We choose to wrap it in a visit_start_struct() ... visit_end_struct() pair, but that's detail. Actually, we do an unwrapped root visit first, and then a struct-wrapped visit.

Suggest "by calling visit_type_null() manually."

Quoted 5 lines

---

qapi/qmp-input-visitor.c +1 -0
+static void qmp_input_type_null(Visitor *v, const char *name, Error **errp)

qapi/qmp-input-visitor.c static void qmp_input_type_any(Visitor *v, const char *name, QObject **obj, · line 328

Quoted 10 lines
qapi/qmp-input-visitor.c +10 -0
+{
+    QmpInputVisitor *qiv = to_qiv(v);
+    QObject *qobj = qmp_input_get_object(qiv, name, true);
+
+    if (qobject_type(qobj) == QTYPE_QNULL) {
+        return;
+    }
+
+    error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
+               "null");

Recommend to put the error in the conditional:

Quoted 4 lines
    if (qobject_type(qobj) != QTYPE_QNULL) {
        error_setg(errp, QERR_INVALID_PARAMETER_TYPE, name ? name : "null",
                   "null");
    }

Sure, I can reflow the logic.

Quoted 9 lines

tests/test-qmp-input-visitor.c static void test_visitor_in_any(TestInputVisitorData *data, · line 302

Quoted 8 lines
tests/test-qmp-input-visitor.c +8 -0
+    /* Check that qnull reference counting is sane:
+     * 1 for global use, 1 for our qnull() use, and 1 still owned by 'v'
+     * until it is torn down */
+    null = qnull();
+    g_assert(null->refcnt == 3);
+    visitor_input_teardown(data, NULL);
+    g_assert(null->refcnt == 2);
+    qobject_decref(null);
Quoted 3 lines

For other kinds of QObject, we leave the testing of reference counting to the check-qKIND.c, and don't bother with it when testing the visitors. Any particular reason to do null differently?

Well, 19/37 added reference counting checks to test-qmp-output-visitor.c, and we don't have a check-qnull.c test yet. That, and the thing being checked here is that the visitor doesn't over- or under-reference the static qnull object (just checking qnull() without a visitor doesn't tell you if the visitor has any reference counting bugs). But maybe it is indeed worth writing a check-qnull.c file that does this work.

Signature · 2 lines
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org
author
#81 lore raw

PATCH v9 24/37 qmp: Tighten output visitor rules

In reply to Eric Blake

Add a new qmp_output_visitor_reset(), which must be called before reusing an exising QmpOutputVisitor on a new root object. Tighten assertions to require that qmp_output_get_qobject() can only be called after pairing a visit_end_* for every visit_start_* (rather than allowing it to return a partially built object), that it must not be called unless at least one visit_type_* or visit_start/ visit_end pair has occurred since creation/reset (the accidental return of NULL fixed by commit ab8bf1d7 would have been much easier to diagnose), and that it may only be called once per visit.

Meanwhile, nothing was using the return value of qmp_output_pop(). Also, adding a parameter will let us diagnose any programming bugs due to mismatched push(struct)/pop(list) or push(list)/pop(struct).

To keep the semantics of test_visitor_out_empty, we now have to explicitly request a top-level visit of a NULL object, by implementing the just-added visitor type_null() callback.

---
v9: rebase to added patch, squash in more sanity checks, drop Marc-Andre's R-b
v8: rename qmp_output_reset to qmp_output_visitor_reset
v7: new patch, based on discussion about spapr_drc.c

---
 include/qapi/qmp-output-visitor.h |  1 +
 include/qapi/visitor-impl.h       |  4 ++--
 qapi/qmp-output-visitor.c         | 50 +++++++++++++++++++++++----------------
 tests/test-qmp-output-visitor.c   |  2 ++
 4 files changed, 35 insertions(+), 22 deletions(-)
include/qapi/qmp-output-visitor.h +1 -0
index 2266770..5093f0d 100644
@@ -21,6 +21,7 @@ typedef struct QmpOutputVisitor QmpOutputVisitor;
 
 QmpOutputVisitor *qmp_output_visitor_new(void);
 void qmp_output_visitor_cleanup(QmpOutputVisitor *v);
+void qmp_output_visitor_reset(QmpOutputVisitor *v);
 
 QObject *qmp_output_get_qobject(QmpOutputVisitor *v);
 Visitor *qmp_output_get_visitor(QmpOutputVisitor *v);
include/qapi/visitor-impl.h +2 -2
index 95408a5..913f1b0 100644
@@ -75,8 +75,8 @@ struct Visitor
      * visitors do not currently visit arbitrary types).  */
     void (*type_any)(Visitor *v, const char *name, QObject **obj,
                      Error **errp);
-    /* Must be provided to visit explicit null values (right now, only the
-     * dealloc and qmp-input visitors support this).  */
+    /* Must be provided to visit explicit null values (the opts and string
+     * visitors do not currently visit an explicit null).  */
     void (*type_null)(Visitor *v, const char *name, Error **errp);
 
     /* May be NULL; most useful for input visitors. */
qapi/qmp-output-visitor.c +30 -20

119 lines not on this page · raw message

tests/test-qmp-output-visitor.c +2 -0
index 26dc752..74d0ac4 100644
@@ -260,6 +260,7 @@ static void test_visitor_out_struct_errors(TestOutputVisitorData *data,
         visit_type_UserDefOne(data->ov, "unused", &pu, &err);
         g_assert(err);
         error_free(err);
+        qmp_output_visitor_reset(data->qov);
     }
 }
 
@@ -459,6 +460,7 @@ static void test_visitor_out_empty(TestOutputVisitorData *data,
 {
     QObject *arg;
 
+    visit_type_null(data->ov, NULL, &error_abort);
     arg = qmp_output_get_qobject(data->qov);
     g_assert(qobject_type(arg) == QTYPE_QNULL);
     /* Check that qnull reference counting is sane */
Signature · 1 line
2.5.0