Original Xbox Emulator for Windows, macOS, and Linux (Active Development)
Find a file
Eric Blake 51e72bc1dd qapi: Swap visit_* arguments for consistent 'name' placement
JSON uses "name":value, but many of our visitor interfaces were
called with visit_type_FOO(v, &value, name, errp).  This can be
a bit confusing to have to mentally swap the parameter order to
match JSON order.  It's particularly bad for visit_start_struct(),
where the 'name' parameter is smack in the middle of the
otherwise-related group of 'obj, kind, size' parameters! It's
time to do a global swap of the parameter ordering, so that the
'name' parameter is always immediately after the Visitor argument.

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

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

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

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

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

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

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

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

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

Signed-off-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <1454075341-13658-19-git-send-email-eblake@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
2016-02-08 17:29:56 +01:00
audio audio: Clean up includes 2016-02-02 13:57:31 +01:00
backends qapi: Swap visit_* arguments for consistent 'name' placement 2016-02-08 17:29:56 +01:00
block qapi: Swap visit_* arguments for consistent 'name' placement 2016-02-08 17:29:56 +01:00
bsd-user bsd-user: Clean up includes 2016-02-04 17:01:04 +00:00
contrib contrib: Clean up includes 2016-02-04 17:41:30 +00:00
crypto crypto: ensure qcrypto_hash_digest_len is always defined 2016-02-02 13:02:56 +00:00
default-configs bcm2835_mbox: add BCM2835 mailboxes 2016-02-03 14:56:32 +00:00
disas disas: Clean up includes 2016-02-04 17:41:30 +00:00
docs
dtc@65cc4d2748
fpu all: Clean up includes 2016-02-04 17:41:30 +00:00
fsdev 9pfs: Clean up includes 2016-01-29 15:07:23 +00:00
gdb-xml target-ppc: gdbstub: Add VSX support 2016-01-30 23:37:38 +11:00
hw qapi: Swap visit_* arguments for consistent 'name' placement 2016-02-08 17:29:56 +01:00
include qapi: Swap visit_* arguments for consistent 'name' placement 2016-02-08 17:29:56 +01:00
io io: Clean up includes 2016-02-04 17:41:30 +00:00
libdecnumber
linux-headers
linux-user log: do not unnecessarily include qom/cpu.h 2016-02-03 09:19:10 +00:00
migration migration: fix bad string passed to error_report() 2016-02-05 19:09:51 +05:30
nbd all: Clean up includes 2016-02-04 17:41:30 +00:00
net qapi: Swap visit_* arguments for consistent 'name' placement 2016-02-08 17:29:56 +01:00
pc-bios Update OpenBIOS images 2016-02-04 11:17:44 +00:00
pixman@87eea99e44
po
qapi qapi: Swap visit_* arguments for consistent 'name' placement 2016-02-08 17:29:56 +01:00
qga qga: Clean up includes 2016-02-04 17:41:30 +00:00
qobject qobject: Document more shortcomings in our number handling 2016-02-08 17:29:54 +01:00
qom qapi: Swap visit_* arguments for consistent 'name' placement 2016-02-08 17:29:56 +01:00
replay qapi: Swap visit_* arguments for consistent 'name' placement 2016-02-08 17:29:56 +01:00
roms Update OpenBIOS images 2016-02-04 11:17:44 +00:00
scripts qapi: Swap visit_* arguments for consistent 'name' placement 2016-02-08 17:29:56 +01:00
slirp slirp: Clean up includes 2016-02-04 17:41:30 +00:00
stubs stubs: Clean up includes 2016-02-04 17:01:04 +00:00
target-alpha log: do not unnecessarily include qom/cpu.h 2016-02-03 09:19:10 +00:00
target-arm target-arm queue: 2016-02-04 11:06:35 +00:00
target-cris log: do not unnecessarily include qom/cpu.h 2016-02-03 09:19:10 +00:00
target-i386 qapi: Swap visit_* arguments for consistent 'name' placement 2016-02-08 17:29:56 +01:00
target-lm32 log: do not unnecessarily include qom/cpu.h 2016-02-03 09:19:10 +00:00
target-m68k log: do not unnecessarily include qom/cpu.h 2016-02-03 09:19:10 +00:00
target-microblaze log: do not unnecessarily include qom/cpu.h 2016-02-03 09:19:10 +00:00
target-mips log: do not unnecessarily include qom/cpu.h 2016-02-03 09:19:10 +00:00
target-moxie log: do not unnecessarily include qom/cpu.h 2016-02-03 09:19:10 +00:00
target-openrisc log: do not unnecessarily include qom/cpu.h 2016-02-03 09:19:10 +00:00
target-ppc qapi: Swap visit_* arguments for consistent 'name' placement 2016-02-08 17:29:56 +01:00
target-s390x log: do not unnecessarily include qom/cpu.h 2016-02-03 09:19:10 +00:00
target-sh4 log: do not unnecessarily include qom/cpu.h 2016-02-03 09:19:10 +00:00
target-sparc log: do not unnecessarily include qom/cpu.h 2016-02-03 09:19:10 +00:00
target-tilegx log: do not unnecessarily include qom/cpu.h 2016-02-03 09:19:10 +00:00
target-tricore log: do not unnecessarily include qom/cpu.h 2016-02-03 09:19:10 +00:00
target-unicore32 log: do not unnecessarily include qom/cpu.h 2016-02-03 09:19:10 +00:00
target-xtensa log: do not unnecessarily include qom/cpu.h 2016-02-03 09:19:10 +00:00
tcg log: do not unnecessarily include qom/cpu.h 2016-02-03 09:19:10 +00:00
tests qapi: Swap visit_* arguments for consistent 'name' placement 2016-02-08 17:29:56 +01:00
trace all: Clean up includes 2016-02-04 17:41:30 +00:00
ui ui/cocoa.m: Include qemu/osdep.h 2016-02-08 13:14:40 +00:00
util qapi: Swap visit_* arguments for consistent 'name' placement 2016-02-08 17:29:56 +01:00
.dir-locals.el
.exrc
.gitignore
.gitmodules
.mailmap
.travis.yml trace: convert stderr backend to log 2016-02-03 10:37:10 +00:00
accel.c all: Clean up includes 2016-02-04 17:41:30 +00:00
aio-posix.c all: Clean up includes 2016-02-04 17:41:30 +00:00
aio-win32.c all: Clean up includes 2016-02-04 17:41:30 +00:00
arch_init.c all: Clean up includes 2016-02-04 17:41:30 +00:00
async.c all: Clean up includes 2016-02-04 17:41:30 +00:00
balloon.c all: Clean up includes 2016-02-04 17:41:30 +00:00
block.c all: Clean up includes 2016-02-04 17:41:30 +00:00
blockdev-nbd.c all: Clean up includes 2016-02-04 17:41:30 +00:00
blockdev.c qapi: Swap visit_* arguments for consistent 'name' placement 2016-02-08 17:29:56 +01:00
blockjob.c all: Clean up includes 2016-02-04 17:41:30 +00:00
bootdevice.c qapi: Swap visit_* arguments for consistent 'name' placement 2016-02-08 17:29:56 +01:00
bt-host.c all: Clean up includes 2016-02-04 17:41:30 +00:00
bt-vhci.c all: Clean up includes 2016-02-04 17:41:30 +00:00
Changelog
CODING_STYLE
configure trace: switch default backend to "log" 2016-02-03 10:37:50 +00:00
COPYING
COPYING.LIB
cpu-exec-common.c exec: Clean up includes 2016-01-29 15:07:22 +00:00
cpu-exec.c log: do not unnecessarily include qom/cpu.h 2016-02-03 09:19:10 +00:00
cpus.c exec: Clean up includes 2016-01-29 15:07:22 +00:00
cputlb.c exec: Clean up includes 2016-01-29 15:07:22 +00:00
device-hotplug.c all: Clean up includes 2016-02-04 17:41:30 +00:00
device_tree.c all: Clean up includes 2016-02-04 17:41:30 +00:00
disas.c all: Clean up includes 2016-02-04 17:41:30 +00:00
dma-helpers.c all: Clean up includes 2016-02-04 17:41:30 +00:00
dump.c all: Clean up includes 2016-02-04 17:41:30 +00:00
exec.c log: do not unnecessarily include qom/cpu.h 2016-02-03 09:19:10 +00:00
gdbstub.c all: Clean up includes 2016-02-04 17:41:30 +00:00
HACKING
hmp-commands-info.hx
hmp-commands.hx
hmp.c qapi: Swap visit_* arguments for consistent 'name' placement 2016-02-08 17:29:56 +01:00
hmp.h
iohandler.c all: Clean up includes 2016-02-04 17:41:30 +00:00
ioport.c all: Clean up includes 2016-02-04 17:41:30 +00:00
iothread.c all: Clean up includes 2016-02-04 17:41:30 +00:00
kvm-all.c all: Clean up includes 2016-02-04 17:41:30 +00:00
kvm-stub.c all: Clean up includes 2016-02-04 17:41:30 +00:00
LICENSE
main-loop.c all: Clean up includes 2016-02-04 17:41:30 +00:00
MAINTAINERS Xen 2016/01/21 2016-01-21 17:21:08 +00:00
Makefile
Makefile.objs log: move qemu-log.c into util/ directory 2016-02-03 09:19:10 +00:00
Makefile.target
memory.c qapi: Swap visit_* arguments for consistent 'name' placement 2016-02-08 17:29:56 +01:00
memory_mapping.c all: Clean up includes 2016-02-04 17:41:30 +00:00
module-common.c all: Clean up includes 2016-02-04 17:41:30 +00:00
monitor.c all: Clean up includes 2016-02-04 17:41:30 +00:00
numa.c qapi: Swap visit_* arguments for consistent 'name' placement 2016-02-08 17:29:56 +01:00
os-posix.c all: Clean up includes 2016-02-04 17:41:30 +00:00
os-win32.c all: Clean up includes 2016-02-04 17:41:30 +00:00
page_cache.c all: Clean up includes 2016-02-04 17:41:30 +00:00
qapi-schema.json char: introduce support for TLS encrypted TCP chardev backend 2016-01-26 15:58:11 +01:00
qdev-monitor.c all: Clean up includes 2016-02-04 17:41:30 +00:00
qdict-test-data.txt
qemu-bridge-helper.c all: Clean up includes 2016-02-04 17:41:30 +00:00
qemu-char.c all: Clean up includes 2016-02-04 17:41:30 +00:00
qemu-doc.texi qemu-doc: Do not promote deprecated -smb and -redir options 2016-02-04 13:22:06 +08:00
qemu-ga.texi docs: Style the command and its options in the synopsis 2016-01-26 15:58:11 +01:00
qemu-img-cmds.hx
qemu-img.c qapi: Swap visit_* arguments for consistent 'name' placement 2016-02-08 17:29:56 +01:00
qemu-img.texi docs: Style the command and its options in the synopsis 2016-01-26 15:58:11 +01:00
qemu-io-cmds.c block: Clean up includes 2016-01-20 13:36:23 +01:00
qemu-io.c trace: split trace_init_file out of trace_init_backends 2016-02-03 09:19:09 +00:00
qemu-nbd.c all: Clean up includes 2016-02-04 17:41:30 +00:00
qemu-nbd.texi
qemu-options-wrapper.h
qemu-options.h
qemu-options.hx pc: set the OEM fields in the RSDT and the FADT from the SLIC 2016-02-06 20:44:10 +02:00
qemu-seccomp.c all: Clean up includes 2016-02-04 17:41:30 +00:00
qemu-tech.texi
qemu-timer.c all: Clean up includes 2016-02-04 17:41:30 +00:00
qemu.nsi
qemu.sasl
qjson.c all: Clean up includes 2016-02-04 17:41:30 +00:00
qmp-commands.hx qmp-commands.hx: Document the missing options for migration capability commands 2016-02-05 19:09:50 +05:30
qmp.c all: Clean up includes 2016-02-04 17:41:30 +00:00
qtest.c all: Clean up includes 2016-02-04 17:41:30 +00:00
README
rules.mak
softmmu_template.h exec.c: Pass MemTxAttrs to iotlb_to_region so it uses the right AS 2016-01-21 14:15:05 +00:00
spice-qemu-char.c all: Clean up includes 2016-02-04 17:41:30 +00:00
tcg-runtime.c all: Clean up includes 2016-02-04 17:41:30 +00:00
tci.c all: Clean up includes 2016-02-04 17:41:30 +00:00
thread-pool.c all: Clean up includes 2016-02-04 17:41:30 +00:00
thunk.c all: Clean up includes 2016-02-04 17:41:30 +00:00
tpm.c all: Clean up includes 2016-02-04 17:41:30 +00:00
trace-events vfio/pci: Lazy PBA emulation 2016-01-19 11:33:42 -07:00
translate-all.c log: do not unnecessarily include qom/cpu.h 2016-02-03 09:19:10 +00:00
translate-all.h
translate-common.c exec: Clean up includes 2016-01-29 15:07:22 +00:00
user-exec.c all: Clean up includes 2016-02-04 17:41:30 +00:00
VERSION
version.rc
vl.c qapi: Swap visit_* arguments for consistent 'name' placement 2016-02-08 17:29:56 +01:00
xen-common-stub.c xen: Clean up includes 2016-01-29 15:07:23 +00:00
xen-common.c xen: Clean up includes 2016-01-29 15:07:23 +00:00
xen-hvm-stub.c fix MSI injection on Xen 2016-02-06 20:44:10 +02:00
xen-hvm.c fix MSI injection on Xen 2016-02-06 20:44:10 +02:00
xen-mapcache.c xen: Clean up includes 2016-01-29 15:07:23 +00:00

         QEMU README
         ===========

