Go to file
Claudio Fontana c551fb0b53 module: add Error arguments to module_load and module_load_qom
improve error handling during module load, by changing:

bool module_load(const char *prefix, const char *lib_name);
void module_load_qom(const char *type);

to:

int module_load(const char *prefix, const char *name, Error **errp);
int module_load_qom(const char *type, Error **errp);

where the return value is:

 -1 on module load error, and errp is set with the error
  0 on module or one of its dependencies are not installed
  1 on module load success
  2 on module load success (module already loaded or built-in)

module_load_qom_one has been introduced in:

commit 28457744c3 ("module: qom module support"), which built on top of
module_load_one, but discarded the bool return value. Restore it.

Adapt all callers to emit errors, or ignore them, or fail hard,
as appropriate in each context.

Replace the previous emission of errors via fprintf in _some_ error
conditions with Error and error_report, so as to emit to the appropriate
target.

A memory leak is also fixed as part of the module_load changes.

audio: when attempting to load an audio module, report module load errors.
Note that still for some callers, a single issue may generate multiple
error reports, and this could be improved further.
Regarding the audio code itself, audio_add() seems to ignore errors,
and this should probably be improved.

block: when attempting to load a block module, report module load errors.
For the code paths that already use the Error API, take advantage of those
to report module load errors into the Error parameter.
For the other code paths, we currently emit the error, but this could be
improved further by adding Error parameters to all possible code paths.

console: when attempting to load a display module, report module load errors.

qdev: when creating a new qdev Device object (DeviceState), report load errors.
      If a module cannot be loaded to create that device, now abort execution
      (if no CONFIG_MODULE) or exit (if CONFIG_MODULE).

qom/object.c: when initializing a QOM object, or looking up class_by_name,
              report module load errors.

qtest: when processing the "module_load" qtest command, report errors
       in the load of the module.

