QEMU With E2K User Support
Go to file
Richard W.M. Jones d339d766d1 qemu-io: Add generic function for reinitializing optind.
On FreeBSD 11.2:

  $ nbdkit memory size=1M --run './qemu-io -f raw -c "aio_write 0 512" $nbd'
  Parsing error: non-numeric argument, or extraneous/unrecognized suffix -- aio_write

After main option parsing, we reinitialize optind so we can parse each
command.  However reinitializing optind to 0 does not work on FreeBSD.
What happens when you do this is optind remains 0 after the option
parsing loop, and the result is we try to parse argv[optind] ==
argv[0] == "aio_write" as if it was the first parameter.

The FreeBSD manual page says:

  In order to use getopt() to evaluate multiple sets of arguments, or to
  evaluate a single set of arguments multiple times, the variable optreset
  must be set to 1 before the second and each additional set of calls to
  getopt(), and the variable optind must be reinitialized.

(From the rest of the man page it is clear that optind must be
reinitialized to 1).

The glibc man page says:

  A program that scans multiple argument vectors,  or  rescans  the  same
  vector  more than once, and wants to make use of GNU extensions such as
  '+' and '-' at  the  start  of  optstring,  or  changes  the  value  of
  POSIXLY_CORRECT  between scans, must reinitialize getopt() by resetting
  optind to 0, rather than the traditional value of 1.  (Resetting  to  0
  forces  the  invocation  of  an  internal  initialization  routine that
  rechecks POSIXLY_CORRECT and checks for GNU extensions in optstring.)

This commit introduces an OS-portability function called
qemu_reset_optind which provides a way of resetting optind that works
on FreeBSD and platforms that use optreset, while keeping it the same
as now on other platforms.

Note that the qemu codebase sets optind in many other places, but in
those other places it's setting a local variable and not using getopt.
This change is only needed in places where we are using getopt and the
associated global variable optind.