QEMU is a generic and open source machine & userspace emulator and
virtualizer.

QEMU is capable of emulating a complete machine in software without any
need for hardware virtualization support. By using dynamic translation,
it achieves very good performance. QEMU can also integrate with the Xen
and KVM hypervisors to provide emulated hardware while allowing the
hypervisor to manage the CPU. With hypervisor support, QEMU can achieve
near native performance for CPUs. When QEMU emulates CPUs directly it is
capable of running operating systems made for one machine (e.g. an ARMv7
board) on a different machine (e.g. an x86_64 PC board).

QEMU is also capable of providing userspace API virtualization for Linux
and BSD kernel interfaces. This allows binaries compiled against one
architecture ABI (e.g. the Linux PPC64 ABI) to be run on a host using a
different architecture ABI (e.g. the Linux x86_64 ABI). This does not
involve any hardware emulation, simply CPU and syscall emulation.

QEMU aims to fit into a variety of use cases. It can be invoked directly
by users wishing to have full control over its behaviour and settings.
It also aims to facilitate integration into higher level management
layers, by providing a stable command line interface and monitor API.
It is commonly invoked indirectly via the libvirt library when using
open source applications such as oVirt, OpenStack and virt-manager.

QEMU as a whole is released under the GNU General Public License,
version 2. For full licensing details, consult the LICENSE file.