Signed-off-by: Claudio Fontana <cfontana@suse.de>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Message-Id: <20220929093035.4231-4-cfontana@suse.de>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
2022-11-06 09:48:50 +01:00
.github/workflows github: fix config mistake preventing repo lockdown commenting 2022-04-26 16:12:26 +01:00
.gitlab/issue_templates GitLab: Add "Feature Request" issue template. 2021-06-25 10:08:37 +01:00
.gitlab-ci.d tests: Add sndio to the FreeBSD CI containers / VM 2022-10-28 09:39:21 +02:00
accel accel/tcg: Complete cpu initialization before registration 2022-11-01 08:31:41 +11:00
audio module: add Error arguments to module_load and module_load_qom 2022-11-06 09:48:50 +01:00
authz configure, meson: convert pam detection to meson 2021-06-25 10:54:10 +02:00
backends Hi, 2022-10-30 18:31:59 -04:00
block module: add Error arguments to module_load and module_load_qom 2022-11-06 09:48:50 +01:00
bsd-user bsd-user: Catch up with sys/param.h requirement for machine/pmap.h 2022-10-26 14:09:17 -06:00
chardev chardev: fix segfault in finalize 2022-09-29 14:38:05 +04:00
common-user common-user: Only compile the common user code if have_user is set 2022-06-28 11:12:05 +02:00
configs hw/isa/Kconfig: Fix dependencies of piix4 southbridge 2022-10-31 11:32:07 +01:00
contrib contrib/plugins: protect execlog's last_exec expansion 2022-10-31 20:37:59 +00:00
crypto crypto: quote algorithm names in error messages 2022-10-27 12:55:27 +01:00
disas disas/mips: Fix branch displacement for BEQZC and BNEZC 2022-10-31 11:32:07 +01:00
docs ppc patch queue for 2022-10-29: 2022-10-31 06:28:43 -04:00
dtc@b6910bec11 dtc: Update to version 1.6.1 2021-10-14 08:08:11 +02:00
dump dump/win_dump: limit number of processed PRCBs 2022-10-26 12:55:00 +04:00
ebpf ebpf: replace deprecated bpf_program__set_socket_filter 2022-07-06 11:39:09 +08:00
fpu softfloat: logB(0) should raise divideByZero exception 2022-10-17 10:28:35 +08:00
fsdev fsdev/virtfs-proxy-helper: Use g_mkdir() 2022-10-24 12:24:32 +02:00
gdb-xml gdb-xml: Fix size of EFER register on i386 architecture when debugged by GDB 2022-11-06 09:48:26 +01:00
gdbstub gdbstub: move guest debug support check to ops 2022-10-06 11:53:41 +01:00
hw module: add Error arguments to module_load and module_load_qom 2022-11-06 09:48:50 +01:00
include module: add Error arguments to module_load and module_load_qom 2022-11-06 09:48:50 +01:00
io io/channel-watch: Fix socket watch on Windows 2022-10-26 13:32:08 +01:00
libdecnumber libdecnumber: Introduce decNumberIntegralToInt128 2021-11-09 10:32:52 +11:00
linux-headers Update linux headers to v6.0-rc4 2022-09-26 17:23:47 +02:00
linux-user linux-user: always translate cmsg when recvmsg 2022-11-02 17:29:17 +01:00
meson@3a9b285a55 meson: require 0.61.3 2022-10-01 21:16:36 +02:00
migration reset: allow registering handlers that aren't called by snapshot loading 2022-10-27 11:34:31 +01:00
monitor qemu-sockets: move and rename SocketAddress_to_str() 2022-10-28 13:28:52 +08:00
nbd block: Change blk_{pread,pwrite}() param order 2022-07-12 12:14:56 +02:00
net net/vhost-vdpa.c: Fix clang compilation failure 2022-10-31 13:01:31 -04:00
pc-bios pc-bios/vof: Adopt meson style Make output 2022-10-06 11:53:40 +01:00
plugins plugins: add [pre|post]fork helpers to linux-user 2022-10-06 11:53:41 +01:00
po po: add ukrainian translation 2022-07-05 10:15:49 +02:00
python misc: fix commonly doubled up words 2022-08-01 11:58:02 +02:00
qapi block/blkio: Make driver nvme-io_uring take a "path" instead of a "filename" 2022-10-31 14:35:14 -04:00
qga qga: add channel path to error messages 2022-10-26 20:35:20 +03:00
qobject include/qapi: add g_autoptr support for qobject types 2022-04-06 10:50:38 +02:00
qom module: add Error arguments to module_load and module_load_qom 2022-11-06 09:48:50 +01:00
replay Pull request trivial patches branch 20220930-v2 2022-10-04 14:04:18 -04:00
roms qboot: update to latest submodule 2022-09-19 15:40:51 +02:00
scripts Add missing include statement for global xml_builtin 2022-11-06 09:48:42 +01:00
scsi QIOChannel: Add flags on io_writev and introduce io_flush callback 2022-05-16 13:56:24 +01:00
semihosting semihosting/arm-compat-semi: Avoid using hardcoded /tmp 2022-10-31 20:37:58 +00:00
softmmu module: add Error arguments to module_load and module_load_qom 2022-11-06 09:48:50 +01:00
storage-daemon qsd: Unlink absolute PID file path 2022-07-12 14:30:38 +02:00
stubs stubs: add qemu_ram_block_from_host() and qemu_ram_get_fd() 2022-10-26 14:56:42 -04:00
subprojects libvduse: Pass positive value to strerror() 2022-08-02 11:01:42 +02:00
target target-arm queue: 2022-11-04 11:01:17 -04:00
tcg testing and plugin updates for 7.2: 2022-11-01 13:39:06 -04:00
tests testing and plugin updates for 7.2: 2022-11-01 13:39:06 -04:00
tools virtiofsd: use g_date_time_get_microsecond to get subsecond 2022-09-22 13:13:47 -04:00
trace include/hw/core: Create struct CPUJumpCache 2022-10-04 12:13:12 -07:00
ui module: add Error arguments to module_load and module_load_qom 2022-11-06 09:48:50 +01:00
util module: add Error arguments to module_load and module_load_qom 2022-11-06 09:48:50 +01:00
.cirrus.yml ci: Upgrade msys2 release to 20220603 2022-07-29 10:33:29 -07:00
.dir-locals.el Add .dir-locals.el file to configure emacs coding style 2015-10-08 19:46:01 +03:00
.editorconfig .editorconfig: update the automatic mode setting for Emacs 2021-03-10 15:34:11 +00: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
.gitattributes gitattributes: Cover Objective-C source files 2022-03-29 00:15:14 +02:00
.gitignore .gitignore: add multiple items to .gitignore 2022-10-22 22:48:17 +02:00
.gitlab-ci.yml docs: Document GitLab custom CI/CD variables 2021-07-29 07:56:01 +02:00
.gitmodules Remove the slirp submodule (i.e. compile only with an external libslirp) 2022-09-26 17:23:47 +02:00
.gitpublish Add a git-publish configuration file 2018-03-05 09:03:17 +00:00
.mailmap MAINTAINERS: Replace my amsat.org email address 2022-10-17 17:21:22 -04:00
.patchew.yml scripts/checkpatch: roll diff tweaking into checkpatch itself 2021-06-25 10:08:33 +01:00
.readthedocs.yml readthedocs: build with Python 3.6 2020-10-05 16:30:45 +01:00
.travis.yml Revert "gitlab: disable accelerated zlib for s390x" 2022-07-20 12:15:09 +01:00
block.c module: add Error arguments to module_load and module_load_qom 2022-11-06 09:48:50 +01:00
blockdev-nbd.c nbd/server: Allow MULTI_CONN for shared writable exports 2022-05-12 13:10:52 +02:00
blockdev.c monitor: switch to *_co_* functions 2022-10-27 20:14:11 +02:00
blockjob.c block: remove all unused ->can_set_aio_ctx and ->set_aio_ctx callbacks 2022-10-27 20:14:11 +02:00
configure Fix broken configure with -Wunused-parameter 2022-11-06 09:48:37 +01:00
COPYING
COPYING.LIB COPYING.LIB: Synchronize the LGPL 2.1 with the version from gnu.org 2019-01-30 11:01:22 +01:00
cpu.c accel/tcg: Complete cpu initialization before registration 2022-11-01 08:31:41 +11:00
cpus-common.c cpus: Introduce cpu_list_generation_id 2022-07-20 12:15:08 +01:00
disas.c disas: use result of ->read_memory_func 2022-10-06 11:53:40 +01:00
event-loop-base.c util/event-loop-base: Introduce options to set the thread pool size 2022-05-09 10:43:23 +01:00
gitdm.config contrib/gitdm: add a new interns group-map for GSoC/Outreachy work 2021-07-23 17:22:16 +01:00
hmp-commands-info.hx hmp: add virtio commands 2022-10-09 16:38:45 -04:00
hmp-commands.hx qapi: net: add stream and dgram netdevs 2022-10-28 13:28:52 +08:00
iothread.c util/event-loop-base: Introduce options to set the thread pool size 2022-05-09 10:43:23 +01:00
job-qmp.c job.c: enable job lock/unlock and remove Aiocontext locks 2022-10-07 12:11:41 +02:00
job.c block: remove bdrv_try_set_aio_context and replace it with bdrv_try_change_aio_context 2022-10-27 20:14:11 +02:00
Kconfig meson: Introduce target-specific Kconfig 2021-07-09 18:21:34 +02:00
Kconfig.host vfio-user: build library 2022-06-15 16:42:33 +01:00
LICENSE tcg/LICENSE: Remove out of date claim about TCG subdirectory licensing 2019-11-11 15:11:21 +01:00
MAINTAINERS testing and plugin updates for 7.2: 2022-11-01 13:39:06 -04:00
Makefile configure: cleanup creation of tests/tcg target config 2022-10-06 11:53:40 +01:00
memory_ldst.c.inc exec/memory_ldst: Use correct type sizes 2021-05-26 08:35:51 -07:00
meson_options.txt blkio: add libblkio block driver 2022-10-26 14:56:42 -04:00
meson.build meson: avoid unused arguments of main() in compiler tests 2022-11-06 09:48:42 +01:00
module-common.c all: Clean up includes 2016-02-04 17:41:30 +00:00
os-posix.c os-posix: asynchronous teardown for shutdown on Linux 2022-10-31 09:46:34 +01:00
os-win32.c Remove qemu-common.h include from most units 2022-04-06 14:31:55 +02:00
page-vary-common.c Remove qemu-common.h include from most units 2022-04-06 14:31:55 +02:00
page-vary.c include: move target page bits declaration to page-vary.h 2022-04-06 14:31:43 +02:00
qemu-bridge-helper.c qemu-bridge-helper: relocate path to default ACL 2020-09-30 19:11:36 +02:00
qemu-edid.c qemu-edid: Restrict input parameter -d to avoid division by zero 2022-10-12 13:38:15 +02:00
qemu-img-cmds.hx qemu-img: Unify [-b [-F]] documentation 2022-02-01 13:49:15 +01:00
qemu-img.c block: return errors from bdrv_register_buf() 2022-10-26 14:56:42 -04:00
qemu-io-cmds.c block: Change blk_pwrite_compressed() param order 2022-07-12 12:14:56 +02:00
qemu-io.c include: move qemu_*_exec_dir() to cutils 2022-05-28 11:42:56 +02:00
qemu-keymap.c qemu-keymap: Add license in generated files 2021-12-17 10:41:50 +01:00
qemu-nbd.c qemu-nbd: Pass max connections to blockdev layer 2022-05-12 13:10:52 +02:00
qemu-options.hx * bug fixes 2022-11-03 10:54:37 -04:00
qemu.nsi nsis installer: Fix mouse-over descriptions for emulators 2022-03-18 10:55:15 +00:00
qemu.sasl sasl: remove comment about obsolete kerberos versions 2021-06-14 13:28:50 +01:00
README.rst README.rst: fix link formatting 2022-08-04 13:44:21 +02:00
replication.c replication: move include out of root directory 2021-05-26 14:49:46 +02:00
trace-events gdbstub: move into its own sub directory 2022-10-06 11:53:41 +01:00
VERSION Open 7.2 development tree 2022-08-30 09:40:41 -07:00
version.rc configure: remove CONFIG_FILEVERSION and CONFIG_PRODUCTVERSION 2021-01-02 21:03:37 +01: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.


