[PATCH v2 00/28] qapi: Elide redundant has_FOO in generated C

Markus Armbruster posted 28 patches 1 year, 6 months ago
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20221018062849.3420573-1-armbru@redhat.com
Maintainers: Gerd Hoffmann <kraxel@redhat.com>, Christian Schoenebeck <qemu_oss@crudebyte.com>, Stefan Berger <stefanb@linux.vnet.ibm.com>, Kevin Wolf <kwolf@redhat.com>, Hanna Reitz <hreitz@redhat.com>, John Snow <jsnow@redhat.com>, Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>, Eric Blake <eblake@redhat.com>, Xie Yongji <xieyongji@bytedance.com>, Markus Armbruster <armbru@redhat.com>, Stefan Hajnoczi <stefanha@redhat.com>, Alberto Garcia <berto@igalia.com>, Ilya Dryomov <idryomov@gmail.com>, Peter Lieven <pl@kamp.de>, "Richard W.M. Jones" <rjones@redhat.com>, "Marc-André Lureau" <marcandre.lureau@redhat.com>, Paolo Bonzini <pbonzini@redhat.com>, "Daniel P. Berrangé" <berrange@redhat.com>, Michael Roth <michael.roth@amd.com>, "Michael S. Tsirkin" <mst@redhat.com>, Igor Mammedov <imammedo@redhat.com>, Ani Sinha <ani@anisinha.ca>, Eduardo Habkost <eduardo@habkost.net>, Marcel Apfelbaum <marcel.apfelbaum@gmail.com>, "Philippe Mathieu-Daudé" <philmd@linaro.org>, Yanan Wang <wangyanan55@huawei.com>, David Hildenbrand <david@redhat.com>, Xiao Guangrong <xiaoguangrong.eric@gmail.com>, Jiri Pirko <jiri@resnulli.us>, Jason Wang <jasowang@redhat.com>, "Cédric Le Goater" <clg@kaod.org>, Daniel Henrique Barboza <danielhb413@gmail.com>, David Gibson <david@gibson.dropbear.id.au>, Greg Kurz <groug@kaod.org>, Fam Zheng <fam@euphon.net>, Juan Quintela <quintela@redhat.com>, "Dr. David Alan Gilbert" <dgilbert@redhat.com>, Hailiang Zhang <zhanghailiang@xfusion.com>, Samuel Thibault <samuel.thibault@ens-lyon.org>, Stefan Weil <sw@weilnetz.de>, Konstantin Kostiuk <kkostiuk@redhat.com>, Pavel Dovgalyuk <pavel.dovgaluk@ispras.ru>, Peter Maydell <peter.maydell@linaro.org>, Cornelia Huck <cohuck@redhat.com>, Thomas Huth <thuth@redhat.com>, Richard Henderson <richard.henderson@linaro.org>, Alexander Bulekov <alxndr@bu.edu>, Bandan Das <bsd@redhat.com>, Darren Kenny <darren.kenny@oracle.com>, Qiuhao Li <Qiuhao.Li@outlook.com>, Laurent Vivier <lvivier@redhat.com>
There is a newer version of this series
docs/devel/qapi-code-gen.rst             |  29 +++-
docs/devel/writing-monitor-commands.rst  |  14 +-
include/monitor/monitor.h                |   3 +-
audio/alsaaudio.c                        |   2 +-
audio/audio.c                            |   6 +-
audio/audio_legacy.c                     |  17 +--
audio/ossaudio.c                         |   8 +-
audio/paaudio.c                          |  12 +-
audio/wavaudio.c                         |   2 +-
backends/tpm/tpm_passthrough.c           |   2 -
block/block-backend.c                    |   2 +-
block/copy-before-write.c                |   2 +-
block/dirty-bitmap.c                     |   1 -
block/export/export.c                    |   2 +-
block/export/vduse-blk.c                 |   3 +-
block/gluster.c                          |   3 -
block/monitor/block-hmp-cmds.c           |  48 +++----
block/qapi-sysemu.c                      |  73 ++++------
block/qapi.c                             |  62 +++-----
block/qcow.c                             |  10 +-
block/qcow2.c                            |  18 ++-
block/qed.c                              |   2 +-
block/quorum.c                           |   2 +-
block/rbd.c                              |  15 +-
block/ssh.c                              |   2 +-
blockdev-nbd.c                           |   9 +-
blockdev.c                               | 173 +++++++++--------------
blockjob.c                               |   2 -
chardev/char-file.c                      |   4 +-
chardev/char-socket.c                    |  10 +-
chardev/char-udp.c                       |   1 -
chardev/char.c                           |   6 +-
crypto/block-luks.c                      |  16 +--
dump/dump.c                              |   4 +-
hw/acpi/core.c                           |  14 +-
hw/acpi/cpu.c                            |   1 -
hw/acpi/memory_hotplug.c                 |   3 +-
hw/core/machine-hmp-cmds.c               |   2 +-
hw/core/machine-qmp-cmds.c               |   9 +-
hw/core/machine.c                        |  10 +-
hw/core/numa.c                           |   8 +-
hw/core/qdev.c                           |   2 +-
hw/mem/pc-dimm.c                         |   1 -
hw/net/rocker/rocker_of_dpa.c            |  13 +-
hw/net/virtio-net.c                      |   3 +-
hw/nvram/fw_cfg.c                        |   2 +-
hw/pci/pci.c                             |   2 -
hw/ppc/spapr.c                           |   2 +-
hw/ppc/spapr_drc.c                       |   3 +-
hw/virtio/virtio-mem-pci.c               |   4 +-
hw/virtio/virtio-pmem-pci.c              |   1 -
hw/virtio/virtio.c                       |   1 -
job-qmp.c                                |   3 +-
migration/block-dirty-bitmap.c           |   4 +-
migration/colo.c                         |   1 -
migration/migration.c                    |  27 ++--
monitor/hmp-cmds.c                       |  84 +++++------
monitor/misc.c                           |  21 +--
monitor/qmp-cmds.c                       |   6 +-
nbd/server.c                             |   2 +-
net/announce.c                           |   8 +-
net/hub.c                                |   2 +-
net/l2tpv3.c                             |   2 +-
net/net.c                                |  25 ++--
net/slirp.c                              |   4 +-
net/socket.c                             |  18 +--
net/tap-win32.c                          |   2 +-
net/tap.c                                |  51 ++++---
qemu-img.c                               |  13 +-
qemu-nbd.c                               |   2 -
qga/commands-posix.c                     |  33 ++---
qga/commands-win32.c                     |  40 +-----
qga/commands.c                           |  11 +-
qom/qom-qmp-cmds.c                       |   7 +-
replay/replay-debugging.c                |   1 -
softmmu/runstate.c                       |  18 +--
softmmu/vl.c                             |   2 +-
target/arm/monitor.c                     |   1 -
target/i386/cpu-sysemu.c                 |   7 +-
target/i386/cpu.c                        |   1 -
target/s390x/cpu_models_sysemu.c         |   1 -
tests/qtest/fuzz/qos_fuzz.c              |   3 +-
tests/qtest/qmp-cmd-test.c               |   2 +-
tests/unit/test-char.c                   |   1 -
tests/unit/test-crypto-block.c           |   6 -
tests/unit/test-qmp-cmds.c               |  26 ++--
tests/unit/test-qmp-event.c              |   4 +-
tests/unit/test-qobject-input-visitor.c  |   2 +-
tests/unit/test-qobject-output-visitor.c |   2 -
tests/unit/test-visitor-serialization.c  |   3 +-
ui/console.c                             |   4 +-
ui/input.c                               |   4 +-
ui/spice-core.c                          |   5 -
ui/vnc.c                                 |  10 --
util/qemu-config.c                       |  17 +--
scripts/qapi/commands.py                 |   9 +-
scripts/qapi/events.py                   |   3 +-
scripts/qapi/gen.py                      |   2 +-
scripts/qapi/schema.py                   |  14 ++
scripts/qapi/types.py                    |   2 +-
scripts/qapi/visit.py                    |  17 ++-
101 files changed, 467 insertions(+), 712 deletions(-)
[PATCH v2 00/28] qapi: Elide redundant has_FOO in generated C
Posted by Markus Armbruster 1 year, 6 months ago
In QAPI, absent optional members are distinct from any present value.
We thus represent an optional schema member FOO as two C members: a
FOO with the member's type, and a bool has_FOO.  Likewise for function
arguments.