Building
========

QEMU is multi-platform software intended to be buildable on all modern
Linux platforms, OS-X, Win32 (via the Mingw64 toolchain) and a variety
of other UNIX targets. The simple steps to build QEMU are:

  mkdir build
  cd build
  ../configure
  make

Complete details of the process for building and configuring QEMU for
all supported host platforms can be found in the qemu-tech.html file.
Additional information can also be found online via the QEMU website:

  http://qemu-project.org/Hosts/Linux
  http://qemu-project.org/Hosts/W32


Submitting patches
==================

The QEMU source code is maintained under the GIT version control system.

   git clone git://git.qemu-project.org/qemu.git

When submitting patches, the preferred approach is to use 'git
format-patch' and/or 'git send-email' to format & send the mail to the
qemu-devel@nongnu.org mailing list. All patches submitted must contain
a 'Signed-off-by' line from the author. Patches should follow the
guidelines set out in the HACKING and CODING_STYLE files.

Additional information on submitting patches can be found online via
the QEMU website

  http://qemu-project.org/Contribute/SubmitAPatch
  http://qemu-project.org/Contribute/TrivialPatches


Bug reporting
=============

The QEMU project uses Launchpad as its primary upstream bug tracker. Bugs
found when running code built from QEMU git or upstream released sources
should be reported via:

  https://bugs.launchpad.net/qemu/

If using QEMU via an operating system vendor pre-built binary package, it
is preferable to report bugs to the vendor's own bug tracker first. If
the bug is also known to affect latest upstream code, it can also be
reported via launchpad.

For additional information on bug reporting consult:

  http://qemu-project.org/Contribute/ReportABug


Contact
=======

The QEMU community can be contacted in a number of ways, with the two
main methods being email and IRC

 - qemu-devel@nongnu.org
   http://lists.nongnu.org/mailman/listinfo/qemu-devel
 - #qemu on irc.oftc.net

Information on additional methods of contacting the community can be
found online via the QEMU website:

  http://qemu-project.org/Contribute/StartHere

-- End