Documentation
=============

Documentation can be found hosted online at
`<https://www.qemu.org/documentation/>`_. The documentation for the
current development version that is available at
`<https://www.qemu.org/docs/master/>`_ is generated from the ``docs/``
folder in the source tree, and is built by `Sphinx
<https://www.sphinx-doc.org/en/master/>`_.


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:


.. code-block:: shell

  mkdir build
  cd build
  ../configure
  make

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

* `<https://wiki.qemu.org/Hosts/Linux>`_
* `<https://wiki.qemu.org/Hosts/Mac>`_
* `<https://wiki.qemu.org/Hosts/W32>`_


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

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

.. code-block:: shell

   git clone https://gitlab.com/qemu-project/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 `style section
<https://www.qemu.org/docs/master/devel/style.html>`_ of
the Developers Guide.

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

* `<https://wiki.qemu.org/Contribute/SubmitAPatch>`_
* `<https://wiki.qemu.org/Contribute/TrivialPatches>`_

The QEMU website is also maintained under source control.

.. code-block:: shell

  git clone https://gitlab.com/qemu-project/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:

.. code-block:: shell

  $ 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:

.. code-block:: shell

  $ 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 GitLab issues to track bugs. Bugs
found when running code built from QEMU git or upstream released sources
should be reported via:

* `<https://gitlab.com/qemu-project/qemu/-/issues>`_

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 GitLab.

For additional information on bug reporting consult:

* `<https://wiki.qemu.org/Contribute/ReportABug>`_


ChangeLog
=========

For version history and release notes, please visit
`<https://wiki.qemu.org/ChangeLog/>`_ or look at the git history for
more detailed information.


Contact
=======

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

* `<mailto: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://wiki.qemu.org/Contribute/StartHere>`_