However, the has_FOO is actually redundant for a pointer-valued FOO,
which can be null only when has_FOO is false, i.e. has_FOO == !!FOO.
Except for arrays, where we a null FOO can also be a present empty
array.

The redundant has_FOO are a nuisance to work with.  Improve the
generator to elide them.

PATCH 01+02 are trivial documentation cleanups.

PATCH 03 tweaks an example in documentation so it'll show the change.

PATCH 04 improves the code generator, but nerfs the change for the
schema modules where handwritten code needs to be updated.

PATCH 05-27 un-nerf in reviewable chunks.  Their commit messages
refer back to PATCH 04 for an explanation of the transformation.
Please read that first.  Note that these patches combine the
mechanical transformation with obvious, local follow-up
simplifications.  If you want them separate for easier review, let me
know.

PATCH 28 drops the nerfing code.

v2:
* Rebased
  - Straighforward conflicts with commit bf0c50d4aa "monitor: expose
    monitor_puts to rest of code" resolved in PATCH 08+17
  - Commit 90c066cd68 "qmp: add QMP command x-query-virtio-status"
    necessitates nerfing qapi/virtio.json in PATCH 04, un-nerfing in
    new PATCH 26
* PATCH 14: Redundant check of params-tls_creds dropped [Philippe]
* PATCH 09+16+27: Fix for Windows