Signed-off-by: Richard W.M. Jones <rjones@redhat.com>
Message-id: 20190118101114.11759-2-rjones@redhat.com
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Max Reitz <mreitz@redhat.com>
2019-01-31 00:38:19 +01:00
accel accel/tcg: Add cluster number to TCG TB hash 2019-01-29 11:46:06 +00:00
audio audio: error message tweak 2019-01-24 13:11:08 +01:00
backends hostmem: use object id for memory region name with >= 4.0 2019-01-07 16:18:42 +04:00
block block/sheepdog: Convert from DPRINTF() macro to trace events 2019-01-31 00:38:19 +01:00
bsd-user avoid TABs in files that only contain a few 2019-01-11 15:46:56 +01:00
capstone@22ead3e0bf disas: Add capstone as submodule 2017-10-26 11:56:20 +02:00
chardev configure: bump spice-server required version to 0.12.5 2019-01-10 08:55:13 +01:00
contrib contrib/gitdm: Fix a typo 2019-01-24 13:34:20 +01:00
crypto remove space-tab sequences 2019-01-11 15:46:55 +01:00
default-configs virtio: virtio 9p really requires CONFIG_VIRTFS to work 2019-01-17 21:10:57 -05:00
disas disas: nanoMIPS: Amend DSP instructions related comments 2019-01-24 17:48:33 +01:00
docs MIPS queue for January 25, 2019 2019-01-25 16:31:02 +00:00
dtc@88f18909db Update dtc/libfdt submodule to v1.4.7 2018-10-02 13:53:26 +10:00
fpu softfloat: enforce softfloat if the host's FMA is broken 2019-01-22 20:48:17 +00:00
fsdev qemu/queue.h: leave head structs anonymous unless necessary 2019-01-11 15:46:55 +01:00
gdb-xml s390x/gdb: add gs registers 2017-07-14 12:29:49 +02:00
hw qom/cpu: Add cluster_index to CPUState 2019-01-29 11:46:05 +00:00
include qemu-io: Add generic function for reinitializing optind. 2019-01-31 00:38:19 +01:00
io io: ensure UNIX client doesn't unlink server socket 2019-01-24 12:23:35 +00:00
libdecnumber build: remove CONFIG_LIBDECNUMBER 2017-10-16 18:03:52 +02:00
linux-headers linux-headers: update to 4.20-rc1 2018-10-19 13:44:11 +02:00
linux-user linux-user: Fix compilation with clang 3.4 2019-01-22 06:26:31 +01:00
migration migration: introduce pages-per-second 2019-01-23 15:51:47 +00:00
nbd nbd/client: Work around 3.0 bug for listing meta contexts 2019-01-21 15:49:52 -06:00
net slirp: add clock_get_ns() callback 2019-01-14 00:44:29 +01:00
pc-bios ui: highres logo for sdl and gtk, bugfixes for vnc and egl. 2019-01-23 17:57:47 +00:00
po po/Makefile: Modern shell scripting (use $() instead of ``) 2018-10-24 07:39:10 +01:00
qapi qapi: add x-debug-query-block-graph 2019-01-31 00:38:19 +01:00
qga qemu/queue.h: simplify reverse access to QTAILQ 2019-01-11 15:46:55 +01:00
qobject json: Fix % handling when not interpolating 2019-01-24 15:20:59 +01:00
qom qom/cpu: Add cluster_index to CPUState 2019-01-29 11:46:05 +00:00
replay replay: Exit on errors reading from replay log 2018-11-08 13:24:35 +00:00
roms ipxe: update to latest git master 2019-01-22 07:27:59 +01:00
scripts scripts: add render_block_graph function for QEMUMachine 2019-01-31 00:38:19 +01:00
scsi file-posix: Switch to .bdrv_co_ioctl 2018-12-14 11:52:41 +01:00
slirp slirp: check data length while emulating ident function 2019-01-14 23:36:38 +01:00
stubs qapi: Eliminate indirection through qmp_event_get_func_emit() 2019-01-24 10:01:05 +01:00
target target/arm: Don't clear supported PMU events when initializing PMCEID1 2019-01-29 11:46:04 +00:00
tcg cputlb: Remove static tlb sizing 2019-01-28 07:04:35 -08:00
tests tests/microbit-test: Check nRF51 UART functionality 2019-01-29 11:46:04 +00:00
trace trace: simple style changes 2018-12-12 10:04:59 +00:00
ui input-linux: customizable grab toggle keys 2019-01-24 10:42:38 +01:00
util Pull request 2019-01-24 15:04:47 +00:00
.dir-locals.el Add .dir-locals.el file to configure emacs coding style 2015-10-08 19:46:01 +03:00
.editorconfig editorconfig: set emacs mode 2018-11-01 12:13:12 +04:00
.exrc qemu: add .exrc 2012-09-07 09:02:44 +03:00
.gdbinit .gdbinit: load QEMU sub-commands when gdb starts 2017-06-07 14:38:45 +01:00
.gitignore qapi: Reduce Makefile boilerplate 2018-12-11 18:28:46 +01:00
.gitmodules gitmodules: use 'https://' instead of 'git://' 2018-11-12 11:26:02 +00:00
.gitpublish Add a git-publish configuration file 2018-03-05 09:03:17 +00:00
.mailmap maint: Grammar fix to mailmap 2018-12-11 18:35:54 +01:00
.shippable.yml .shippable.yml: disable the win cross tests 2018-12-17 13:02:12 +00:00
.travis.yml Travis CI: make specified Python versions usable on jobs 2019-01-17 17:52:40 -02:00
CODING_STYLE CODING_STYLE: Define our preferred form for multiline comments 2018-06-15 15:23:34 +01:00
COPYING COPYING: update from FSF 2008-10-12 17:54:42 +00:00
COPYING.LIB Update FSF address in GPL/LGPL boilerplate 2009-01-04 22:05:52 +00:00
Changelog Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
HACKING HACKING: document preference for g_new instead of g_malloc 2018-05-20 08:32:09 +03:00
LICENSE vfio: move hw/misc/vfio.c to hw/vfio/pci.c Move vfio.h into include/hw/vfio 2014-12-19 15:24:06 -07:00
MAINTAINERS MAINTAINERS: update microbit ARM board files 2019-01-29 11:46:04 +00:00
Makefile ui: highres logo for sdl and gtk, bugfixes for vnc and egl. 2019-01-23 17:57:47 +00:00
Makefile.objs build-sys: use a separate slirp-obj-y && slirp.mo 2019-01-14 23:36:32 +01:00
Makefile.target build-sys: use a separate slirp-obj-y && slirp.mo 2019-01-14 23:36:32 +01:00
README README: use 'https://' instead of 'git://' 2018-11-12 11:26:02 +00:00
VERSION Open 4.0 development tree 2018-12-11 17:27:58 +00:00
arch_init.c arch_init: sort architectures 2018-06-01 19:20:38 +03:00
balloon.c balloon: Allow multiple inhibit users 2018-08-17 09:27:15 -06:00
block.c qapi: add x-debug-query-block-graph 2019-01-31 00:38:19 +01:00
blockdev-nbd.c nbd/server: Hoist length check to qmp_nbd_server_add 2019-01-21 15:49:51 -06:00
blockdev.c qapi: add x-debug-query-block-graph 2019-01-31 00:38:19 +01:00
blockjob.c block: Use a single global AioWait 2018-09-25 15:50:15 +02:00
bootdevice.c fw_cfg: ignore suffixes in the bootdevice list dependent on machine class 2018-08-16 22:27:43 -03: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
configure qemu-io: Add generic function for reinitializing optind. 2019-01-31 00:38:19 +01:00
cpus-common.c qemu/queue.h: simplify reverse access to QTAILQ 2019-01-11 15:46:55 +01:00
cpus.c cpus.c: Fix race condition in cpu_stop_current() 2019-01-07 15:23:47 +00:00
device-hotplug.c blockdev: Convert drive_new() to Error 2018-10-19 14:51:34 +02:00
device_tree.c device_tree.c: Don't use load_image() 2018-12-14 13:30:52 +00:00
disas.c disas: Add RISC-V support 2018-12-26 06:40:02 +11:00
dma-helpers.c block: explicitly acquire aiocontext in bottom halves that need it 2017-02-21 11:39:39 +00:00
dump.c qemu/queue.h: simplify reverse access to QTAILQ 2019-01-11 15:46:55 +01:00
exec.c memory: add memory_region_flush_rom_device() 2019-01-29 11:46:04 +00:00
gdbstub.c gdbstub: Simplify gdb_get_cpu_pid() to use cpu->cluster_index 2019-01-29 11:46:06 +00:00
gitdm.config contrib: add a basic gitdm config 2018-12-17 08:25:10 +00:00
hmp-commands-info.hx hmp-commands-info: add sync-profile 2018-08-23 18:46:25 +02:00
hmp-commands.hx Deprecate HMP `cpu-add` 2018-12-11 15:45:22 -02:00
hmp.c migration: introduce pages-per-second 2019-01-23 15:51:47 +00:00
hmp.h hmp-commands: add sync-profile 2018-08-23 18:46:25 +02:00
ioport.c trace: switch to modular code generation for sub-directories 2017-01-31 17:11:18 +00:00
iothread.c iothread: fix crash with invalid properties 2018-10-12 09:46:14 +08:00
job-qmp.c jobs: canonize Error object 2018-08-31 16:28:33 +02:00
job.c job: Fix off-by-one assert checks for JobSTT and JobVerbTable 2018-11-12 17:49:21 +01:00
memory.c qemu/queue.h: simplify reverse access to QTAILQ 2019-01-11 15:46:55 +01:00
memory_ldst.inc.c exec: Fix MAP_RAM for cached access 2018-06-28 19:05:30 +02:00
memory_mapping.c qemu/queue.h: simplify reverse access to QTAILQ 2019-01-11 15:46:55 +01:00
module-common.c all: Clean up includes 2016-02-04 17:41:30 +00:00
monitor.c qapi: Eliminate indirection through qmp_event_get_func_emit() 2019-01-24 10:01:05 +01:00
numa.c numa: Clean up error reporting in parse_numa() 2018-10-19 14:51:34 +02:00
os-posix.c util: add qemu_write_pidfile() 2018-10-02 18:47:55 +02:00
os-win32.c util: add qemu_write_pidfile() 2018-10-02 18:47:55 +02:00
qdev-monitor.c qdev-monitor: Make device options help nicer 2018-11-05 15:18:04 +01:00
qdict-test-data.txt Introduce QDict test data file 2009-09-04 09:37:34 -05:00
qemu-bridge-helper.c all: Remove unnecessary glib.h includes 2016-06-07 18:19:24 +03:00
qemu-deprecated.texi hw/misc/ivshmem: Remove deprecated "ivshmem" legacy device 2019-01-14 19:31:04 -05:00
qemu-doc.texi qemu-doc: Add nanoMIPS ISA information 2019-01-24 17:48:33 +01:00
qemu-edid.c display/edid: add edid generator to qemu. 2018-09-27 08:07:51 +02:00
qemu-ga.texi qemu-ga: Remove stray 'q' in documentation 2016-10-28 18:17:23 +03:00
qemu-img-cmds.hx qemu-img: Add -C option for convert with copy offloading 2018-07-30 15:35:37 +02:00
qemu-img.c qemu-io: Add generic function for reinitializing optind. 2019-01-31 00:38:19 +01:00
qemu-img.texi qemu-img: Add -C option for convert with copy offloading 2018-07-30 15:35:37 +02:00
qemu-io-cmds.c qemu-io: Add generic function for reinitializing optind. 2019-01-31 00:38:19 +01:00
qemu-io.c qom: Clean up error reporting in user_creatable_add_opts_foreach() 2018-10-19 14:51:34 +02:00
qemu-keymap.c ui: use enum to string helpers 2018-08-24 08:40:10 +02:00
qemu-nbd.c qemu-nbd: Add --list option 2019-01-21 15:49:52 -06:00
qemu-nbd.texi qemu-nbd: Add --list option 2019-01-21 15:49:52 -06:00
qemu-option-trace.texi qemu-option-trace: -trace enable= is a pattern, not a file 2018-05-20 08:29:01 +03:00
qemu-options-wrapper.h qemu-img: remove references to GEN_DOCS 2018-05-20 08:35:54 +03:00
qemu-options.h Clean up ill-advised or unusual header guards 2016-07-12 16:20:46 +02:00
qemu-options.hx xen: Replace few mentions of xend by libxl 2019-01-14 13:45:40 +00:00
qemu-seccomp.c seccomp: Work-around GCC 4.x bug in gnu99 mode 2019-01-22 06:26:32 +01:00
qemu-tech.texi cli qmp: Mark --preconfig, exit-preconfig experimental 2018-07-16 15:38:19 +02:00
qemu.nsi Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
qemu.sasl Default to GSSAPI (Kerberos) instead of DIGEST-MD5 for SASL 2017-05-09 14:41:47 +01:00
qmp.c qmp hmp: Make system_wakeup check wake-up support and run state 2018-12-18 07:55:47 +01:00
qtest.c avoid TABs in files that only contain a few 2019-01-11 15:46:56 +01:00
replication.c replication: Introduce new APIs to do replication operation 2016-09-13 11:00:56 +01:00
replication.h block/replication: Remove protocol_name field 2018-03-26 12:16:00 +02:00
rules.mak test: replace gtester with a TAP driver 2019-01-11 15:46:52 +01:00
thunk.c thunk: assert nb_fields is valid 2017-07-31 13:06:39 +03:00
tpm.c tpm: Clean up error reporting in tpm_init_tpmdev() 2018-10-19 14:51:34 +02:00
trace-events jobs: remove ret argument to job_completed; privatize it 2018-08-31 16:28:33 +02:00
version.rc Use HTTPS for qemu.org and other domains 2017-11-21 13:34:13 +00:00
vl.c Remove broken Xen PV domain builder 2019-01-14 13:45:40 +00:00
win_dump.c dump: fix Windows dump memory run mapping 2018-10-02 18:47:55 +02:00
win_dump.h dump: move Windows dump structures definitions 2018-10-02 19:09:12 +02:00