Markus Armbruster (28):
  docs/devel/qapi-code-gen: Update example to match current code
  qapi: Tidy up whitespace in generated code
  docs/devel/qapi-code-gen: Extend example for next commit's change
  qapi: Start to elide redundant has_FOO in generated C
  qapi tests: Elide redundant has_FOO in generated C
  qapi acpi: Elide redundant has_FOO in generated C
  qapi audio: Elide redundant has_FOO in generated C
  qapi block: Elide redundant has_FOO in generated C
  qapi char: Elide redundant has_FOO in generated C
  qapi crypto: Elide redundant has_FOO in generated C
  qapi dump: Elide redundant has_FOO in generated C
  qapi job: Elide redundant has_FOO in generated C
  qapi machine: Elide redundant has_FOO in generated C
  qapi migration: Elide redundant has_FOO in generated C
  qapi misc: Elide redundant has_FOO in generated C
  qapi net: Elide redundant has_FOO in generated C
  qapi pci: Elide redundant has_FOO in generated C
  qapi qdev qom: Elide redundant has_FOO in generated C
  qapi replay: Elide redundant has_FOO in generated C
  qapi rocker: Elide redundant has_FOO in generated C
  qapi run-state: Elide redundant has_FOO in generated C
  qapi stats: Elide redundant has_FOO in generated C
  qapi tpm: Elide redundant has_FOO in generated C
  qapi transaction: Elide redundant has_FOO in generated C
  qapi ui: Elide redundant has_FOO in generated C
  qapi virtio: Elide redundant has_FOO in generated C
  qapi qga: Elide redundant has_FOO in generated C
  qapi: Drop temporary logic to support conversion step by step

 docs/devel/qapi-code-gen.rst             |  29 +++-
 docs/devel/writing-monitor-commands.rst  |  14 +-
 include/monitor/monitor.h                |   3 +-
 audio/alsaaudio.c                        |   2 +-
 audio/audio.c                            |   6 +-
 audio/audio_legacy.c                     |  17 +--
 audio/ossaudio.c                         |   8 +-
 audio/paaudio.c                          |  12 +-
 audio/wavaudio.c                         |   2 +-
 backends/tpm/tpm_passthrough.c           |   2 -
 block/block-backend.c                    |   2 +-
 block/copy-before-write.c                |   2 +-
 block/dirty-bitmap.c                     |   1 -
 block/export/export.c                    |   2 +-
 block/export/vduse-blk.c                 |   3 +-
 block/gluster.c                          |   3 -
 block/monitor/block-hmp-cmds.c           |  48 +++----
 block/qapi-sysemu.c                      |  73 ++++------
 block/qapi.c                             |  62 +++-----
 block/qcow.c                             |  10 +-
 block/qcow2.c                            |  18 ++-
 block/qed.c                              |   2 +-
 block/quorum.c                           |   2 +-
 block/rbd.c                              |  15 +-
 block/ssh.c                              |   2 +-
 blockdev-nbd.c                           |   9 +-
 blockdev.c                               | 173 +++++++++--------------
 blockjob.c                               |   2 -
 chardev/char-file.c                      |   4 +-
 chardev/char-socket.c                    |  10 +-
 chardev/char-udp.c                       |   1 -
 chardev/char.c                           |   6 +-
 crypto/block-luks.c                      |  16 +--
 dump/dump.c                              |   4 +-
 hw/acpi/core.c                           |  14 +-
 hw/acpi/cpu.c                            |   1 -
 hw/acpi/memory_hotplug.c                 |   3 +-
 hw/core/machine-hmp-cmds.c               |   2 +-
 hw/core/machine-qmp-cmds.c               |   9 +-
 hw/core/machine.c                        |  10 +-
 hw/core/numa.c                           |   8 +-
 hw/core/qdev.c                           |   2 +-
 hw/mem/pc-dimm.c                         |   1 -
 hw/net/rocker/rocker_of_dpa.c            |  13 +-
 hw/net/virtio-net.c                      |   3 +-
 hw/nvram/fw_cfg.c                        |   2 +-
 hw/pci/pci.c                             |   2 -
 hw/ppc/spapr.c                           |   2 +-
 hw/ppc/spapr_drc.c                       |   3 +-
 hw/virtio/virtio-mem-pci.c               |   4 +-
 hw/virtio/virtio-pmem-pci.c              |   1 -
 hw/virtio/virtio.c                       |   1 -
 job-qmp.c                                |   3 +-
 migration/block-dirty-bitmap.c           |   4 +-
 migration/colo.c                         |   1 -
 migration/migration.c                    |  27 ++--
 monitor/hmp-cmds.c                       |  84 +++++------
 monitor/misc.c                           |  21 +--
 monitor/qmp-cmds.c                       |   6 +-
 nbd/server.c                             |   2 +-
 net/announce.c                           |   8 +-
 net/hub.c                                |   2 +-
 net/l2tpv3.c                             |   2 +-
 net/net.c                                |  25 ++--
 net/slirp.c                              |   4 +-
 net/socket.c                             |  18 +--
 net/tap-win32.c                          |   2 +-
 net/tap.c                                |  51 ++++---
 qemu-img.c                               |  13 +-
 qemu-nbd.c                               |   2 -
 qga/commands-posix.c                     |  33 ++---
 qga/commands-win32.c                     |  40 +-----
 qga/commands.c                           |  11 +-
 qom/qom-qmp-cmds.c                       |   7 +-
 replay/replay-debugging.c                |   1 -
 softmmu/runstate.c                       |  18 +--
 softmmu/vl.c                             |   2 +-
 target/arm/monitor.c                     |   1 -
 target/i386/cpu-sysemu.c                 |   7 +-
 target/i386/cpu.c                        |   1 -
 target/s390x/cpu_models_sysemu.c         |   1 -
 tests/qtest/fuzz/qos_fuzz.c              |   3 +-
 tests/qtest/qmp-cmd-test.c               |   2 +-
 tests/unit/test-char.c                   |   1 -
 tests/unit/test-crypto-block.c           |   6 -
 tests/unit/test-qmp-cmds.c               |  26 ++--
 tests/unit/test-qmp-event.c              |   4 +-
 tests/unit/test-qobject-input-visitor.c  |   2 +-
 tests/unit/test-qobject-output-visitor.c |   2 -
 tests/unit/test-visitor-serialization.c  |   3 +-
 ui/console.c                             |   4 +-
 ui/input.c                               |   4 +-
 ui/spice-core.c                          |   5 -
 ui/vnc.c                                 |  10 --
 util/qemu-config.c                       |  17 +--
 scripts/qapi/commands.py                 |   9 +-
 scripts/qapi/events.py                   |   3 +-
 scripts/qapi/gen.py                      |   2 +-
 scripts/qapi/schema.py                   |  14 ++
 scripts/qapi/types.py                    |   2 +-
 scripts/qapi/visit.py                    |  17 ++-
 101 files changed, 467 insertions(+), 712 deletions(-)

-- 
2.37.2