README

         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

Additional information can also be found online via the QEMU website:

  https://qemu.org/Hosts/Linux
  https://qemu.org/Hosts/Mac
  https://qemu.org/Hosts/W32


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

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

   git clone https://git.qemu.org/git/qemu.git

When submitting patches, one common 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

  https://qemu.org/Contribute/SubmitAPatch
  https://qemu.org/Contribute/TrivialPatches

The QEMU website is also maintained under source control.

  git clone https://git.qemu.org/git/qemu-web.git
  https://www.qemu.org/2017/02/04/the-new-qemu-website-is-up/

A 'git-publish' utility was created to make above process less
cumbersome, and is highly recommended for making regular contributions,
or even just for sending consecutive patch series revisions. It also
requires a working 'git send-email' setup, and by default doesn't
automate everything, so you may want to go through the above steps
manually for once.

For installation instructions, please go to

  https://github.com/stefanha/git-publish

The workflow with 'git-publish' is:

  $ git checkout master -b my-feature
  $ # work on new commits, add your 'Signed-off-by' lines to each
  $ git publish

Your patch series will be sent and tagged as my-feature-v1 if you need to refer
back to it in the future.

Sending v2:

  $ git checkout my-feature # same topic branch
  $ # making changes to the commits (using 'git rebase', for example)
  $ git publish

Your patch series will be sent with 'v2' tag in the subject and the git tip
will be tagged as my-feature-v2.

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:

  https://qemu.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
   https://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:

  https://qemu.org/Contribute/StartHere

-- End