mirror of https://github.com/xemu-project/xemu.git
target-arm queue:
* fix bug in PAuth emulation * add PMU to Cortex-R5, Cortex-R5F * qemu-nbd: Convert documentation to rST * qemu-block-drivers: Convert documentation to rST * Fix Exynos4210 UART DMA support * Various minor code cleanups -----BEGIN PGP SIGNATURE----- iQJNBAABCAA3FiEE4aXFk81BneKOgxXPPCUl7RQ2DN4FAl4py1oZHHBldGVyLm1h eWRlbGxAbGluYXJvLm9yZwAKCRA8JSXtFDYM3s80EACJhnV3ZcI6YCkCQd31eGWC jbC8eIaoYH9ROMqvG4RqiOMAHW3WFgk/k4QzvD7rU9FwKXkd2W7PUr93/dd8CAmB vtcIipMGENozjxDI2I+eKSEw5vils0Q1PLQFQ6tbMsSDEe6zzrzsZ4PwfUtCHvAc CKN/TeVIQKeY/WU3fkByOSrUXo9ZhsWapPTss9i6olvLj+HUMS/Sh/3igdAUVYrt GkXZjE8RyIDTv3gM3XnPGJ1heNDGzgJBjo4UzFnR2eoShVir5It0IXg32Paltuzo Ewe1Gw8Kjy1pynRaVYDQU1wDaenKWlNwb/P5VAcp84xmJsdMquhme5LKd9OtVJwk 5aSZExLfmecOvn6BLYDeBOMAOBGdbqw9gd4t0e4YzM9g55JT/FseZ8F+s0xhhWqA bjlLhyse5ZEi7MbYKXZj1ADblsP2F+NZvqulon1wlf9IKKlLROzhTj0RjzKoCq+V QUe8tTCkj2m4f2mdFpS/AUCHwlfF3tjUiuJwxsD/yvOOASOSoL4Ch8rDddWQgGKp wDI4jTB5TpRZioPlfB8MRsz/6oMF5VmOQSX1aY1P+psd0jTSc8kWtz4NLqNl1i5u rWTQA5VZYQUz4kV9nrGqNPN4HCiGKF9zY0z0Z7WSNGAC6OyOLkNQrMinCrIRwpwA ADFqQSrqK3VhRwVFoLdtgA== =99+g -----END PGP SIGNATURE----- Merge remote-tracking branch 'remotes/pmaydell/tags/pull-target-arm-20200123-4' into staging target-arm queue: * fix bug in PAuth emulation * add PMU to Cortex-R5, Cortex-R5F * qemu-nbd: Convert documentation to rST * qemu-block-drivers: Convert documentation to rST * Fix Exynos4210 UART DMA support * Various minor code cleanups # gpg: Signature made Thu 23 Jan 2020 16:35:38 GMT # gpg: using RSA key E1A5C593CD419DE28E8315CF3C2525ED14360CDE # gpg: issuer "peter.maydell@linaro.org" # gpg: Good signature from "Peter Maydell <peter.maydell@linaro.org>" [ultimate] # gpg: aka "Peter Maydell <pmaydell@gmail.com>" [ultimate] # gpg: aka "Peter Maydell <pmaydell@chiark.greenend.org.uk>" [ultimate] # Primary key fingerprint: E1A5 C593 CD41 9DE2 8E83 15CF 3C25 25ED 1436 0CDE * remotes/pmaydell/tags/pull-target-arm-20200123-4: hw/arm/exynos4210: Connect serial port DMA busy signals with pl330 hw/char/exynos4210_uart: Add receive DMA support hw/char/exynos4210_uart: Implement Rx FIFO level triggers and timeouts hw/char/exynos4210_uart: Implement post_load function hw/char/exynos4210_uart: Convert to support tracing hw/arm/exynos4210: Fix DMA initialization hw/core/or-irq: Increase limit of or-lines to 48 dma/pl330: Convert to support tracing hw/misc/stm32f4xx_syscfg: Fix copy/paste error target/arm/arch_dump: Add SVE notes qemu-block-drivers: Convert to rST docs: Create stub system manual qemu-nbd: Convert invocation documentation to rST hw/arm: Use helper function to trigger hotplug handler plug hw/acpi: Remove extra indent in ACPI GED hotplug cb tests/tcg/aarch64: Add pauth-4 tests/tcg/aarch64: Add pauth-3 tests/tcg/aarch64: Fix compilation parameters for pauth-% target/arm: Fix PAuth sbox functions target/arm: add PMU feature to cortex-r5 and cortex-r5f Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
This commit is contained in:
commit
6918ab2570
|
@ -2519,6 +2519,7 @@ F: include/block/nbd*
|
|||
F: qemu-nbd.*
|
||||
F: blockdev-nbd.c
|
||||
F: docs/interop/nbd.txt
|
||||
F: docs/interop/qemu-nbd.rst
|
||||
T: git https://repo.or.cz/qemu/ericb.git nbd
|
||||
|
||||
NFS
|
||||
|
|
37
Makefile
37
Makefile
|
@ -339,10 +339,12 @@ MANUAL_BUILDDIR := docs
|
|||
endif
|
||||
|
||||
ifdef BUILD_DOCS
|
||||
DOCS=qemu-doc.html qemu-doc.txt qemu.1 qemu-img.1 qemu-nbd.8 $(MANUAL_BUILDDIR)/interop/qemu-ga.8
|
||||
DOCS=qemu-doc.html qemu-doc.txt qemu.1 qemu-img.1
|
||||
DOCS+=$(MANUAL_BUILDDIR)/interop/qemu-nbd.8
|
||||
DOCS+=$(MANUAL_BUILDDIR)/interop/qemu-ga.8
|
||||
DOCS+=$(MANUAL_BUILDDIR)/system/qemu-block-drivers.7
|
||||
DOCS+=docs/interop/qemu-qmp-ref.html docs/interop/qemu-qmp-ref.txt docs/interop/qemu-qmp-ref.7
|
||||
DOCS+=docs/interop/qemu-ga-ref.html docs/interop/qemu-ga-ref.txt docs/interop/qemu-ga-ref.7
|
||||
DOCS+=docs/qemu-block-drivers.7
|
||||
DOCS+=docs/qemu-cpu-models.7
|
||||
DOCS+=$(MANUAL_BUILDDIR)/index.html
|
||||
ifdef CONFIG_VIRTFS
|
||||
|
@ -749,12 +751,12 @@ distclean: clean
|
|||
rm -f docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt
|
||||
rm -f docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf
|
||||
rm -f docs/interop/qemu-qmp-ref.html docs/interop/qemu-ga-ref.html
|
||||
rm -f docs/qemu-block-drivers.7
|
||||
rm -f docs/qemu-cpu-models.7
|
||||
rm -rf .doctrees
|
||||
$(call clean-manual,devel)
|
||||
$(call clean-manual,interop)
|
||||
$(call clean-manual,specs)
|
||||
$(call clean-manual,system)
|
||||
for d in $(TARGET_DIRS); do \
|
||||
rm -rf $$d || exit 1 ; \
|
||||
done
|
||||
|
@ -811,6 +813,7 @@ endef
|
|||
install-sphinxdocs: sphinxdocs
|
||||
$(call install-manual,interop)
|
||||
$(call install-manual,specs)
|
||||
$(call install-manual,system)
|
||||
|
||||
install-doc: $(DOCS) install-sphinxdocs
|
||||
$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)"
|
||||
|
@ -824,12 +827,12 @@ ifdef CONFIG_POSIX
|
|||
$(INSTALL_DATA) qemu.1 "$(DESTDIR)$(mandir)/man1"
|
||||
$(INSTALL_DIR) "$(DESTDIR)$(mandir)/man7"
|
||||
$(INSTALL_DATA) docs/interop/qemu-qmp-ref.7 "$(DESTDIR)$(mandir)/man7"
|
||||
$(INSTALL_DATA) docs/qemu-block-drivers.7 "$(DESTDIR)$(mandir)/man7"
|
||||
$(INSTALL_DATA) $(MANUAL_BUILDDIR)/system/qemu-block-drivers.7 "$(DESTDIR)$(mandir)/man7"
|
||||
$(INSTALL_DATA) docs/qemu-cpu-models.7 "$(DESTDIR)$(mandir)/man7"
|
||||
ifeq ($(CONFIG_TOOLS),y)
|
||||
$(INSTALL_DATA) qemu-img.1 "$(DESTDIR)$(mandir)/man1"
|
||||
$(INSTALL_DIR) "$(DESTDIR)$(mandir)/man8"
|
||||
$(INSTALL_DATA) qemu-nbd.8 "$(DESTDIR)$(mandir)/man8"
|
||||
$(INSTALL_DATA) $(MANUAL_BUILDDIR)/interop/qemu-nbd.8 "$(DESTDIR)$(mandir)/man8"
|
||||
endif
|
||||
ifdef CONFIG_TRACE_SYSTEMTAP
|
||||
$(INSTALL_DATA) scripts/qemu-trace-stap.1 "$(DESTDIR)$(mandir)/man1"
|
||||
|
@ -998,7 +1001,10 @@ docs/version.texi: $(SRC_PATH)/VERSION config-host.mak
|
|||
# and handles "don't rebuild things unless necessary" itself.
|
||||
# The '.doctrees' files are cached information to speed this up.
|
||||
.PHONY: sphinxdocs
|
||||
sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html $(MANUAL_BUILDDIR)/interop/index.html $(MANUAL_BUILDDIR)/specs/index.html
|
||||
sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html \
|
||||
$(MANUAL_BUILDDIR)/interop/index.html \
|
||||
$(MANUAL_BUILDDIR)/specs/index.html \
|
||||
$(MANUAL_BUILDDIR)/system/index.html
|
||||
|
||||
# Canned command to build a single manual
|
||||
# Arguments: $1 = manual name, $2 = Sphinx builder ('html' or 'man')
|
||||
|
@ -1007,7 +1013,9 @@ sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html $(MANUAL_BUILDDIR)/interop/index
|
|||
# a single doctree: https://github.com/sphinx-doc/sphinx/issues/2946
|
||||
build-manual = $(call quiet-command,CONFDIR="$(qemu_confdir)" sphinx-build $(if $(V),,-q) -W -b $2 -D version=$(VERSION) -D release="$(FULL_VERSION)" -d .doctrees/$1-$2 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1 ,"SPHINX","$(MANUAL_BUILDDIR)/$1")
|
||||
# We assume all RST files in the manual's directory are used in it
|
||||
manual-deps = $(wildcard $(SRC_PATH)/docs/$1/*.rst) $(SRC_PATH)/docs/$1/conf.py $(SRC_PATH)/docs/conf.py
|
||||
manual-deps = $(wildcard $(SRC_PATH)/docs/$1/*.rst) \
|
||||
$(wildcard $(SRC_PATH)/docs/$1/*.rst.inc) \
|
||||
$(SRC_PATH)/docs/$1/conf.py $(SRC_PATH)/docs/conf.py
|
||||
|
||||
$(MANUAL_BUILDDIR)/devel/index.html: $(call manual-deps,devel)
|
||||
$(call build-manual,devel,html)
|
||||
|
@ -1018,9 +1026,18 @@ $(MANUAL_BUILDDIR)/interop/index.html: $(call manual-deps,interop)
|
|||
$(MANUAL_BUILDDIR)/specs/index.html: $(call manual-deps,specs)
|
||||
$(call build-manual,specs,html)
|
||||
|
||||
$(MANUAL_BUILDDIR)/system/index.html: $(call manual-deps,system)
|
||||
$(call build-manual,system,html)
|
||||
|
||||
$(MANUAL_BUILDDIR)/interop/qemu-ga.8: $(call manual-deps,interop)
|
||||
$(call build-manual,interop,man)
|
||||
|
||||
$(MANUAL_BUILDDIR)/interop/qemu-nbd.8: $(call manual-deps,interop)
|
||||
$(call build-manual,interop,man)
|
||||
|
||||
$(MANUAL_BUILDDIR)/system/qemu-block-drivers.7: $(call manual-deps,system)
|
||||
$(call build-manual,system,man)
|
||||
|
||||
$(MANUAL_BUILDDIR)/index.html: $(SRC_PATH)/docs/index.html.in qemu-version.h
|
||||
@mkdir -p "$(MANUAL_BUILDDIR)"
|
||||
$(call quiet-command, sed "s|@@VERSION@@|${VERSION}|g" $< >$@, \
|
||||
|
@ -1048,8 +1065,6 @@ qemu.1: qemu-doc.texi qemu-options.texi qemu-monitor.texi qemu-monitor-info.texi
|
|||
qemu.1: qemu-option-trace.texi
|
||||
qemu-img.1: qemu-img.texi qemu-option-trace.texi qemu-img-cmds.texi
|
||||
fsdev/virtfs-proxy-helper.1: fsdev/virtfs-proxy-helper.texi
|
||||
qemu-nbd.8: qemu-nbd.texi qemu-option-trace.texi
|
||||
docs/qemu-block-drivers.7: docs/qemu-block-drivers.texi
|
||||
docs/qemu-cpu-models.7: docs/qemu-cpu-models.texi
|
||||
scripts/qemu-trace-stap.1: scripts/qemu-trace-stap.texi
|
||||
|
||||
|
@ -1059,10 +1074,10 @@ pdf: qemu-doc.pdf docs/interop/qemu-qmp-ref.pdf docs/interop/qemu-ga-ref.pdf
|
|||
txt: qemu-doc.txt docs/interop/qemu-qmp-ref.txt docs/interop/qemu-ga-ref.txt
|
||||
|
||||
qemu-doc.html qemu-doc.info qemu-doc.pdf qemu-doc.txt: \
|
||||
qemu-img.texi qemu-nbd.texi qemu-options.texi \
|
||||
qemu-img.texi qemu-options.texi \
|
||||
qemu-tech.texi qemu-option-trace.texi \
|
||||
qemu-deprecated.texi qemu-monitor.texi qemu-img-cmds.texi \
|
||||
qemu-monitor-info.texi docs/qemu-block-drivers.texi \
|
||||
qemu-monitor-info.texi \
|
||||
docs/qemu-cpu-models.texi docs/security.texi
|
||||
|
||||
docs/interop/qemu-ga-ref.dvi docs/interop/qemu-ga-ref.html \
|
||||
|
|
|
@ -12,6 +12,7 @@
|
|||
<li><a href="qemu-ga-ref.html">Guest Agent Protocol Reference</a></li>
|
||||
<li><a href="interop/index.html">System Emulation Management and Interoperability Guide</a></li>
|
||||
<li><a href="specs/index.html">System Emulation Guest Hardware Specifications</a></li>
|
||||
<li><a href="system/index.html">System Emulation User's Guide</a></li>
|
||||
</ul>
|
||||
</body>
|
||||
</html>
|
||||
|
|
|
@ -13,4 +13,4 @@ Welcome to QEMU's documentation!
|
|||
interop/index
|
||||
devel/index
|
||||
specs/index
|
||||
|
||||
system/index
|
||||
|
|
|
@ -18,5 +18,7 @@ html_theme_options['description'] = u'System Emulation Management and Interopera
|
|||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('qemu-ga', 'qemu-ga', u'QEMU Guest Agent',
|
||||
['Michael Roth <mdroth@linux.vnet.ibm.com>'], 8)
|
||||
['Michael Roth <mdroth@linux.vnet.ibm.com>'], 8),
|
||||
('qemu-nbd', 'qemu-nbd', u'QEMU Disk Network Block Device Server',
|
||||
['Anthony Liguori <anthony@codemonkey.ws>'], 8)
|
||||
]
|
||||
|
|
|
@ -18,5 +18,6 @@ Contents:
|
|||
live-block-operations
|
||||
pr-helper
|
||||
qemu-ga
|
||||
qemu-nbd
|
||||
vhost-user
|
||||
vhost-user-gpu
|
||||
|
|
|
@ -0,0 +1,263 @@
|
|||
QEMU Disk Network Block Device Server
|
||||
=====================================
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
**qemu-nbd** [*OPTION*]... *filename*
|
||||
|
||||
**qemu-nbd** -L [*OPTION*]...
|
||||
|
||||
**qemu-nbd** -d *dev*
|
||||
|
||||
Description
|
||||
-----------
|
||||
|
||||
Export a QEMU disk image using the NBD protocol.
|
||||
|
||||
Other uses:
|
||||
|
||||
- Bind a /dev/nbdX block device to a QEMU server (on Linux).
|
||||
- As a client to query exports of a remote NBD server.
|
||||
|
||||
Options
|
||||
-------
|
||||
|
||||
.. program:: qemu-nbd
|
||||
|
||||
*filename* is a disk image filename, or a set of block
|
||||
driver options if ``--image-opts`` is specified.
|
||||
|
||||
*dev* is an NBD device.
|
||||
|
||||
.. option:: --object type,id=ID,...props...
|
||||
|
||||
Define a new instance of the *type* object class identified by *ID*.
|
||||
See the :manpage:`qemu(1)` manual page for full details of the properties
|
||||
supported. The common object types that it makes sense to define are the
|
||||
``secret`` object, which is used to supply passwords and/or encryption
|
||||
keys, and the ``tls-creds`` object, which is used to supply TLS
|
||||
credentials for the qemu-nbd server or client.
|
||||
|
||||
.. option:: -p, --port=PORT
|
||||
|
||||
TCP port to listen on as a server, or connect to as a client
|
||||
(default ``10809``).
|
||||
|
||||
.. option:: -o, --offset=OFFSET
|
||||
|
||||
The offset into the image.
|
||||
|
||||
.. option:: -b, --bind=IFACE
|
||||
|
||||
The interface to bind to as a server, or connect to as a client
|
||||
(default ``0.0.0.0``).
|
||||
|
||||
.. option:: -k, --socket=PATH
|
||||
|
||||
Use a unix socket with path *PATH*.
|
||||
|
||||
.. option:: --image-opts
|
||||
|
||||
Treat *filename* as a set of image options, instead of a plain
|
||||
filename. If this flag is specified, the ``-f`` flag should
|
||||
not be used, instead the :option:`format=` option should be set.
|
||||
|
||||
.. option:: -f, --format=FMT
|
||||
|
||||
Force the use of the block driver for format *FMT* instead of
|
||||
auto-detecting.
|
||||
|
||||
.. option:: -r, --read-only
|
||||
|
||||
Export the disk as read-only.
|
||||
|
||||
.. option:: -P, --partition=NUM
|
||||
|
||||
Deprecated: Only expose MBR partition *NUM*. Understands physical
|
||||
partitions 1-4 and logical partition 5. New code should instead use
|
||||
:option:`--image-opts` with the raw driver wrapping a subset of the
|
||||
original image.
|
||||
|
||||
.. option:: -B, --bitmap=NAME
|
||||
|
||||
If *filename* has a qcow2 persistent bitmap *NAME*, expose
|
||||
that bitmap via the ``qemu:dirty-bitmap:NAME`` context
|
||||
accessible through NBD_OPT_SET_META_CONTEXT.
|
||||
|
||||
.. option:: -s, --snapshot
|
||||
|
||||
Use *filename* as an external snapshot, create a temporary
|
||||
file with ``backing_file=``\ *filename*, redirect the write to
|
||||
the temporary one.
|
||||
|
||||
.. option:: -l, --load-snapshot=SNAPSHOT_PARAM
|
||||
|
||||
Load an internal snapshot inside *filename* and export it
|
||||
as an read-only device, SNAPSHOT_PARAM format is
|
||||
``snapshot.id=[ID],snapshot.name=[NAME]`` or ``[ID_OR_NAME]``
|
||||
|
||||
.. option:: --cache=CACHE
|
||||
|
||||
The cache mode to be used with the file. See the documentation of
|
||||
the emulator's ``-drive cache=...`` option for allowed values.
|
||||
|
||||
.. option:: -n, --nocache
|
||||
|
||||
Equivalent to :option:`--cache=none`.
|
||||
|
||||
.. option:: --aio=AIO
|
||||
|
||||
Set the asynchronous I/O mode between ``threads`` (the default)
|
||||
and ``native`` (Linux only).
|
||||
|
||||
.. option:: --discard=DISCARD
|
||||
|
||||
Control whether ``discard`` (also known as ``trim`` or ``unmap``)
|
||||
requests are ignored or passed to the filesystem. *DISCARD* is one of
|
||||
``ignore`` (or ``off``), ``unmap`` (or ``on``). The default is
|
||||
``ignore``.
|
||||
|
||||
.. option:: --detect-zeroes=DETECT_ZEROES
|
||||
|
||||
Control the automatic conversion of plain zero writes by the OS to
|
||||
driver-specific optimized zero write commands. *DETECT_ZEROES* is one of
|
||||
``off``, ``on``, or ``unmap``. ``unmap``
|
||||
converts a zero write to an unmap operation and can only be used if
|
||||
*DISCARD* is set to ``unmap``. The default is ``off``.
|
||||
|
||||
.. option:: -c, --connect=DEV
|
||||
|
||||
Connect *filename* to NBD device *DEV* (Linux only).
|
||||
|
||||
.. option:: -d, --disconnect
|
||||
|
||||
Disconnect the device *DEV* (Linux only).
|
||||
|
||||
.. option:: -e, --shared=NUM
|
||||
|
||||
Allow up to *NUM* clients to share the device (default
|
||||
``1``). Safe for readers, but for now, consistency is not
|
||||
guaranteed between multiple writers.
|
||||
|
||||
.. option:: -t, --persistent
|
||||
|
||||
Don't exit on the last connection.
|
||||
|
||||
.. option:: -x, --export-name=NAME
|
||||
|
||||
Set the NBD volume export name (default of a zero-length string).
|
||||
|
||||
.. option:: -D, --description=DESCRIPTION
|
||||
|
||||
Set the NBD volume export description, as a human-readable
|
||||
string.
|
||||
|
||||
.. option:: -L, --list
|
||||
|
||||
Connect as a client and list all details about the exports exposed by
|
||||
a remote NBD server. This enables list mode, and is incompatible
|
||||
with options that change behavior related to a specific export (such as
|
||||
:option:`--export-name`, :option:`--offset`, ...).
|
||||
|
||||
.. option:: --tls-creds=ID
|
||||
|
||||
Enable mandatory TLS encryption for the server by setting the ID
|
||||
of the TLS credentials object previously created with the --object
|
||||
option; or provide the credentials needed for connecting as a client
|
||||
in list mode.
|
||||
|
||||
.. option:: --fork
|
||||
|
||||
Fork off the server process and exit the parent once the server is running.
|
||||
|
||||
.. option:: --pid-file=PATH
|
||||
|
||||
Store the server's process ID in the given file.
|
||||
|
||||
.. option:: --tls-authz=ID
|
||||
|
||||
Specify the ID of a qauthz object previously created with the
|
||||
:option:`--object` option. This will be used to authorize connecting users
|
||||
against their x509 distinguished name.
|
||||
|
||||
.. option:: -v, --verbose
|
||||
|
||||
Display extra debugging information.
|
||||
|
||||
.. option:: -h, --help
|
||||
|
||||
Display this help and exit.
|
||||
|
||||
.. option:: -V, --version
|
||||
|
||||
Display version information and exit.
|
||||
|
||||
.. option:: -T, --trace [[enable=]PATTERN][,events=FILE][,file=FILE]
|
||||
|
||||
.. include:: qemu-option-trace.rst.inc
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
Start a server listening on port 10809 that exposes only the
|
||||
guest-visible contents of a qcow2 file, with no TLS encryption, and
|
||||
with the default export name (an empty string). The command is
|
||||
one-shot, and will block until the first successful client
|
||||
disconnects:
|
||||
|
||||
::
|
||||
|
||||
qemu-nbd -f qcow2 file.qcow2
|
||||
|
||||
Start a long-running server listening with encryption on port 10810,
|
||||
and whitelist clients with a specific X.509 certificate to connect to
|
||||
a 1 megabyte subset of a raw file, using the export name 'subset':
|
||||
|
||||
::
|
||||
|
||||
qemu-nbd \
|
||||
--object tls-creds-x509,id=tls0,endpoint=server,dir=/path/to/qemutls \
|
||||
--object 'authz-simple,id=auth0,identity=CN=laptop.example.com,,\
|
||||
O=Example Org,,L=London,,ST=London,,C=GB' \
|
||||
--tls-creds tls0 --tls-authz auth0 \
|
||||
-t -x subset -p 10810 \
|
||||
--image-opts driver=raw,offset=1M,size=1M,file.driver=file,file.filename=file.raw
|
||||
|
||||
Serve a read-only copy of just the first MBR partition of a guest
|
||||
image over a Unix socket with as many as 5 simultaneous readers, with
|
||||
a persistent process forked as a daemon:
|
||||
|
||||
::
|
||||
|
||||
qemu-nbd --fork --persistent --shared=5 --socket=/path/to/sock \
|
||||
--partition=1 --read-only --format=qcow2 file.qcow2
|
||||
|
||||
Expose the guest-visible contents of a qcow2 file via a block device
|
||||
/dev/nbd0 (and possibly creating /dev/nbd0p1 and friends for
|
||||
partitions found within), then disconnect the device when done.
|
||||
Access to bind qemu-nbd to an /dev/nbd device generally requires root
|
||||
privileges, and may also require the execution of ``modprobe nbd``
|
||||
to enable the kernel NBD client module. *CAUTION*: Do not use
|
||||
this method to mount filesystems from an untrusted guest image - a
|
||||
malicious guest may have prepared the image to attempt to trigger
|
||||
kernel bugs in partition probing or file system mounting.
|
||||
|
||||
::
|
||||
|
||||
qemu-nbd -c /dev/nbd0 -f qcow2 file.qcow2
|
||||
qemu-nbd -d /dev/nbd0
|
||||
|
||||
Query a remote server to see details about what export(s) it is
|
||||
serving on port 10809, and authenticating via PSK:
|
||||
|
||||
::
|
||||
|
||||
qemu-nbd \
|
||||
--object tls-creds-psk,id=tls0,dir=/tmp/keys,username=eblake,endpoint=client \
|
||||
--tls-creds tls0 -L -b remote.example.com
|
||||
|
||||
See also
|
||||
--------
|
||||
|
||||
:manpage:`qemu(1)`, :manpage:`qemu-img(1)`
|
|
@ -0,0 +1,30 @@
|
|||
..
|
||||
The contents of this file must be kept in sync with qemu-option-trace.texi
|
||||
until all the users of the texi file have been converted to rst and
|
||||
the texi file can be removed.
|
||||
|
||||
Specify tracing options.
|
||||
|
||||
.. option:: [enable=]PATTERN
|
||||
|
||||
Immediately enable events matching *PATTERN*
|
||||
(either event name or a globbing pattern). This option is only
|
||||
available if QEMU has been compiled with the ``simple``, ``log``
|
||||
or ``ftrace`` tracing backend. To specify multiple events or patterns,
|
||||
specify the :option:`-trace` option multiple times.
|
||||
|
||||
Use :option:`-trace help` to print a list of names of trace points.
|
||||
|
||||
.. option:: events=FILE
|
||||
|
||||
Immediately enable events listed in *FILE*.
|
||||
The file must contain one event name (as listed in the ``trace-events-all``
|
||||
file) per line; globbing patterns are accepted too. This option is only
|
||||
available if QEMU has been compiled with the ``simple``, ``log`` or
|
||||
``ftrace`` tracing backend.
|
||||
|
||||
.. option:: file=FILE
|
||||
|
||||
Log output traces to *FILE*.
|
||||
This option is only available if QEMU has been compiled with
|
||||
the ``simple`` tracing backend.
|
|
@ -1,889 +0,0 @@
|
|||
@c man begin SYNOPSIS
|
||||
QEMU block driver reference manual
|
||||
@c man end
|
||||
|
||||
@set qemu_system qemu-system-x86_64
|
||||
|
||||
@c man begin DESCRIPTION
|
||||
|
||||
@node disk_images_formats
|
||||
@subsection Disk image file formats
|
||||
|
||||
QEMU supports many image file formats that can be used with VMs as well as with
|
||||
any of the tools (like @code{qemu-img}). This includes the preferred formats
|
||||
raw and qcow2 as well as formats that are supported for compatibility with
|
||||
older QEMU versions or other hypervisors.
|
||||
|
||||
Depending on the image format, different options can be passed to
|
||||
@code{qemu-img create} and @code{qemu-img convert} using the @code{-o} option.
|
||||
This section describes each format and the options that are supported for it.
|
||||
|
||||
@table @option
|
||||
@item raw
|
||||
|
||||
Raw disk image format. This format has the advantage of
|
||||
being simple and easily exportable to all other emulators. If your
|
||||
file system supports @emph{holes} (for example in ext2 or ext3 on
|
||||
Linux or NTFS on Windows), then only the written sectors will reserve
|
||||
space. Use @code{qemu-img info} to know the real size used by the
|
||||
image or @code{ls -ls} on Unix/Linux.
|
||||
|
||||
Supported options:
|
||||
@table @code
|
||||
@item preallocation
|
||||
Preallocation mode (allowed values: @code{off}, @code{falloc}, @code{full}).
|
||||
@code{falloc} mode preallocates space for image by calling posix_fallocate().
|
||||
@code{full} mode preallocates space for image by writing data to underlying
|
||||
storage. This data may or may not be zero, depending on the storage location.
|
||||
@end table
|
||||
|
||||
@item qcow2
|
||||
QEMU image format, the most versatile format. Use it to have smaller
|
||||
images (useful if your filesystem does not supports holes, for example
|
||||
on Windows), zlib based compression and support of multiple VM
|
||||
snapshots.
|
||||
|
||||
Supported options:
|
||||
@table @code
|
||||
@item compat
|
||||
Determines the qcow2 version to use. @code{compat=0.10} uses the
|
||||
traditional image format that can be read by any QEMU since 0.10.
|
||||
@code{compat=1.1} enables image format extensions that only QEMU 1.1 and
|
||||
newer understand (this is the default). Amongst others, this includes
|
||||
zero clusters, which allow efficient copy-on-read for sparse images.
|
||||
|
||||
@item backing_file
|
||||
File name of a base image (see @option{create} subcommand)
|
||||
@item backing_fmt
|
||||
Image format of the base image
|
||||
@item encryption
|
||||
This option is deprecated and equivalent to @code{encrypt.format=aes}
|
||||
|
||||
@item encrypt.format
|
||||
|
||||
If this is set to @code{luks}, it requests that the qcow2 payload (not
|
||||
qcow2 header) be encrypted using the LUKS format. The passphrase to
|
||||
use to unlock the LUKS key slot is given by the @code{encrypt.key-secret}
|
||||
parameter. LUKS encryption parameters can be tuned with the other
|
||||
@code{encrypt.*} parameters.
|
||||
|
||||
If this is set to @code{aes}, the image is encrypted with 128-bit AES-CBC.
|
||||
The encryption key is given by the @code{encrypt.key-secret} parameter.
|
||||
This encryption format is considered to be flawed by modern cryptography
|
||||
standards, suffering from a number of design problems:
|
||||
|
||||
@itemize @minus
|
||||
@item The AES-CBC cipher is used with predictable initialization vectors based
|
||||
on the sector number. This makes it vulnerable to chosen plaintext attacks
|
||||
which can reveal the existence of encrypted data.
|
||||
@item The user passphrase is directly used as the encryption key. A poorly
|
||||
chosen or short passphrase will compromise the security of the encryption.
|
||||
@item In the event of the passphrase being compromised there is no way to
|
||||
change the passphrase to protect data in any qcow images. The files must
|
||||
be cloned, using a different encryption passphrase in the new file. The
|
||||
original file must then be securely erased using a program like shred,
|
||||
though even this is ineffective with many modern storage technologies.
|
||||
@end itemize
|
||||
|
||||
The use of this is no longer supported in system emulators. Support only
|
||||
remains in the command line utilities, for the purposes of data liberation
|
||||
and interoperability with old versions of QEMU. The @code{luks} format
|
||||
should be used instead.
|
||||
|
||||
@item encrypt.key-secret
|
||||
|
||||
Provides the ID of a @code{secret} object that contains the passphrase
|
||||
(@code{encrypt.format=luks}) or encryption key (@code{encrypt.format=aes}).
|
||||
|
||||
@item encrypt.cipher-alg
|
||||
|
||||
Name of the cipher algorithm and key length. Currently defaults
|
||||
to @code{aes-256}. Only used when @code{encrypt.format=luks}.
|
||||
|
||||
@item encrypt.cipher-mode
|
||||
|
||||
Name of the encryption mode to use. Currently defaults to @code{xts}.
|
||||
Only used when @code{encrypt.format=luks}.
|
||||
|
||||
@item encrypt.ivgen-alg
|
||||
|
||||
Name of the initialization vector generator algorithm. Currently defaults
|
||||
to @code{plain64}. Only used when @code{encrypt.format=luks}.
|
||||
|
||||
@item encrypt.ivgen-hash-alg
|
||||
|
||||
Name of the hash algorithm to use with the initialization vector generator
|
||||
(if required). Defaults to @code{sha256}. Only used when @code{encrypt.format=luks}.
|
||||
|
||||
@item encrypt.hash-alg
|
||||
|
||||
Name of the hash algorithm to use for PBKDF algorithm
|
||||
Defaults to @code{sha256}. Only used when @code{encrypt.format=luks}.
|
||||
|
||||
@item encrypt.iter-time
|
||||
|
||||
Amount of time, in milliseconds, to use for PBKDF algorithm per key slot.
|
||||
Defaults to @code{2000}. Only used when @code{encrypt.format=luks}.
|
||||
|
||||
@item cluster_size
|
||||
Changes the qcow2 cluster size (must be between 512 and 2M). Smaller cluster
|
||||
sizes can improve the image file size whereas larger cluster sizes generally
|
||||
provide better performance.
|
||||
|
||||
@item preallocation
|
||||
Preallocation mode (allowed values: @code{off}, @code{metadata}, @code{falloc},
|
||||
@code{full}). An image with preallocated metadata is initially larger but can
|
||||
improve performance when the image needs to grow. @code{falloc} and @code{full}
|
||||
preallocations are like the same options of @code{raw} format, but sets up
|
||||
metadata also.
|
||||
|
||||
@item lazy_refcounts
|
||||
If this option is set to @code{on}, reference count updates are postponed with
|
||||
the goal of avoiding metadata I/O and improving performance. This is
|
||||
particularly interesting with @option{cache=writethrough} which doesn't batch
|
||||
metadata updates. The tradeoff is that after a host crash, the reference count
|
||||
tables must be rebuilt, i.e. on the next open an (automatic) @code{qemu-img
|
||||
check -r all} is required, which may take some time.
|
||||
|
||||
This option can only be enabled if @code{compat=1.1} is specified.
|
||||
|
||||
@item nocow
|
||||
If this option is set to @code{on}, it will turn off COW of the file. It's only
|
||||
valid on btrfs, no effect on other file systems.
|
||||
|
||||
Btrfs has low performance when hosting a VM image file, even more when the guest
|
||||
on the VM also using btrfs as file system. Turning off COW is a way to mitigate
|
||||
this bad performance. Generally there are two ways to turn off COW on btrfs:
|
||||
a) Disable it by mounting with nodatacow, then all newly created files will be
|
||||
NOCOW. b) For an empty file, add the NOCOW file attribute. That's what this option
|
||||
does.
|
||||
|
||||
Note: this option is only valid to new or empty files. If there is an existing
|
||||
file which is COW and has data blocks already, it couldn't be changed to NOCOW
|
||||
by setting @code{nocow=on}. One can issue @code{lsattr filename} to check if
|
||||
the NOCOW flag is set or not (Capital 'C' is NOCOW flag).
|
||||
|
||||
@end table
|
||||
|
||||
@item qed
|
||||
Old QEMU image format with support for backing files and compact image files
|
||||
(when your filesystem or transport medium does not support holes).
|
||||
|
||||
When converting QED images to qcow2, you might want to consider using the
|
||||
@code{lazy_refcounts=on} option to get a more QED-like behaviour.
|
||||
|
||||
Supported options:
|
||||
@table @code
|
||||
@item backing_file
|
||||
File name of a base image (see @option{create} subcommand).
|
||||
@item backing_fmt
|
||||
Image file format of backing file (optional). Useful if the format cannot be
|
||||
autodetected because it has no header, like some vhd/vpc files.
|
||||
@item cluster_size
|
||||
Changes the cluster size (must be power-of-2 between 4K and 64K). Smaller
|
||||
cluster sizes can improve the image file size whereas larger cluster sizes
|
||||
generally provide better performance.
|
||||
@item table_size
|
||||
Changes the number of clusters per L1/L2 table (must be power-of-2 between 1
|
||||
and 16). There is normally no need to change this value but this option can be
|
||||
used for performance benchmarking.
|
||||
@end table
|
||||
|
||||
@item qcow
|
||||
Old QEMU image format with support for backing files, compact image files,
|
||||
encryption and compression.
|
||||
|
||||
Supported options:
|
||||
@table @code
|
||||
@item backing_file
|
||||
File name of a base image (see @option{create} subcommand)
|
||||
@item encryption
|
||||
This option is deprecated and equivalent to @code{encrypt.format=aes}
|
||||
|
||||
@item encrypt.format
|
||||
If this is set to @code{aes}, the image is encrypted with 128-bit AES-CBC.
|
||||
The encryption key is given by the @code{encrypt.key-secret} parameter.
|
||||
This encryption format is considered to be flawed by modern cryptography
|
||||
standards, suffering from a number of design problems enumerated previously
|
||||
against the @code{qcow2} image format.
|
||||
|
||||
The use of this is no longer supported in system emulators. Support only
|
||||
remains in the command line utilities, for the purposes of data liberation
|
||||
and interoperability with old versions of QEMU.
|
||||
|
||||
Users requiring native encryption should use the @code{qcow2} format
|
||||
instead with @code{encrypt.format=luks}.
|
||||
|
||||
@item encrypt.key-secret
|
||||
|
||||
Provides the ID of a @code{secret} object that contains the encryption
|
||||
key (@code{encrypt.format=aes}).
|
||||
|
||||
@end table
|
||||
|
||||
@item luks
|
||||
|
||||
LUKS v1 encryption format, compatible with Linux dm-crypt/cryptsetup
|
||||
|
||||
Supported options:
|
||||
@table @code
|
||||
|
||||
@item key-secret
|
||||
|
||||
Provides the ID of a @code{secret} object that contains the passphrase.
|
||||
|
||||
@item cipher-alg
|
||||
|
||||
Name of the cipher algorithm and key length. Currently defaults
|
||||
to @code{aes-256}.
|
||||
|
||||
@item cipher-mode
|
||||
|
||||
Name of the encryption mode to use. Currently defaults to @code{xts}.
|
||||
|
||||
@item ivgen-alg
|
||||
|
||||
Name of the initialization vector generator algorithm. Currently defaults
|
||||
to @code{plain64}.
|
||||
|
||||
@item ivgen-hash-alg
|
||||
|
||||
Name of the hash algorithm to use with the initialization vector generator
|
||||
(if required). Defaults to @code{sha256}.
|
||||
|
||||
@item hash-alg
|
||||
|
||||
Name of the hash algorithm to use for PBKDF algorithm
|
||||
Defaults to @code{sha256}.
|
||||
|
||||
@item iter-time
|
||||
|
||||
Amount of time, in milliseconds, to use for PBKDF algorithm per key slot.
|
||||
Defaults to @code{2000}.
|
||||
|
||||
@end table
|
||||
|
||||
@item vdi
|
||||
VirtualBox 1.1 compatible image format.
|
||||
Supported options:
|
||||
@table @code
|
||||
@item static
|
||||
If this option is set to @code{on}, the image is created with metadata
|
||||
preallocation.
|
||||
@end table
|
||||
|
||||
@item vmdk
|
||||
VMware 3 and 4 compatible image format.
|
||||
|
||||
Supported options:
|
||||
@table @code
|
||||
@item backing_file
|
||||
File name of a base image (see @option{create} subcommand).
|
||||
@item compat6
|
||||
Create a VMDK version 6 image (instead of version 4)
|
||||
@item hwversion
|
||||
Specify vmdk virtual hardware version. Compat6 flag cannot be enabled
|
||||
if hwversion is specified.
|
||||
@item subformat
|
||||
Specifies which VMDK subformat to use. Valid options are
|
||||
@code{monolithicSparse} (default),
|
||||
@code{monolithicFlat},
|
||||
@code{twoGbMaxExtentSparse},
|
||||
@code{twoGbMaxExtentFlat} and
|
||||
@code{streamOptimized}.
|
||||
@end table
|
||||
|
||||
@item vpc
|
||||
VirtualPC compatible image format (VHD).
|
||||
Supported options:
|
||||
@table @code
|
||||
@item subformat
|
||||
Specifies which VHD subformat to use. Valid options are
|
||||
@code{dynamic} (default) and @code{fixed}.
|
||||
@end table
|
||||
|
||||
@item VHDX
|
||||
Hyper-V compatible image format (VHDX).
|
||||
Supported options:
|
||||
@table @code
|
||||
@item subformat
|
||||
Specifies which VHDX subformat to use. Valid options are
|
||||
@code{dynamic} (default) and @code{fixed}.
|
||||
@item block_state_zero
|
||||
Force use of payload blocks of type 'ZERO'. Can be set to @code{on} (default)
|
||||
or @code{off}. When set to @code{off}, new blocks will be created as
|
||||
@code{PAYLOAD_BLOCK_NOT_PRESENT}, which means parsers are free to return
|
||||
arbitrary data for those blocks. Do not set to @code{off} when using
|
||||
@code{qemu-img convert} with @code{subformat=dynamic}.
|
||||
@item block_size
|
||||
Block size; min 1 MB, max 256 MB. 0 means auto-calculate based on image size.
|
||||
@item log_size
|
||||
Log size; min 1 MB.
|
||||
@end table
|
||||
@end table
|
||||
|
||||
@subsubsection Read-only formats
|
||||
More disk image file formats are supported in a read-only mode.
|
||||
@table @option
|
||||
@item bochs
|
||||
Bochs images of @code{growing} type.
|
||||
@item cloop
|
||||
Linux Compressed Loop image, useful only to reuse directly compressed
|
||||
CD-ROM images present for example in the Knoppix CD-ROMs.
|
||||
@item dmg
|
||||
Apple disk image.
|
||||
@item parallels
|
||||
Parallels disk image format.
|
||||
@end table
|
||||
|
||||
|
||||
@node host_drives
|
||||
@subsection Using host drives
|
||||
|
||||
In addition to disk image files, QEMU can directly access host
|
||||
devices. We describe here the usage for QEMU version >= 0.8.3.
|
||||
|
||||
@subsubsection Linux
|
||||
|
||||
On Linux, you can directly use the host device filename instead of a
|
||||
disk image filename provided you have enough privileges to access
|
||||
it. For example, use @file{/dev/cdrom} to access to the CDROM.
|
||||
|
||||
@table @code
|
||||
@item CD
|
||||
You can specify a CDROM device even if no CDROM is loaded. QEMU has
|
||||
specific code to detect CDROM insertion or removal. CDROM ejection by
|
||||
the guest OS is supported. Currently only data CDs are supported.
|
||||
@item Floppy
|
||||
You can specify a floppy device even if no floppy is loaded. Floppy
|
||||
removal is currently not detected accurately (if you change floppy
|
||||
without doing floppy access while the floppy is not loaded, the guest
|
||||
OS will think that the same floppy is loaded).
|
||||
Use of the host's floppy device is deprecated, and support for it will
|
||||
be removed in a future release.
|
||||
@item Hard disks
|
||||
Hard disks can be used. Normally you must specify the whole disk
|
||||
(@file{/dev/hdb} instead of @file{/dev/hdb1}) so that the guest OS can
|
||||
see it as a partitioned disk. WARNING: unless you know what you do, it
|
||||
is better to only make READ-ONLY accesses to the hard disk otherwise
|
||||
you may corrupt your host data (use the @option{-snapshot} command
|
||||
line option or modify the device permissions accordingly).
|
||||
@end table
|
||||
|
||||
@subsubsection Windows
|
||||
|
||||
@table @code
|
||||
@item CD
|
||||
The preferred syntax is the drive letter (e.g. @file{d:}). The
|
||||
alternate syntax @file{\\.\d:} is supported. @file{/dev/cdrom} is
|
||||
supported as an alias to the first CDROM drive.
|
||||
|
||||
Currently there is no specific code to handle removable media, so it
|
||||
is better to use the @code{change} or @code{eject} monitor commands to
|
||||
change or eject media.
|
||||
@item Hard disks
|
||||
Hard disks can be used with the syntax: @file{\\.\PhysicalDrive@var{N}}
|
||||
where @var{N} is the drive number (0 is the first hard disk).
|
||||
|
||||
WARNING: unless you know what you do, it is better to only make
|
||||
READ-ONLY accesses to the hard disk otherwise you may corrupt your
|
||||
host data (use the @option{-snapshot} command line so that the
|
||||
modifications are written in a temporary file).
|
||||
@end table
|
||||
|
||||
|
||||
@subsubsection Mac OS X
|
||||
|
||||
@file{/dev/cdrom} is an alias to the first CDROM.
|
||||
|
||||
Currently there is no specific code to handle removable media, so it
|
||||
is better to use the @code{change} or @code{eject} monitor commands to
|
||||
change or eject media.
|
||||
|
||||
@node disk_images_fat_images
|
||||
@subsection Virtual FAT disk images
|
||||
|
||||
QEMU can automatically create a virtual FAT disk image from a
|
||||
directory tree. In order to use it, just type:
|
||||
|
||||
@example
|
||||
@value{qemu_system} linux.img -hdb fat:/my_directory
|
||||
@end example
|
||||
|
||||
Then you access access to all the files in the @file{/my_directory}
|
||||
directory without having to copy them in a disk image or to export
|
||||
them via SAMBA or NFS. The default access is @emph{read-only}.
|
||||
|
||||
Floppies can be emulated with the @code{:floppy:} option:
|
||||
|
||||
@example
|
||||
@value{qemu_system} linux.img -fda fat:floppy:/my_directory
|
||||
@end example
|
||||
|
||||
A read/write support is available for testing (beta stage) with the
|
||||
@code{:rw:} option:
|
||||
|
||||
@example
|
||||
@value{qemu_system} linux.img -fda fat:floppy:rw:/my_directory
|
||||
@end example
|
||||
|
||||
What you should @emph{never} do:
|
||||
@itemize
|
||||
@item use non-ASCII filenames ;
|
||||
@item use "-snapshot" together with ":rw:" ;
|
||||
@item expect it to work when loadvm'ing ;
|
||||
@item write to the FAT directory on the host system while accessing it with the guest system.
|
||||
@end itemize
|
||||
|
||||
@node disk_images_nbd
|
||||
@subsection NBD access
|
||||
|
||||
QEMU can access directly to block device exported using the Network Block Device
|
||||
protocol.
|
||||
|
||||
@example
|
||||
@value{qemu_system} linux.img -hdb nbd://my_nbd_server.mydomain.org:1024/
|
||||
@end example
|
||||
|
||||
If the NBD server is located on the same host, you can use an unix socket instead
|
||||
of an inet socket:
|
||||
|
||||
@example
|
||||
@value{qemu_system} linux.img -hdb nbd+unix://?socket=/tmp/my_socket
|
||||
@end example
|
||||
|
||||
In this case, the block device must be exported using qemu-nbd:
|
||||
|
||||
@example
|
||||
qemu-nbd --socket=/tmp/my_socket my_disk.qcow2
|
||||
@end example
|
||||
|
||||
The use of qemu-nbd allows sharing of a disk between several guests:
|
||||
@example
|
||||
qemu-nbd --socket=/tmp/my_socket --share=2 my_disk.qcow2
|
||||
@end example
|
||||
|
||||
@noindent
|
||||
and then you can use it with two guests:
|
||||
@example
|
||||
@value{qemu_system} linux1.img -hdb nbd+unix://?socket=/tmp/my_socket
|
||||
@value{qemu_system} linux2.img -hdb nbd+unix://?socket=/tmp/my_socket
|
||||
@end example
|
||||
|
||||
If the nbd-server uses named exports (supported since NBD 2.9.18, or with QEMU's
|
||||
own embedded NBD server), you must specify an export name in the URI:
|
||||
@example
|
||||
@value{qemu_system} -cdrom nbd://localhost/debian-500-ppc-netinst
|
||||
@value{qemu_system} -cdrom nbd://localhost/openSUSE-11.1-ppc-netinst
|
||||
@end example
|
||||
|
||||
The URI syntax for NBD is supported since QEMU 1.3. An alternative syntax is
|
||||
also available. Here are some example of the older syntax:
|
||||
@example
|
||||
@value{qemu_system} linux.img -hdb nbd:my_nbd_server.mydomain.org:1024
|
||||
@value{qemu_system} linux2.img -hdb nbd:unix:/tmp/my_socket
|
||||
@value{qemu_system} -cdrom nbd:localhost:10809:exportname=debian-500-ppc-netinst
|
||||
@end example
|
||||
|
||||
@node disk_images_sheepdog
|
||||
@subsection Sheepdog disk images
|
||||
|
||||
Sheepdog is a distributed storage system for QEMU. It provides highly
|
||||
available block level storage volumes that can be attached to
|
||||
QEMU-based virtual machines.
|
||||
|
||||
You can create a Sheepdog disk image with the command:
|
||||
@example
|
||||
qemu-img create sheepdog:///@var{image} @var{size}
|
||||
@end example
|
||||
where @var{image} is the Sheepdog image name and @var{size} is its
|
||||
size.
|
||||
|
||||
To import the existing @var{filename} to Sheepdog, you can use a
|
||||
convert command.
|
||||
@example
|
||||
qemu-img convert @var{filename} sheepdog:///@var{image}
|
||||
@end example
|
||||
|
||||
You can boot from the Sheepdog disk image with the command:
|
||||
@example
|
||||
@value{qemu_system} sheepdog:///@var{image}
|
||||
@end example
|
||||
|
||||
You can also create a snapshot of the Sheepdog image like qcow2.
|
||||
@example
|
||||
qemu-img snapshot -c @var{tag} sheepdog:///@var{image}
|
||||
@end example
|
||||
where @var{tag} is a tag name of the newly created snapshot.
|
||||
|
||||
To boot from the Sheepdog snapshot, specify the tag name of the
|
||||
snapshot.
|
||||
@example
|
||||
@value{qemu_system} sheepdog:///@var{image}#@var{tag}
|
||||
@end example
|
||||
|
||||
You can create a cloned image from the existing snapshot.
|
||||
@example
|
||||
qemu-img create -b sheepdog:///@var{base}#@var{tag} sheepdog:///@var{image}
|
||||
@end example
|
||||
where @var{base} is an image name of the source snapshot and @var{tag}
|
||||
is its tag name.
|
||||
|
||||
You can use an unix socket instead of an inet socket:
|
||||
|
||||
@example
|
||||
@value{qemu_system} sheepdog+unix:///@var{image}?socket=@var{path}
|
||||
@end example
|
||||
|
||||
If the Sheepdog daemon doesn't run on the local host, you need to
|
||||
specify one of the Sheepdog servers to connect to.
|
||||
@example
|
||||
qemu-img create sheepdog://@var{hostname}:@var{port}/@var{image} @var{size}
|
||||
@value{qemu_system} sheepdog://@var{hostname}:@var{port}/@var{image}
|
||||
@end example
|
||||
|
||||
@node disk_images_iscsi
|
||||
@subsection iSCSI LUNs
|
||||
|
||||
iSCSI is a popular protocol used to access SCSI devices across a computer
|
||||
network.
|
||||
|
||||
There are two different ways iSCSI devices can be used by QEMU.
|
||||
|
||||
The first method is to mount the iSCSI LUN on the host, and make it appear as
|
||||
any other ordinary SCSI device on the host and then to access this device as a
|
||||
/dev/sd device from QEMU. How to do this differs between host OSes.
|
||||
|
||||
The second method involves using the iSCSI initiator that is built into
|
||||
QEMU. This provides a mechanism that works the same way regardless of which
|
||||
host OS you are running QEMU on. This section will describe this second method
|
||||
of using iSCSI together with QEMU.
|
||||
|
||||
In QEMU, iSCSI devices are described using special iSCSI URLs
|
||||
|
||||
@example
|
||||
URL syntax:
|
||||
iscsi://[<username>[%<password>]@@]<host>[:<port>]/<target-iqn-name>/<lun>
|
||||
@end example
|
||||
|
||||
Username and password are optional and only used if your target is set up
|
||||
using CHAP authentication for access control.
|
||||
Alternatively the username and password can also be set via environment
|
||||
variables to have these not show up in the process list
|
||||
|
||||
@example
|
||||
export LIBISCSI_CHAP_USERNAME=<username>
|
||||
export LIBISCSI_CHAP_PASSWORD=<password>
|
||||
iscsi://<host>/<target-iqn-name>/<lun>
|
||||
@end example
|
||||
|
||||
Various session related parameters can be set via special options, either
|
||||
in a configuration file provided via '-readconfig' or directly on the
|
||||
command line.
|
||||
|
||||
If the initiator-name is not specified qemu will use a default name
|
||||
of 'iqn.2008-11.org.linux-kvm[:<uuid>'] where <uuid> is the UUID of the
|
||||
virtual machine. If the UUID is not specified qemu will use
|
||||
'iqn.2008-11.org.linux-kvm[:<name>'] where <name> is the name of the
|
||||
virtual machine.
|
||||
|
||||
@example
|
||||
Setting a specific initiator name to use when logging in to the target
|
||||
-iscsi initiator-name=iqn.qemu.test:my-initiator
|
||||
@end example
|
||||
|
||||
@example
|
||||
Controlling which type of header digest to negotiate with the target
|
||||
-iscsi header-digest=CRC32C|CRC32C-NONE|NONE-CRC32C|NONE
|
||||
@end example
|
||||
|
||||
These can also be set via a configuration file
|
||||
@example
|
||||
[iscsi]
|
||||
user = "CHAP username"
|
||||
password = "CHAP password"
|
||||
initiator-name = "iqn.qemu.test:my-initiator"
|
||||
# header digest is one of CRC32C|CRC32C-NONE|NONE-CRC32C|NONE
|
||||
header-digest = "CRC32C"
|
||||
@end example
|
||||
|
||||
|
||||
Setting the target name allows different options for different targets
|
||||
@example
|
||||
[iscsi "iqn.target.name"]
|
||||
user = "CHAP username"
|
||||
password = "CHAP password"
|
||||
initiator-name = "iqn.qemu.test:my-initiator"
|
||||
# header digest is one of CRC32C|CRC32C-NONE|NONE-CRC32C|NONE
|
||||
header-digest = "CRC32C"
|
||||
@end example
|
||||
|
||||
|
||||
Howto use a configuration file to set iSCSI configuration options:
|
||||
@example
|
||||
cat >iscsi.conf <<EOF
|
||||
[iscsi]
|
||||
user = "me"
|
||||
password = "my password"
|
||||
initiator-name = "iqn.qemu.test:my-initiator"
|
||||
header-digest = "CRC32C"
|
||||
EOF
|
||||
|
||||
@value{qemu_system} -drive file=iscsi://127.0.0.1/iqn.qemu.test/1 \
|
||||
-readconfig iscsi.conf
|
||||
@end example
|
||||
|
||||
|
||||
How to set up a simple iSCSI target on loopback and access it via QEMU:
|
||||
@example
|
||||
This example shows how to set up an iSCSI target with one CDROM and one DISK
|
||||
using the Linux STGT software target. This target is available on Red Hat based
|
||||
systems as the package 'scsi-target-utils'.
|
||||
|
||||
tgtd --iscsi portal=127.0.0.1:3260
|
||||
tgtadm --lld iscsi --op new --mode target --tid 1 -T iqn.qemu.test
|
||||
tgtadm --lld iscsi --mode logicalunit --op new --tid 1 --lun 1 \
|
||||
-b /IMAGES/disk.img --device-type=disk
|
||||
tgtadm --lld iscsi --mode logicalunit --op new --tid 1 --lun 2 \
|
||||
-b /IMAGES/cd.iso --device-type=cd
|
||||
tgtadm --lld iscsi --op bind --mode target --tid 1 -I ALL
|
||||
|
||||
@value{qemu_system} -iscsi initiator-name=iqn.qemu.test:my-initiator \
|
||||
-boot d -drive file=iscsi://127.0.0.1/iqn.qemu.test/1 \
|
||||
-cdrom iscsi://127.0.0.1/iqn.qemu.test/2
|
||||
@end example
|
||||
|
||||
@node disk_images_gluster
|
||||
@subsection GlusterFS disk images
|
||||
|
||||
GlusterFS is a user space distributed file system.
|
||||
|
||||
You can boot from the GlusterFS disk image with the command:
|
||||
@example
|
||||
URI:
|
||||
@value{qemu_system} -drive file=gluster[+@var{type}]://[@var{host}[:@var{port}]]/@var{volume}/@var{path}
|
||||
[?socket=...][,file.debug=9][,file.logfile=...]
|
||||
|
||||
JSON:
|
||||
@value{qemu_system} 'json:@{"driver":"qcow2",
|
||||
"file":@{"driver":"gluster",
|
||||
"volume":"testvol","path":"a.img","debug":9,"logfile":"...",
|
||||
"server":[@{"type":"tcp","host":"...","port":"..."@},
|
||||
@{"type":"unix","socket":"..."@}]@}@}'
|
||||
@end example
|
||||
|
||||
@var{gluster} is the protocol.
|
||||
|
||||
@var{type} specifies the transport type used to connect to gluster
|
||||
management daemon (glusterd). Valid transport types are
|
||||
tcp and unix. In the URI form, if a transport type isn't specified,
|
||||
then tcp type is assumed.
|
||||
|
||||
@var{host} specifies the server where the volume file specification for
|
||||
the given volume resides. This can be either a hostname or an ipv4 address.
|
||||
If transport type is unix, then @var{host} field should not be specified.
|
||||
Instead @var{socket} field needs to be populated with the path to unix domain
|
||||
socket.
|
||||
|
||||
@var{port} is the port number on which glusterd is listening. This is optional
|
||||
and if not specified, it defaults to port 24007. If the transport type is unix,
|
||||
then @var{port} should not be specified.
|
||||
|
||||
@var{volume} is the name of the gluster volume which contains the disk image.
|
||||
|
||||
@var{path} is the path to the actual disk image that resides on gluster volume.
|
||||
|
||||
@var{debug} is the logging level of the gluster protocol driver. Debug levels
|
||||
are 0-9, with 9 being the most verbose, and 0 representing no debugging output.
|
||||
The default level is 4. The current logging levels defined in the gluster source
|
||||
are 0 - None, 1 - Emergency, 2 - Alert, 3 - Critical, 4 - Error, 5 - Warning,
|
||||
6 - Notice, 7 - Info, 8 - Debug, 9 - Trace
|
||||
|
||||
@var{logfile} is a commandline option to mention log file path which helps in
|
||||
logging to the specified file and also help in persisting the gfapi logs. The
|
||||
default is stderr.
|
||||
|
||||
|
||||
|
||||
|
||||
You can create a GlusterFS disk image with the command:
|
||||
@example
|
||||
qemu-img create gluster://@var{host}/@var{volume}/@var{path} @var{size}
|
||||
@end example
|
||||
|
||||
Examples
|
||||
@example
|
||||
@value{qemu_system} -drive file=gluster://1.2.3.4/testvol/a.img
|
||||
@value{qemu_system} -drive file=gluster+tcp://1.2.3.4/testvol/a.img
|
||||
@value{qemu_system} -drive file=gluster+tcp://1.2.3.4:24007/testvol/dir/a.img
|
||||
@value{qemu_system} -drive file=gluster+tcp://[1:2:3:4:5:6:7:8]/testvol/dir/a.img
|
||||
@value{qemu_system} -drive file=gluster+tcp://[1:2:3:4:5:6:7:8]:24007/testvol/dir/a.img
|
||||
@value{qemu_system} -drive file=gluster+tcp://server.domain.com:24007/testvol/dir/a.img
|
||||
@value{qemu_system} -drive file=gluster+unix:///testvol/dir/a.img?socket=/tmp/glusterd.socket
|
||||
@value{qemu_system} -drive file=gluster+rdma://1.2.3.4:24007/testvol/a.img
|
||||
@value{qemu_system} -drive file=gluster://1.2.3.4/testvol/a.img,file.debug=9,file.logfile=/var/log/qemu-gluster.log
|
||||
@value{qemu_system} 'json:@{"driver":"qcow2",
|
||||
"file":@{"driver":"gluster",
|
||||
"volume":"testvol","path":"a.img",
|
||||
"debug":9,"logfile":"/var/log/qemu-gluster.log",
|
||||
"server":[@{"type":"tcp","host":"1.2.3.4","port":24007@},
|
||||
@{"type":"unix","socket":"/var/run/glusterd.socket"@}]@}@}'
|
||||
@value{qemu_system} -drive driver=qcow2,file.driver=gluster,file.volume=testvol,file.path=/path/a.img,
|
||||
file.debug=9,file.logfile=/var/log/qemu-gluster.log,
|
||||
file.server.0.type=tcp,file.server.0.host=1.2.3.4,file.server.0.port=24007,
|
||||
file.server.1.type=unix,file.server.1.socket=/var/run/glusterd.socket
|
||||
@end example
|
||||
|
||||
@node disk_images_ssh
|
||||
@subsection Secure Shell (ssh) disk images
|
||||
|
||||
You can access disk images located on a remote ssh server
|
||||
by using the ssh protocol:
|
||||
|
||||
@example
|
||||
@value{qemu_system} -drive file=ssh://[@var{user}@@]@var{server}[:@var{port}]/@var{path}[?host_key_check=@var{host_key_check}]
|
||||
@end example
|
||||
|
||||
Alternative syntax using properties:
|
||||
|
||||
@example
|
||||
@value{qemu_system} -drive file.driver=ssh[,file.user=@var{user}],file.host=@var{server}[,file.port=@var{port}],file.path=@var{path}[,file.host_key_check=@var{host_key_check}]
|
||||
@end example
|
||||
|
||||
@var{ssh} is the protocol.
|
||||
|
||||
@var{user} is the remote user. If not specified, then the local
|
||||
username is tried.
|
||||
|
||||
@var{server} specifies the remote ssh server. Any ssh server can be
|
||||
used, but it must implement the sftp-server protocol. Most Unix/Linux
|
||||
systems should work without requiring any extra configuration.
|
||||
|
||||
@var{port} is the port number on which sshd is listening. By default
|
||||
the standard ssh port (22) is used.
|
||||
|
||||
@var{path} is the path to the disk image.
|
||||
|
||||
The optional @var{host_key_check} parameter controls how the remote
|
||||
host's key is checked. The default is @code{yes} which means to use
|
||||
the local @file{.ssh/known_hosts} file. Setting this to @code{no}
|
||||
turns off known-hosts checking. Or you can check that the host key
|
||||
matches a specific fingerprint:
|
||||
@code{host_key_check=md5:78:45:8e:14:57:4f:d5:45:83:0a:0e:f3:49:82:c9:c8}
|
||||
(@code{sha1:} can also be used as a prefix, but note that OpenSSH
|
||||
tools only use MD5 to print fingerprints).
|
||||
|
||||
Currently authentication must be done using ssh-agent. Other
|
||||
authentication methods may be supported in future.
|
||||
|
||||
Note: Many ssh servers do not support an @code{fsync}-style operation.
|
||||
The ssh driver cannot guarantee that disk flush requests are
|
||||
obeyed, and this causes a risk of disk corruption if the remote
|
||||
server or network goes down during writes. The driver will
|
||||
print a warning when @code{fsync} is not supported:
|
||||
|
||||
warning: ssh server @code{ssh.example.com:22} does not support fsync
|
||||
|
||||
With sufficiently new versions of libssh and OpenSSH, @code{fsync} is
|
||||
supported.
|
||||
|
||||
@node disk_images_nvme
|
||||
@subsection NVMe disk images
|
||||
|
||||
NVM Express (NVMe) storage controllers can be accessed directly by a userspace
|
||||
driver in QEMU. This bypasses the host kernel file system and block layers
|
||||
while retaining QEMU block layer functionalities, such as block jobs, I/O
|
||||
throttling, image formats, etc. Disk I/O performance is typically higher than
|
||||
with @code{-drive file=/dev/sda} using either thread pool or linux-aio.
|
||||
|
||||
The controller will be exclusively used by the QEMU process once started. To be
|
||||
able to share storage between multiple VMs and other applications on the host,
|
||||
please use the file based protocols.
|
||||
|
||||
Before starting QEMU, bind the host NVMe controller to the host vfio-pci
|
||||
driver. For example:
|
||||
|
||||
@example
|
||||
# modprobe vfio-pci
|
||||
# lspci -n -s 0000:06:0d.0
|
||||
06:0d.0 0401: 1102:0002 (rev 08)
|
||||
# echo 0000:06:0d.0 > /sys/bus/pci/devices/0000:06:0d.0/driver/unbind
|
||||
# echo 1102 0002 > /sys/bus/pci/drivers/vfio-pci/new_id
|
||||
|
||||
# @value{qemu_system} -drive file=nvme://@var{host}:@var{bus}:@var{slot}.@var{func}/@var{namespace}
|
||||
@end example
|
||||
|
||||
Alternative syntax using properties:
|
||||
|
||||
@example
|
||||
@value{qemu_system} -drive file.driver=nvme,file.device=@var{host}:@var{bus}:@var{slot}.@var{func},file.namespace=@var{namespace}
|
||||
@end example
|
||||
|
||||
@var{host}:@var{bus}:@var{slot}.@var{func} is the NVMe controller's PCI device
|
||||
address on the host.
|
||||
|
||||
@var{namespace} is the NVMe namespace number, starting from 1.
|
||||
|
||||
@node disk_image_locking
|
||||
@subsection Disk image file locking
|
||||
|
||||
By default, QEMU tries to protect image files from unexpected concurrent
|
||||
access, as long as it's supported by the block protocol driver and host
|
||||
operating system. If multiple QEMU processes (including QEMU emulators and
|
||||
utilities) try to open the same image with conflicting accessing modes, all but
|
||||
the first one will get an error.
|
||||
|
||||
This feature is currently supported by the file protocol on Linux with the Open
|
||||
File Descriptor (OFD) locking API, and can be configured to fall back to POSIX
|
||||
locking if the POSIX host doesn't support Linux OFD locking.
|
||||
|
||||
To explicitly enable image locking, specify "locking=on" in the file protocol
|
||||
driver options. If OFD locking is not possible, a warning will be printed and
|
||||
the POSIX locking API will be used. In this case there is a risk that the lock
|
||||
will get silently lost when doing hot plugging and block jobs, due to the
|
||||
shortcomings of the POSIX locking API.
|
||||
|
||||
QEMU transparently handles lock handover during shared storage migration. For
|
||||
shared virtual disk images between multiple VMs, the "share-rw" device option
|
||||
should be used.
|
||||
|
||||
By default, the guest has exclusive write access to its disk image. If the
|
||||
guest can safely share the disk image with other writers the @code{-device
|
||||
...,share-rw=on} parameter can be used. This is only safe if the guest is
|
||||
running software, such as a cluster file system, that coordinates disk accesses
|
||||
to avoid corruption.
|
||||
|
||||
Note that share-rw=on only declares the guest's ability to share the disk.
|
||||
Some QEMU features, such as image file formats, require exclusive write access
|
||||
to the disk image and this is unaffected by the share-rw=on option.
|
||||
|
||||
Alternatively, locking can be fully disabled by "locking=off" block device
|
||||
option. In the command line, the option is usually in the form of
|
||||
"file.locking=off" as the protocol driver is normally placed as a "file" child
|
||||
under a format driver. For example:
|
||||
|
||||
@code{-blockdev driver=qcow2,file.filename=/path/to/image,file.locking=off,file.driver=file}
|
||||
|
||||
To check if image locking is active, check the output of the "lslocks" command
|
||||
on host and see if there are locks held by the QEMU process on the image file.
|
||||
More than one byte could be locked by the QEMU instance, each byte of which
|
||||
reflects a particular permission that is acquired or protected by the running
|
||||
block driver.
|
||||
|
||||
@c man end
|
||||
|
||||
@ignore
|
||||
|
||||
@setfilename qemu-block-drivers
|
||||
@settitle QEMU block drivers reference
|
||||
|
||||
@c man begin SEEALSO
|
||||
The HTML documentation of QEMU for more precise information and Linux
|
||||
user mode emulator invocation.
|
||||
@c man end
|
||||
|
||||
@c man begin AUTHOR
|
||||
Fabrice Bellard and the QEMU Project developers
|
||||
@c man end
|
||||
|
||||
@end ignore
|
|
@ -0,0 +1,22 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# QEMU documentation build configuration file for the 'system' manual.
|
||||
#
|
||||
# This includes the top level conf file and then makes any necessary tweaks.
|
||||
import sys
|
||||
import os
|
||||
|
||||
qemu_docdir = os.path.abspath("..")
|
||||
parent_config = os.path.join(qemu_docdir, "conf.py")
|
||||
exec(compile(open(parent_config, "rb").read(), parent_config, 'exec'))
|
||||
|
||||
# This slightly misuses the 'description', but is the best way to get
|
||||
# the manual title to appear in the sidebar.
|
||||
html_theme_options['description'] = u'System Emulation User''s Guide'
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('qemu-block-drivers', 'qemu-block-drivers',
|
||||
u'QEMU block drivers reference',
|
||||
['Fabrice Bellard and the QEMU Project developers'], 7)
|
||||
]
|
|
@ -0,0 +1,17 @@
|
|||
.. This is the top level page for the 'system' manual.
|
||||
|
||||
|
||||
QEMU System Emulation User's Guide
|
||||
==================================
|
||||
|
||||
This manual is the overall guide for users using QEMU
|
||||
for full system emulation (as opposed to user-mode emulation).
|
||||
This includes working with hypervisors such as KVM, Xen, Hax
|
||||
or Hypervisor.Framework.
|
||||
|
||||
Contents:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
qemu-block-drivers
|
|
@ -0,0 +1,985 @@
|
|||
QEMU block drivers reference
|
||||
============================
|
||||
|
||||
.. |qemu_system| replace:: qemu-system-x86_64
|
||||
|
||||
..
|
||||
We put the 'Synopsis' and 'See also' sections into the manpage, but not
|
||||
the HTML. This makes the HTML docs read better and means the ToC in
|
||||
the index has a more useful set of entries. Ideally, the section
|
||||
headings 'Disk image file formats' would be top-level headings for
|
||||
the HTML, but sub-headings of the conventional manpage 'Description'
|
||||
header for the manpage. Unfortunately, due to deficiencies in
|
||||
the Sphinx 'only' directive, this isn't possible: they must be headers
|
||||
at the same level as 'Synopsis' and 'See also', otherwise Sphinx's
|
||||
identification of which header underline style is which gets confused.
|
||||
|
||||
.. only:: man
|
||||
|
||||
Synopsis
|
||||
--------
|
||||
|
||||
QEMU block driver reference manual
|
||||
|
||||
Disk image file formats
|
||||
-----------------------
|
||||
|
||||
QEMU supports many image file formats that can be used with VMs as well as with
|
||||
any of the tools (like ``qemu-img``). This includes the preferred formats
|
||||
raw and qcow2 as well as formats that are supported for compatibility with
|
||||
older QEMU versions or other hypervisors.
|
||||
|
||||
Depending on the image format, different options can be passed to
|
||||
``qemu-img create`` and ``qemu-img convert`` using the ``-o`` option.
|
||||
This section describes each format and the options that are supported for it.
|
||||
|
||||
.. program:: image-formats
|
||||
.. option:: raw
|
||||
|
||||
Raw disk image format. This format has the advantage of
|
||||
being simple and easily exportable to all other emulators. If your
|
||||
file system supports *holes* (for example in ext2 or ext3 on
|
||||
Linux or NTFS on Windows), then only the written sectors will reserve
|
||||
space. Use ``qemu-img info`` to know the real size used by the
|
||||
image or ``ls -ls`` on Unix/Linux.
|
||||
|
||||
Supported options:
|
||||
|
||||
.. program:: raw
|
||||
.. option:: preallocation
|
||||
|
||||
Preallocation mode (allowed values: ``off``, ``falloc``,
|
||||
``full``). ``falloc`` mode preallocates space for image by
|
||||
calling ``posix_fallocate()``. ``full`` mode preallocates space
|
||||
for image by writing data to underlying storage. This data may or
|
||||
may not be zero, depending on the storage location.
|
||||
|
||||
.. program:: image-formats
|
||||
.. option:: qcow2
|
||||
|
||||
QEMU image format, the most versatile format. Use it to have smaller
|
||||
images (useful if your filesystem does not supports holes, for example
|
||||
on Windows), zlib based compression and support of multiple VM
|
||||
snapshots.
|
||||
|
||||
Supported options:
|
||||
|
||||
.. program:: qcow2
|
||||
.. option:: compat
|
||||
|
||||
Determines the qcow2 version to use. ``compat=0.10`` uses the
|
||||
traditional image format that can be read by any QEMU since 0.10.
|
||||
``compat=1.1`` enables image format extensions that only QEMU 1.1 and
|
||||
newer understand (this is the default). Amongst others, this includes
|
||||
zero clusters, which allow efficient copy-on-read for sparse images.
|
||||
|
||||
.. option:: backing_file
|
||||
|
||||
File name of a base image (see ``create`` subcommand)
|
||||
|
||||
.. option:: backing_fmt
|
||||
|
||||
Image format of the base image
|
||||
|
||||
.. option:: encryption
|
||||
|
||||
This option is deprecated and equivalent to ``encrypt.format=aes``
|
||||
|
||||
.. option:: encrypt.format
|
||||
|
||||
If this is set to ``luks``, it requests that the qcow2 payload (not
|
||||
qcow2 header) be encrypted using the LUKS format. The passphrase to
|
||||
use to unlock the LUKS key slot is given by the ``encrypt.key-secret``
|
||||
parameter. LUKS encryption parameters can be tuned with the other
|
||||
``encrypt.*`` parameters.
|
||||
|
||||
If this is set to ``aes``, the image is encrypted with 128-bit AES-CBC.
|
||||
The encryption key is given by the ``encrypt.key-secret`` parameter.
|
||||
This encryption format is considered to be flawed by modern cryptography
|
||||
standards, suffering from a number of design problems:
|
||||
|
||||
- The AES-CBC cipher is used with predictable initialization vectors based
|
||||
on the sector number. This makes it vulnerable to chosen plaintext attacks
|
||||
which can reveal the existence of encrypted data.
|
||||
- The user passphrase is directly used as the encryption key. A poorly
|
||||
chosen or short passphrase will compromise the security of the encryption.
|
||||
- In the event of the passphrase being compromised there is no way to
|
||||
change the passphrase to protect data in any qcow images. The files must
|
||||
be cloned, using a different encryption passphrase in the new file. The
|
||||
original file must then be securely erased using a program like shred,
|
||||
though even this is ineffective with many modern storage technologies.
|
||||
|
||||
The use of this is no longer supported in system emulators. Support only
|
||||
remains in the command line utilities, for the purposes of data liberation
|
||||
and interoperability with old versions of QEMU. The ``luks`` format
|
||||
should be used instead.
|
||||
|
||||
.. option:: encrypt.key-secret
|
||||
|
||||
Provides the ID of a ``secret`` object that contains the passphrase
|
||||
(``encrypt.format=luks``) or encryption key (``encrypt.format=aes``).
|
||||
|
||||
.. option:: encrypt.cipher-alg
|
||||
|
||||
Name of the cipher algorithm and key length. Currently defaults
|
||||
to ``aes-256``. Only used when ``encrypt.format=luks``.
|
||||
|
||||
.. option:: encrypt.cipher-mode
|
||||
|
||||
Name of the encryption mode to use. Currently defaults to ``xts``.
|
||||
Only used when ``encrypt.format=luks``.
|
||||
|
||||
.. option:: encrypt.ivgen-alg
|
||||
|
||||
Name of the initialization vector generator algorithm. Currently defaults
|
||||
to ``plain64``. Only used when ``encrypt.format=luks``.
|
||||
|
||||
.. option:: encrypt.ivgen-hash-alg
|
||||
|
||||
Name of the hash algorithm to use with the initialization vector generator
|
||||
(if required). Defaults to ``sha256``. Only used when ``encrypt.format=luks``.
|
||||
|
||||
.. option:: encrypt.hash-alg
|
||||
|
||||
Name of the hash algorithm to use for PBKDF algorithm
|
||||
Defaults to ``sha256``. Only used when ``encrypt.format=luks``.
|
||||
|
||||
.. option:: encrypt.iter-time
|
||||
|
||||
Amount of time, in milliseconds, to use for PBKDF algorithm per key slot.
|
||||
Defaults to ``2000``. Only used when ``encrypt.format=luks``.
|
||||
|
||||
.. option:: cluster_size
|
||||
|
||||
Changes the qcow2 cluster size (must be between 512 and 2M). Smaller cluster
|
||||
sizes can improve the image file size whereas larger cluster sizes generally
|
||||
provide better performance.
|
||||
|
||||
.. option:: preallocation
|
||||
|
||||
Preallocation mode (allowed values: ``off``, ``metadata``, ``falloc``,
|
||||
``full``). An image with preallocated metadata is initially larger but can
|
||||
improve performance when the image needs to grow. ``falloc`` and ``full``
|
||||
preallocations are like the same options of ``raw`` format, but sets up
|
||||
metadata also.
|
||||
|
||||
.. option:: lazy_refcounts
|
||||
|
||||
If this option is set to ``on``, reference count updates are postponed with
|
||||
the goal of avoiding metadata I/O and improving performance. This is
|
||||
particularly interesting with :option:`cache=writethrough` which doesn't batch
|
||||
metadata updates. The tradeoff is that after a host crash, the reference count
|
||||
tables must be rebuilt, i.e. on the next open an (automatic) ``qemu-img
|
||||
check -r all`` is required, which may take some time.
|
||||
|
||||
This option can only be enabled if ``compat=1.1`` is specified.
|
||||
|
||||
.. option:: nocow
|
||||
|
||||
If this option is set to ``on``, it will turn off COW of the file. It's only
|
||||
valid on btrfs, no effect on other file systems.
|
||||
|
||||
Btrfs has low performance when hosting a VM image file, even more
|
||||
when the guest on the VM also using btrfs as file system. Turning off
|
||||
COW is a way to mitigate this bad performance. Generally there are two
|
||||
ways to turn off COW on btrfs:
|
||||
|
||||
- Disable it by mounting with nodatacow, then all newly created files
|
||||
will be NOCOW.
|
||||
- For an empty file, add the NOCOW file attribute. That's what this
|
||||
option does.
|
||||
|
||||
Note: this option is only valid to new or empty files. If there is
|
||||
an existing file which is COW and has data blocks already, it couldn't
|
||||
be changed to NOCOW by setting ``nocow=on``. One can issue ``lsattr
|
||||
filename`` to check if the NOCOW flag is set or not (Capital 'C' is
|
||||
NOCOW flag).
|
||||
|
||||
.. program:: image-formats
|
||||
.. option:: qed
|
||||
|
||||
Old QEMU image format with support for backing files and compact image files
|
||||
(when your filesystem or transport medium does not support holes).
|
||||
|
||||
When converting QED images to qcow2, you might want to consider using the
|
||||
``lazy_refcounts=on`` option to get a more QED-like behaviour.
|
||||
|
||||
Supported options:
|
||||
|
||||
.. program:: qed
|
||||
.. option:: backing_file
|
||||
|
||||
File name of a base image (see ``create`` subcommand).
|
||||
|
||||
.. option:: backing_fmt
|
||||
|
||||
Image file format of backing file (optional). Useful if the format cannot be
|
||||
autodetected because it has no header, like some vhd/vpc files.
|
||||
|
||||
.. option:: cluster_size
|
||||
|
||||
Changes the cluster size (must be power-of-2 between 4K and 64K). Smaller
|
||||
cluster sizes can improve the image file size whereas larger cluster sizes
|
||||
generally provide better performance.
|
||||
|
||||
.. option:: table_size
|
||||
|
||||
Changes the number of clusters per L1/L2 table (must be
|
||||
power-of-2 between 1 and 16). There is normally no need to
|
||||
change this value but this option can between used for
|
||||
performance benchmarking.
|
||||
|
||||
.. program:: image-formats
|
||||
.. option:: qcow
|
||||
|
||||
Old QEMU image format with support for backing files, compact image files,
|
||||
encryption and compression.
|
||||
|
||||
Supported options:
|
||||
|
||||
.. program:: qcow
|
||||
.. option:: backing_file
|
||||
|
||||
File name of a base image (see ``create`` subcommand)
|
||||
|
||||
.. option:: encryption
|
||||
|
||||
This option is deprecated and equivalent to ``encrypt.format=aes``
|
||||
|
||||
.. option:: encrypt.format
|
||||
|
||||
If this is set to ``aes``, the image is encrypted with 128-bit AES-CBC.
|
||||
The encryption key is given by the ``encrypt.key-secret`` parameter.
|
||||
This encryption format is considered to be flawed by modern cryptography
|
||||
standards, suffering from a number of design problems enumerated previously
|
||||
against the ``qcow2`` image format.
|
||||
|
||||
The use of this is no longer supported in system emulators. Support only
|
||||
remains in the command line utilities, for the purposes of data liberation
|
||||
and interoperability with old versions of QEMU.
|
||||
|
||||
Users requiring native encryption should use the ``qcow2`` format
|
||||
instead with ``encrypt.format=luks``.
|
||||
|
||||
.. option:: encrypt.key-secret
|
||||
|
||||
Provides the ID of a ``secret`` object that contains the encryption
|
||||
key (``encrypt.format=aes``).
|
||||
|
||||
.. program:: image-formats
|
||||
.. option:: luks
|
||||
|
||||
LUKS v1 encryption format, compatible with Linux dm-crypt/cryptsetup
|
||||
|
||||
Supported options:
|
||||
|
||||
.. program:: luks
|
||||
.. option:: key-secret
|
||||
|
||||
Provides the ID of a ``secret`` object that contains the passphrase.
|
||||
|
||||
.. option:: cipher-alg
|
||||
|
||||
Name of the cipher algorithm and key length. Currently defaults
|
||||
to ``aes-256``.
|
||||
|
||||
.. option:: cipher-mode
|
||||
|
||||
Name of the encryption mode to use. Currently defaults to ``xts``.
|
||||
|
||||
.. option:: ivgen-alg
|
||||
|
||||
Name of the initialization vector generator algorithm. Currently defaults
|
||||
to ``plain64``.
|
||||
|
||||
.. option:: ivgen-hash-alg
|
||||
|
||||
Name of the hash algorithm to use with the initialization vector generator
|
||||
(if required). Defaults to ``sha256``.
|
||||
|
||||
.. option:: hash-alg
|
||||
|
||||
Name of the hash algorithm to use for PBKDF algorithm
|
||||
Defaults to ``sha256``.
|
||||
|
||||
.. option:: iter-time
|
||||
|
||||
Amount of time, in milliseconds, to use for PBKDF algorithm per key slot.
|
||||
Defaults to ``2000``.
|
||||
|
||||
.. program:: image-formats
|
||||
.. option:: vdi
|
||||
|
||||
VirtualBox 1.1 compatible image format.
|
||||
|
||||
Supported options:
|
||||
|
||||
.. program:: vdi
|
||||
.. option:: static
|
||||
|
||||
If this option is set to ``on``, the image is created with metadata
|
||||
preallocation.
|
||||
|
||||
.. program:: image-formats
|
||||
.. option:: vmdk
|
||||
|
||||
VMware 3 and 4 compatible image format.
|
||||
|
||||
Supported options:
|
||||
|
||||
.. program: vmdk
|
||||
.. option:: backing_file
|
||||
|
||||
File name of a base image (see ``create`` subcommand).
|
||||
|
||||
.. option:: compat6
|
||||
|
||||
Create a VMDK version 6 image (instead of version 4)
|
||||
|
||||
.. option:: hwversion
|
||||
|
||||
Specify vmdk virtual hardware version. Compat6 flag cannot be enabled
|
||||
if hwversion is specified.
|
||||
|
||||
.. option:: subformat
|
||||
|
||||
Specifies which VMDK subformat to use. Valid options are
|
||||
``monolithicSparse`` (default),
|
||||
``monolithicFlat``,
|
||||
``twoGbMaxExtentSparse``,
|
||||
``twoGbMaxExtentFlat`` and
|
||||
``streamOptimized``.
|
||||
|
||||
.. program:: image-formats
|
||||
.. option:: vpc
|
||||
|
||||
VirtualPC compatible image format (VHD).
|
||||
|
||||
Supported options:
|
||||
|
||||
.. program:: vpc
|
||||
.. option:: subformat
|
||||
|
||||
Specifies which VHD subformat to use. Valid options are
|
||||
``dynamic`` (default) and ``fixed``.
|
||||
|
||||
.. program:: image-formats
|
||||
.. option:: VHDX
|
||||
|
||||
Hyper-V compatible image format (VHDX).
|
||||
|
||||
Supported options:
|
||||
|
||||
.. program:: VHDX
|
||||
.. option:: subformat
|
||||
|
||||
Specifies which VHDX subformat to use. Valid options are
|
||||
``dynamic`` (default) and ``fixed``.
|
||||
|
||||
.. option:: block_state_zero
|
||||
|
||||
Force use of payload blocks of type 'ZERO'. Can be set to ``on`` (default)
|
||||
or ``off``. When set to ``off``, new blocks will be created as
|
||||
``PAYLOAD_BLOCK_NOT_PRESENT``, which means parsers are free to return
|
||||
arbitrary data for those blocks. Do not set to ``off`` when using
|
||||
``qemu-img convert`` with ``subformat=dynamic``.
|
||||
|
||||
.. option:: block_size
|
||||
|
||||
Block size; min 1 MB, max 256 MB. 0 means auto-calculate based on
|
||||
image size.
|
||||
|
||||
.. option:: log_size
|
||||
|
||||
Log size; min 1 MB.
|
||||
|
||||
Read-only formats
|
||||
-----------------
|
||||
|
||||
More disk image file formats are supported in a read-only mode.
|
||||
|
||||
.. program:: image-formats
|
||||
.. option:: bochs
|
||||
|
||||
Bochs images of ``growing`` type.
|
||||
|
||||
.. program:: image-formats
|
||||
.. option:: cloop
|
||||
|
||||
Linux Compressed Loop image, useful only to reuse directly compressed
|
||||
CD-ROM images present for example in the Knoppix CD-ROMs.
|
||||
|
||||
.. program:: image-formats
|
||||
.. option:: dmg
|
||||
|
||||
Apple disk image.
|
||||
|
||||
.. program:: image-formats
|
||||
.. option:: parallels
|
||||
|
||||
Parallels disk image format.
|
||||
|
||||
Using host drives
|
||||
-----------------
|
||||
|
||||
In addition to disk image files, QEMU can directly access host
|
||||
devices. We describe here the usage for QEMU version >= 0.8.3.
|
||||
|
||||
Linux
|
||||
'''''
|
||||
|
||||
On Linux, you can directly use the host device filename instead of a
|
||||
disk image filename provided you have enough privileges to access
|
||||
it. For example, use ``/dev/cdrom`` to access to the CDROM.
|
||||
|
||||
CD
|
||||
You can specify a CDROM device even if no CDROM is loaded. QEMU has
|
||||
specific code to detect CDROM insertion or removal. CDROM ejection by
|
||||
the guest OS is supported. Currently only data CDs are supported.
|
||||
|
||||
Floppy
|
||||
You can specify a floppy device even if no floppy is loaded. Floppy
|
||||
removal is currently not detected accurately (if you change floppy
|
||||
without doing floppy access while the floppy is not loaded, the guest
|
||||
OS will think that the same floppy is loaded).
|
||||
Use of the host's floppy device is deprecated, and support for it will
|
||||
be removed in a future release.
|
||||
|
||||
Hard disks
|
||||
Hard disks can be used. Normally you must specify the whole disk
|
||||
(``/dev/hdb`` instead of ``/dev/hdb1``) so that the guest OS can
|
||||
see it as a partitioned disk. WARNING: unless you know what you do, it
|
||||
is better to only make READ-ONLY accesses to the hard disk otherwise
|
||||
you may corrupt your host data (use the ``-snapshot`` command
|
||||
line option or modify the device permissions accordingly).
|
||||
|
||||
Windows
|
||||
'''''''
|
||||
|
||||
CD
|
||||
The preferred syntax is the drive letter (e.g. ``d:``). The
|
||||
alternate syntax ``\\.\d:`` is supported. ``/dev/cdrom`` is
|
||||
supported as an alias to the first CDROM drive.
|
||||
|
||||
Currently there is no specific code to handle removable media, so it
|
||||
is better to use the ``change`` or ``eject`` monitor commands to
|
||||
change or eject media.
|
||||
|
||||
Hard disks
|
||||
Hard disks can be used with the syntax: ``\\.\PhysicalDriveN``
|
||||
where *N* is the drive number (0 is the first hard disk).
|
||||
|
||||
WARNING: unless you know what you do, it is better to only make
|
||||
READ-ONLY accesses to the hard disk otherwise you may corrupt your
|
||||
host data (use the ``-snapshot`` command line so that the
|
||||
modifications are written in a temporary file).
|
||||
|
||||
Mac OS X
|
||||
''''''''
|
||||
|
||||
``/dev/cdrom`` is an alias to the first CDROM.
|
||||
|
||||
Currently there is no specific code to handle removable media, so it
|
||||
is better to use the ``change`` or ``eject`` monitor commands to
|
||||
change or eject media.
|
||||
|
||||
Virtual FAT disk images
|
||||
-----------------------
|
||||
|
||||
QEMU can automatically create a virtual FAT disk image from a
|
||||
directory tree. In order to use it, just type:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
|qemu_system| linux.img -hdb fat:/my_directory
|
||||
|
||||
Then you access access to all the files in the ``/my_directory``
|
||||
directory without having to copy them in a disk image or to export
|
||||
them via SAMBA or NFS. The default access is *read-only*.
|
||||
|
||||
Floppies can be emulated with the ``:floppy:`` option:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
|qemu_system| linux.img -fda fat:floppy:/my_directory
|
||||
|
||||
A read/write support is available for testing (beta stage) with the
|
||||
``:rw:`` option:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
|qemu_system| linux.img -fda fat:floppy:rw:/my_directory
|
||||
|
||||
What you should *never* do:
|
||||
|
||||
- use non-ASCII filenames
|
||||
- use "-snapshot" together with ":rw:"
|
||||
- expect it to work when loadvm'ing
|
||||
- write to the FAT directory on the host system while accessing it with the guest system
|
||||
|
||||
NBD access
|
||||
----------
|
||||
|
||||
QEMU can access directly to block device exported using the Network Block Device
|
||||
protocol.
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
|qemu_system| linux.img -hdb nbd://my_nbd_server.mydomain.org:1024/
|
||||
|
||||
If the NBD server is located on the same host, you can use an unix socket instead
|
||||
of an inet socket:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
|qemu_system| linux.img -hdb nbd+unix://?socket=/tmp/my_socket
|
||||
|
||||
In this case, the block device must be exported using qemu-nbd:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
qemu-nbd --socket=/tmp/my_socket my_disk.qcow2
|
||||
|
||||
The use of qemu-nbd allows sharing of a disk between several guests:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
qemu-nbd --socket=/tmp/my_socket --share=2 my_disk.qcow2
|
||||
|
||||
and then you can use it with two guests:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
|qemu_system| linux1.img -hdb nbd+unix://?socket=/tmp/my_socket
|
||||
|qemu_system| linux2.img -hdb nbd+unix://?socket=/tmp/my_socket
|
||||
|
||||
If the nbd-server uses named exports (supported since NBD 2.9.18, or with QEMU's
|
||||
own embedded NBD server), you must specify an export name in the URI:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
|qemu_system| -cdrom nbd://localhost/debian-500-ppc-netinst
|
||||
|qemu_system| -cdrom nbd://localhost/openSUSE-11.1-ppc-netinst
|
||||
|
||||
The URI syntax for NBD is supported since QEMU 1.3. An alternative syntax is
|
||||
also available. Here are some example of the older syntax:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
|qemu_system| linux.img -hdb nbd:my_nbd_server.mydomain.org:1024
|
||||
|qemu_system| linux2.img -hdb nbd:unix:/tmp/my_socket
|
||||
|qemu_system| -cdrom nbd:localhost:10809:exportname=debian-500-ppc-netinst
|
||||
|
||||
|
||||
|
||||
Sheepdog disk images
|
||||
--------------------
|
||||
|
||||
Sheepdog is a distributed storage system for QEMU. It provides highly
|
||||
available block level storage volumes that can be attached to
|
||||
QEMU-based virtual machines.
|
||||
|
||||
You can create a Sheepdog disk image with the command:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
qemu-img create sheepdog:///IMAGE SIZE
|
||||
|
||||
where *IMAGE* is the Sheepdog image name and *SIZE* is its
|
||||
size.
|
||||
|
||||
To import the existing *FILENAME* to Sheepdog, you can use a
|
||||
convert command.
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
qemu-img convert FILENAME sheepdog:///IMAGE
|
||||
|
||||
You can boot from the Sheepdog disk image with the command:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
|qemu_system| sheepdog:///IMAGE
|
||||
|
||||
You can also create a snapshot of the Sheepdog image like qcow2.
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
qemu-img snapshot -c TAG sheepdog:///IMAGE
|
||||
|
||||
where *TAG* is a tag name of the newly created snapshot.
|
||||
|
||||
To boot from the Sheepdog snapshot, specify the tag name of the
|
||||
snapshot.
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
|qemu_system| sheepdog:///IMAGE#TAG
|
||||
|
||||
You can create a cloned image from the existing snapshot.
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
qemu-img create -b sheepdog:///BASE#TAG sheepdog:///IMAGE
|
||||
|
||||
where *BASE* is an image name of the source snapshot and *TAG*
|
||||
is its tag name.
|
||||
|
||||
You can use an unix socket instead of an inet socket:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
|qemu_system| sheepdog+unix:///IMAGE?socket=PATH
|
||||
|
||||
If the Sheepdog daemon doesn't run on the local host, you need to
|
||||
specify one of the Sheepdog servers to connect to.
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
qemu-img create sheepdog://HOSTNAME:PORT/IMAGE SIZE
|
||||
|qemu_system| sheepdog://HOSTNAME:PORT/IMAGE
|
||||
|
||||
iSCSI LUNs
|
||||
----------
|
||||
|
||||
iSCSI is a popular protocol used to access SCSI devices across a computer
|
||||
network.
|
||||
|
||||
There are two different ways iSCSI devices can be used by QEMU.
|
||||
|
||||
The first method is to mount the iSCSI LUN on the host, and make it appear as
|
||||
any other ordinary SCSI device on the host and then to access this device as a
|
||||
/dev/sd device from QEMU. How to do this differs between host OSes.
|
||||
|
||||
The second method involves using the iSCSI initiator that is built into
|
||||
QEMU. This provides a mechanism that works the same way regardless of which
|
||||
host OS you are running QEMU on. This section will describe this second method
|
||||
of using iSCSI together with QEMU.
|
||||
|
||||
In QEMU, iSCSI devices are described using special iSCSI URLs. URL syntax:
|
||||
|
||||
::
|
||||
|
||||
iscsi://[<username>[%<password>]@]<host>[:<port>]/<target-iqn-name>/<lun>
|
||||
|
||||
Username and password are optional and only used if your target is set up
|
||||
using CHAP authentication for access control.
|
||||
Alternatively the username and password can also be set via environment
|
||||
variables to have these not show up in the process list:
|
||||
|
||||
::
|
||||
|
||||
export LIBISCSI_CHAP_USERNAME=<username>
|
||||
export LIBISCSI_CHAP_PASSWORD=<password>
|
||||
iscsi://<host>/<target-iqn-name>/<lun>
|
||||
|
||||
Various session related parameters can be set via special options, either
|
||||
in a configuration file provided via '-readconfig' or directly on the
|
||||
command line.
|
||||
|
||||
If the initiator-name is not specified qemu will use a default name
|
||||
of 'iqn.2008-11.org.linux-kvm[:<uuid>'] where <uuid> is the UUID of the
|
||||
virtual machine. If the UUID is not specified qemu will use
|
||||
'iqn.2008-11.org.linux-kvm[:<name>'] where <name> is the name of the
|
||||
virtual machine.
|
||||
|
||||
Setting a specific initiator name to use when logging in to the target:
|
||||
|
||||
::
|
||||
|
||||
-iscsi initiator-name=iqn.qemu.test:my-initiator
|
||||
|
||||
Controlling which type of header digest to negotiate with the target:
|
||||
|
||||
::
|
||||
|
||||
-iscsi header-digest=CRC32C|CRC32C-NONE|NONE-CRC32C|NONE
|
||||
|
||||
These can also be set via a configuration file:
|
||||
|
||||
::
|
||||
|
||||
[iscsi]
|
||||
user = "CHAP username"
|
||||
password = "CHAP password"
|
||||
initiator-name = "iqn.qemu.test:my-initiator"
|
||||
# header digest is one of CRC32C|CRC32C-NONE|NONE-CRC32C|NONE
|
||||
header-digest = "CRC32C"
|
||||
|
||||
Setting the target name allows different options for different targets:
|
||||
|
||||
::
|
||||
|
||||
[iscsi "iqn.target.name"]
|
||||
user = "CHAP username"
|
||||
password = "CHAP password"
|
||||
initiator-name = "iqn.qemu.test:my-initiator"
|
||||
# header digest is one of CRC32C|CRC32C-NONE|NONE-CRC32C|NONE
|
||||
header-digest = "CRC32C"
|
||||
|
||||
How to use a configuration file to set iSCSI configuration options:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
cat >iscsi.conf <<EOF
|
||||
[iscsi]
|
||||
user = "me"
|
||||
password = "my password"
|
||||
initiator-name = "iqn.qemu.test:my-initiator"
|
||||
header-digest = "CRC32C"
|
||||
EOF
|
||||
|
||||
|qemu_system| -drive file=iscsi://127.0.0.1/iqn.qemu.test/1 \\
|
||||
-readconfig iscsi.conf
|
||||
|
||||
How to set up a simple iSCSI target on loopback and access it via QEMU:
|
||||
this example shows how to set up an iSCSI target with one CDROM and one DISK
|
||||
using the Linux STGT software target. This target is available on Red Hat based
|
||||
systems as the package 'scsi-target-utils'.
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
tgtd --iscsi portal=127.0.0.1:3260
|
||||
tgtadm --lld iscsi --op new --mode target --tid 1 -T iqn.qemu.test
|
||||
tgtadm --lld iscsi --mode logicalunit --op new --tid 1 --lun 1 \\
|
||||
-b /IMAGES/disk.img --device-type=disk
|
||||
tgtadm --lld iscsi --mode logicalunit --op new --tid 1 --lun 2 \\
|
||||
-b /IMAGES/cd.iso --device-type=cd
|
||||
tgtadm --lld iscsi --op bind --mode target --tid 1 -I ALL
|
||||
|
||||
|qemu_system| -iscsi initiator-name=iqn.qemu.test:my-initiator \\
|
||||
-boot d -drive file=iscsi://127.0.0.1/iqn.qemu.test/1 \\
|
||||
-cdrom iscsi://127.0.0.1/iqn.qemu.test/2
|
||||
|
||||
GlusterFS disk images
|
||||
---------------------
|
||||
|
||||
GlusterFS is a user space distributed file system.
|
||||
|
||||
You can boot from the GlusterFS disk image with the command:
|
||||
|
||||
URI:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
|qemu_system| -drive file=gluster[+TYPE]://[HOST}[:PORT]]/VOLUME/PATH
|
||||
[?socket=...][,file.debug=9][,file.logfile=...]
|
||||
|
||||
JSON:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
|qemu_system| 'json:{"driver":"qcow2",
|
||||
"file":{"driver":"gluster",
|
||||
"volume":"testvol","path":"a.img","debug":9,"logfile":"...",
|
||||
"server":[{"type":"tcp","host":"...","port":"..."},
|
||||
{"type":"unix","socket":"..."}]}}'
|
||||
|
||||
*gluster* is the protocol.
|
||||
|
||||
*TYPE* specifies the transport type used to connect to gluster
|
||||
management daemon (glusterd). Valid transport types are
|
||||
tcp and unix. In the URI form, if a transport type isn't specified,
|
||||
then tcp type is assumed.
|
||||
|
||||
*HOST* specifies the server where the volume file specification for
|
||||
the given volume resides. This can be either a hostname or an ipv4 address.
|
||||
If transport type is unix, then *HOST* field should not be specified.
|
||||
Instead *socket* field needs to be populated with the path to unix domain
|
||||
socket.
|
||||
|
||||
*PORT* is the port number on which glusterd is listening. This is optional
|
||||
and if not specified, it defaults to port 24007. If the transport type is unix,
|
||||
then *PORT* should not be specified.
|
||||
|
||||
*VOLUME* is the name of the gluster volume which contains the disk image.
|
||||
|
||||
*PATH* is the path to the actual disk image that resides on gluster volume.
|
||||
|
||||
*debug* is the logging level of the gluster protocol driver. Debug levels
|
||||
are 0-9, with 9 being the most verbose, and 0 representing no debugging output.
|
||||
The default level is 4. The current logging levels defined in the gluster source
|
||||
are 0 - None, 1 - Emergency, 2 - Alert, 3 - Critical, 4 - Error, 5 - Warning,
|
||||
6 - Notice, 7 - Info, 8 - Debug, 9 - Trace
|
||||
|
||||
*logfile* is a commandline option to mention log file path which helps in
|
||||
logging to the specified file and also help in persisting the gfapi logs. The
|
||||
default is stderr.
|
||||
|
||||
You can create a GlusterFS disk image with the command:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
qemu-img create gluster://HOST/VOLUME/PATH SIZE
|
||||
|
||||
Examples
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
|qemu_system| -drive file=gluster://1.2.3.4/testvol/a.img
|
||||
|qemu_system| -drive file=gluster+tcp://1.2.3.4/testvol/a.img
|
||||
|qemu_system| -drive file=gluster+tcp://1.2.3.4:24007/testvol/dir/a.img
|
||||
|qemu_system| -drive file=gluster+tcp://[1:2:3:4:5:6:7:8]/testvol/dir/a.img
|
||||
|qemu_system| -drive file=gluster+tcp://[1:2:3:4:5:6:7:8]:24007/testvol/dir/a.img
|
||||
|qemu_system| -drive file=gluster+tcp://server.domain.com:24007/testvol/dir/a.img
|
||||
|qemu_system| -drive file=gluster+unix:///testvol/dir/a.img?socket=/tmp/glusterd.socket
|
||||
|qemu_system| -drive file=gluster+rdma://1.2.3.4:24007/testvol/a.img
|
||||
|qemu_system| -drive file=gluster://1.2.3.4/testvol/a.img,file.debug=9,file.logfile=/var/log/qemu-gluster.log
|
||||
|qemu_system| 'json:{"driver":"qcow2",
|
||||
"file":{"driver":"gluster",
|
||||
"volume":"testvol","path":"a.img",
|
||||
"debug":9,"logfile":"/var/log/qemu-gluster.log",
|
||||
"server":[{"type":"tcp","host":"1.2.3.4","port":24007},
|
||||
{"type":"unix","socket":"/var/run/glusterd.socket"}]}}'
|
||||
|qemu_system| -drive driver=qcow2,file.driver=gluster,file.volume=testvol,file.path=/path/a.img,
|
||||
file.debug=9,file.logfile=/var/log/qemu-gluster.log,
|
||||
file.server.0.type=tcp,file.server.0.host=1.2.3.4,file.server.0.port=24007,
|
||||
file.server.1.type=unix,file.server.1.socket=/var/run/glusterd.socket
|
||||
|
||||
Secure Shell (ssh) disk images
|
||||
------------------------------
|
||||
|
||||
You can access disk images located on a remote ssh server
|
||||
by using the ssh protocol:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
|qemu_system| -drive file=ssh://[USER@]SERVER[:PORT]/PATH[?host_key_check=HOST_KEY_CHECK]
|
||||
|
||||
Alternative syntax using properties:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
|qemu_system| -drive file.driver=ssh[,file.user=USER],file.host=SERVER[,file.port=PORT],file.path=PATH[,file.host_key_check=HOST_KEY_CHECK]
|
||||
|
||||
*ssh* is the protocol.
|
||||
|
||||
*USER* is the remote user. If not specified, then the local
|
||||
username is tried.
|
||||
|
||||
*SERVER* specifies the remote ssh server. Any ssh server can be
|
||||
used, but it must implement the sftp-server protocol. Most Unix/Linux
|
||||
systems should work without requiring any extra configuration.
|
||||
|
||||
*PORT* is the port number on which sshd is listening. By default
|
||||
the standard ssh port (22) is used.
|
||||
|
||||
*PATH* is the path to the disk image.
|
||||
|
||||
The optional *HOST_KEY_CHECK* parameter controls how the remote
|
||||
host's key is checked. The default is ``yes`` which means to use
|
||||
the local ``.ssh/known_hosts`` file. Setting this to ``no``
|
||||
turns off known-hosts checking. Or you can check that the host key
|
||||
matches a specific fingerprint:
|
||||
``host_key_check=md5:78:45:8e:14:57:4f:d5:45:83:0a:0e:f3:49:82:c9:c8``
|
||||
(``sha1:`` can also be used as a prefix, but note that OpenSSH
|
||||
tools only use MD5 to print fingerprints).
|
||||
|
||||
Currently authentication must be done using ssh-agent. Other
|
||||
authentication methods may be supported in future.
|
||||
|
||||
Note: Many ssh servers do not support an ``fsync``-style operation.
|
||||
The ssh driver cannot guarantee that disk flush requests are
|
||||
obeyed, and this causes a risk of disk corruption if the remote
|
||||
server or network goes down during writes. The driver will
|
||||
print a warning when ``fsync`` is not supported:
|
||||
|
||||
::
|
||||
|
||||
warning: ssh server ssh.example.com:22 does not support fsync
|
||||
|
||||
With sufficiently new versions of libssh and OpenSSH, ``fsync`` is
|
||||
supported.
|
||||
|
||||
NVMe disk images
|
||||
----------------
|
||||
|
||||
NVM Express (NVMe) storage controllers can be accessed directly by a userspace
|
||||
driver in QEMU. This bypasses the host kernel file system and block layers
|
||||
while retaining QEMU block layer functionalities, such as block jobs, I/O
|
||||
throttling, image formats, etc. Disk I/O performance is typically higher than
|
||||
with ``-drive file=/dev/sda`` using either thread pool or linux-aio.
|
||||
|
||||
The controller will be exclusively used by the QEMU process once started. To be
|
||||
able to share storage between multiple VMs and other applications on the host,
|
||||
please use the file based protocols.
|
||||
|
||||
Before starting QEMU, bind the host NVMe controller to the host vfio-pci
|
||||
driver. For example:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
# modprobe vfio-pci
|
||||
# lspci -n -s 0000:06:0d.0
|
||||
06:0d.0 0401: 1102:0002 (rev 08)
|
||||
# echo 0000:06:0d.0 > /sys/bus/pci/devices/0000:06:0d.0/driver/unbind
|
||||
# echo 1102 0002 > /sys/bus/pci/drivers/vfio-pci/new_id
|
||||
|
||||
# |qemu_system| -drive file=nvme://HOST:BUS:SLOT.FUNC/NAMESPACE
|
||||
|
||||
Alternative syntax using properties:
|
||||
|
||||
.. parsed-literal::
|
||||
|
||||
|qemu_system| -drive file.driver=nvme,file.device=HOST:BUS:SLOT.FUNC,file.namespace=NAMESPACE
|
||||
|
||||
*HOST*:*BUS*:*SLOT*.\ *FUNC* is the NVMe controller's PCI device
|
||||
address on the host.
|
||||
|
||||
*NAMESPACE* is the NVMe namespace number, starting from 1.
|
||||
|
||||
Disk image file locking
|
||||
-----------------------
|
||||
|
||||
By default, QEMU tries to protect image files from unexpected concurrent
|
||||
access, as long as it's supported by the block protocol driver and host
|
||||
operating system. If multiple QEMU processes (including QEMU emulators and
|
||||
utilities) try to open the same image with conflicting accessing modes, all but
|
||||
the first one will get an error.
|
||||
|
||||
This feature is currently supported by the file protocol on Linux with the Open
|
||||
File Descriptor (OFD) locking API, and can be configured to fall back to POSIX
|
||||
locking if the POSIX host doesn't support Linux OFD locking.
|
||||
|
||||
To explicitly enable image locking, specify "locking=on" in the file protocol
|
||||
driver options. If OFD locking is not possible, a warning will be printed and
|
||||
the POSIX locking API will be used. In this case there is a risk that the lock
|
||||
will get silently lost when doing hot plugging and block jobs, due to the
|
||||
shortcomings of the POSIX locking API.
|
||||
|
||||
QEMU transparently handles lock handover during shared storage migration. For
|
||||
shared virtual disk images between multiple VMs, the "share-rw" device option
|
||||
should be used.
|
||||
|
||||
By default, the guest has exclusive write access to its disk image. If the
|
||||
guest can safely share the disk image with other writers the
|
||||
``-device ...,share-rw=on`` parameter can be used. This is only safe if
|
||||
the guest is running software, such as a cluster file system, that
|
||||
coordinates disk accesses to avoid corruption.
|
||||
|
||||
Note that share-rw=on only declares the guest's ability to share the disk.
|
||||
Some QEMU features, such as image file formats, require exclusive write access
|
||||
to the disk image and this is unaffected by the share-rw=on option.
|
||||
|
||||
Alternatively, locking can be fully disabled by "locking=off" block device
|
||||
option. In the command line, the option is usually in the form of
|
||||
"file.locking=off" as the protocol driver is normally placed as a "file" child
|
||||
under a format driver. For example:
|
||||
|
||||
::
|
||||
|
||||
-blockdev driver=qcow2,file.filename=/path/to/image,file.locking=off,file.driver=file
|
||||
|
||||
To check if image locking is active, check the output of the "lslocks" command
|
||||
on host and see if there are locks held by the QEMU process on the image file.
|
||||
More than one byte could be locked by the QEMU instance, each byte of which
|
||||
reflects a particular permission that is acquired or protected by the running
|
||||
block driver.
|
||||
|
||||
.. only:: man
|
||||
|
||||
See also
|
||||
--------
|
||||
|
||||
The HTML documentation of QEMU for more precise information and Linux
|
||||
user mode emulator invocation.
|
|
@ -175,7 +175,7 @@ static void acpi_ged_device_plug_cb(HotplugHandler *hotplug_dev,
|
|||
AcpiGedState *s = ACPI_GED(hotplug_dev);
|
||||
|
||||
if (object_dynamic_cast(OBJECT(dev), TYPE_PC_DIMM)) {
|
||||
acpi_memory_plug_cb(hotplug_dev, &s->memhp_state, dev, errp);
|
||||
acpi_memory_plug_cb(hotplug_dev, &s->memhp_state, dev, errp);
|
||||
} else {
|
||||
error_setg(errp, "virt: device plug request for unsupported device"
|
||||
" type: %s", object_get_typename(OBJECT(dev)));
|
||||
|
|
|
@ -166,17 +166,37 @@ static uint64_t exynos4210_calc_affinity(int cpu)
|
|||
return (0x9 << ARM_AFF1_SHIFT) | cpu;
|
||||
}
|
||||
|
||||
static void pl330_create(uint32_t base, qemu_irq irq, int nreq)
|
||||
static DeviceState *pl330_create(uint32_t base, qemu_or_irq *orgate,
|
||||
qemu_irq irq, int nreq, int nevents, int width)
|
||||
{
|
||||
SysBusDevice *busdev;
|
||||
DeviceState *dev;
|
||||
int i;
|
||||
|
||||
dev = qdev_create(NULL, "pl330");
|
||||
qdev_prop_set_uint8(dev, "num_events", nevents);
|
||||
qdev_prop_set_uint8(dev, "num_chnls", 8);
|
||||
qdev_prop_set_uint8(dev, "num_periph_req", nreq);
|
||||
|
||||
qdev_prop_set_uint8(dev, "wr_cap", 4);
|
||||
qdev_prop_set_uint8(dev, "wr_q_dep", 8);
|
||||
qdev_prop_set_uint8(dev, "rd_cap", 4);
|
||||
qdev_prop_set_uint8(dev, "rd_q_dep", 8);
|
||||
qdev_prop_set_uint8(dev, "data_width", width);
|
||||
qdev_prop_set_uint16(dev, "data_buffer_dep", width);
|
||||
qdev_init_nofail(dev);
|
||||
busdev = SYS_BUS_DEVICE(dev);
|
||||
sysbus_mmio_map(busdev, 0, base);
|
||||
sysbus_connect_irq(busdev, 0, irq);
|
||||
|
||||
object_property_set_int(OBJECT(orgate), nevents + 1, "num-lines",
|
||||
&error_abort);
|
||||
object_property_set_bool(OBJECT(orgate), true, "realized", &error_abort);
|
||||
|
||||
for (i = 0; i < nevents + 1; i++) {
|
||||
sysbus_connect_irq(busdev, i, qdev_get_gpio_in(DEVICE(orgate), i));
|
||||
}
|
||||
qdev_connect_gpio_out(DEVICE(orgate), 0, irq);
|
||||
return dev;
|
||||
}
|
||||
|
||||
static void exynos4210_realize(DeviceState *socdev, Error **errp)
|
||||
|
@ -185,7 +205,7 @@ static void exynos4210_realize(DeviceState *socdev, Error **errp)
|
|||
MemoryRegion *system_mem = get_system_memory();
|
||||
qemu_irq gate_irq[EXYNOS4210_NCPUS][EXYNOS4210_IRQ_GATE_NINPUTS];
|
||||
SysBusDevice *busdev;
|
||||
DeviceState *dev;
|
||||
DeviceState *dev, *uart[4], *pl330[3];
|
||||
int i, n;
|
||||
|
||||
for (n = 0; n < EXYNOS4210_NCPUS; n++) {
|
||||
|
@ -371,19 +391,19 @@ static void exynos4210_realize(DeviceState *socdev, Error **errp)
|
|||
|
||||
|
||||
/*** UARTs ***/
|
||||
exynos4210_uart_create(EXYNOS4210_UART0_BASE_ADDR,
|
||||
uart[0] = exynos4210_uart_create(EXYNOS4210_UART0_BASE_ADDR,
|
||||
EXYNOS4210_UART0_FIFO_SIZE, 0, serial_hd(0),
|
||||
s->irq_table[exynos4210_get_irq(EXYNOS4210_UART_INT_GRP, 0)]);
|
||||
|
||||
exynos4210_uart_create(EXYNOS4210_UART1_BASE_ADDR,
|
||||
uart[1] = exynos4210_uart_create(EXYNOS4210_UART1_BASE_ADDR,
|
||||
EXYNOS4210_UART1_FIFO_SIZE, 1, serial_hd(1),
|
||||
s->irq_table[exynos4210_get_irq(EXYNOS4210_UART_INT_GRP, 1)]);
|
||||
|
||||
exynos4210_uart_create(EXYNOS4210_UART2_BASE_ADDR,
|
||||
uart[2] = exynos4210_uart_create(EXYNOS4210_UART2_BASE_ADDR,
|
||||
EXYNOS4210_UART2_FIFO_SIZE, 2, serial_hd(2),
|
||||
s->irq_table[exynos4210_get_irq(EXYNOS4210_UART_INT_GRP, 2)]);
|
||||
|
||||
exynos4210_uart_create(EXYNOS4210_UART3_BASE_ADDR,
|
||||
uart[3] = exynos4210_uart_create(EXYNOS4210_UART3_BASE_ADDR,
|
||||
EXYNOS4210_UART3_FIFO_SIZE, 3, serial_hd(3),
|
||||
s->irq_table[exynos4210_get_irq(EXYNOS4210_UART_INT_GRP, 3)]);
|
||||
|
||||
|
@ -431,12 +451,42 @@ static void exynos4210_realize(DeviceState *socdev, Error **errp)
|
|||
s->irq_table[exynos4210_get_irq(28, 3)]);
|
||||
|
||||
/*** DMA controllers ***/
|
||||
pl330_create(EXYNOS4210_PL330_BASE0_ADDR,
|
||||
qemu_irq_invert(s->irq_table[exynos4210_get_irq(35, 1)]), 32);
|
||||
pl330_create(EXYNOS4210_PL330_BASE1_ADDR,
|
||||
qemu_irq_invert(s->irq_table[exynos4210_get_irq(36, 1)]), 32);
|
||||
pl330_create(EXYNOS4210_PL330_BASE2_ADDR,
|
||||
qemu_irq_invert(s->irq_table[exynos4210_get_irq(34, 1)]), 1);
|
||||
pl330[0] = pl330_create(EXYNOS4210_PL330_BASE0_ADDR,
|
||||
&s->pl330_irq_orgate[0],
|
||||
s->irq_table[exynos4210_get_irq(21, 0)],
|
||||
32, 32, 32);
|
||||
pl330[1] = pl330_create(EXYNOS4210_PL330_BASE1_ADDR,
|
||||
&s->pl330_irq_orgate[1],
|
||||
s->irq_table[exynos4210_get_irq(21, 1)],
|
||||
32, 32, 32);
|
||||
pl330[2] = pl330_create(EXYNOS4210_PL330_BASE2_ADDR,
|
||||
&s->pl330_irq_orgate[2],
|
||||
s->irq_table[exynos4210_get_irq(20, 1)],
|
||||
1, 31, 64);
|
||||
|
||||
sysbus_connect_irq(SYS_BUS_DEVICE(uart[0]), 1,
|
||||
qdev_get_gpio_in(pl330[0], 15));
|
||||
sysbus_connect_irq(SYS_BUS_DEVICE(uart[1]), 1,
|
||||
qdev_get_gpio_in(pl330[1], 15));
|
||||
sysbus_connect_irq(SYS_BUS_DEVICE(uart[2]), 1,
|
||||
qdev_get_gpio_in(pl330[0], 17));
|
||||
sysbus_connect_irq(SYS_BUS_DEVICE(uart[3]), 1,
|
||||
qdev_get_gpio_in(pl330[1], 17));
|
||||
}
|
||||
|
||||
static void exynos4210_init(Object *obj)
|
||||
{
|
||||
Exynos4210State *s = EXYNOS4210_SOC(obj);
|
||||
int i;
|
||||
|
||||
for (i = 0; i < ARRAY_SIZE(s->pl330_irq_orgate); i++) {
|
||||
char *name = g_strdup_printf("pl330-irq-orgate%d", i);
|
||||
qemu_or_irq *orgate = &s->pl330_irq_orgate[i];
|
||||
|
||||
object_initialize_child(obj, name, orgate, sizeof(*orgate),
|
||||
TYPE_OR_IRQ, &error_abort, NULL);
|
||||
g_free(name);
|
||||
}
|
||||
}
|
||||
|
||||
static void exynos4210_class_init(ObjectClass *klass, void *data)
|
||||
|
@ -450,6 +500,7 @@ static const TypeInfo exynos4210_info = {
|
|||
.name = TYPE_EXYNOS4210_SOC,
|
||||
.parent = TYPE_SYS_BUS_DEVICE,
|
||||
.instance_size = sizeof(Exynos4210State),
|
||||
.instance_init = exynos4210_init,
|
||||
.class_init = exynos4210_class_init,
|
||||
};
|
||||
|
||||
|
|
|
@ -1934,7 +1934,6 @@ static void virt_memory_pre_plug(HotplugHandler *hotplug_dev, DeviceState *dev,
|
|||
static void virt_memory_plug(HotplugHandler *hotplug_dev,
|
||||
DeviceState *dev, Error **errp)
|
||||
{
|
||||
HotplugHandlerClass *hhc;
|
||||
VirtMachineState *vms = VIRT_MACHINE(hotplug_dev);
|
||||
Error *local_err = NULL;
|
||||
|
||||
|
@ -1943,8 +1942,9 @@ static void virt_memory_plug(HotplugHandler *hotplug_dev,
|
|||
goto out;
|
||||
}
|
||||
|
||||
hhc = HOTPLUG_HANDLER_GET_CLASS(vms->acpi_dev);
|
||||
hhc->plug(HOTPLUG_HANDLER(vms->acpi_dev), dev, &error_abort);
|
||||
hotplug_handler_plug(HOTPLUG_HANDLER(vms->acpi_dev),
|
||||
dev, &error_abort);
|
||||
|
||||
out:
|
||||
error_propagate(errp, local_err);
|
||||
}
|
||||
|
|
|
@ -24,6 +24,7 @@
|
|||
#include "migration/vmstate.h"
|
||||
#include "qemu/error-report.h"
|
||||
#include "qemu/module.h"
|
||||
#include "qemu/timer.h"
|
||||
#include "chardev/char-fe.h"
|
||||
#include "chardev/char-serial.h"
|
||||
|
||||
|
@ -31,45 +32,7 @@
|
|||
#include "hw/irq.h"
|
||||
#include "hw/qdev-properties.h"
|
||||
|
||||
#undef DEBUG_UART
|
||||
#undef DEBUG_UART_EXTEND
|
||||
#undef DEBUG_IRQ
|
||||
#undef DEBUG_Rx_DATA
|
||||
#undef DEBUG_Tx_DATA
|
||||
|
||||
#define DEBUG_UART 0
|
||||
#define DEBUG_UART_EXTEND 0
|
||||
#define DEBUG_IRQ 0
|
||||
#define DEBUG_Rx_DATA 0
|
||||
#define DEBUG_Tx_DATA 0
|
||||
|
||||
#if DEBUG_UART
|
||||
#define PRINT_DEBUG(fmt, args...) \
|
||||
do { \
|
||||
fprintf(stderr, " [%s:%d] "fmt, __func__, __LINE__, ##args); \
|
||||
} while (0)
|
||||
|
||||
#if DEBUG_UART_EXTEND
|
||||
#define PRINT_DEBUG_EXTEND(fmt, args...) \
|
||||
do { \
|
||||
fprintf(stderr, " [%s:%d] "fmt, __func__, __LINE__, ##args); \
|
||||
} while (0)
|
||||
#else
|
||||
#define PRINT_DEBUG_EXTEND(fmt, args...) \
|
||||
do {} while (0)
|
||||
#endif /* EXTEND */
|
||||
|
||||
#else
|
||||
#define PRINT_DEBUG(fmt, args...) \
|
||||
do {} while (0)
|
||||
#define PRINT_DEBUG_EXTEND(fmt, args...) \
|
||||
do {} while (0)
|
||||
#endif
|
||||
|
||||
#define PRINT_ERROR(fmt, args...) \
|
||||
do { \
|
||||
fprintf(stderr, " [%s:%d] "fmt, __func__, __LINE__, ##args); \
|
||||
} while (0)
|
||||
#include "trace.h"
|
||||
|
||||
/*
|
||||
* Offsets for UART registers relative to SFR base address
|
||||
|
@ -156,6 +119,7 @@ static const Exynos4210UartReg exynos4210_uart_regs[] = {
|
|||
#define ULCON_STOP_BIT_SHIFT 1
|
||||
|
||||
/* UART Tx/Rx Status */
|
||||
#define UTRSTAT_Rx_TIMEOUT 0x8
|
||||
#define UTRSTAT_TRANSMITTER_EMPTY 0x4
|
||||
#define UTRSTAT_Tx_BUFFER_EMPTY 0x2
|
||||
#define UTRSTAT_Rx_BUFFER_DATA_READY 0x1
|
||||
|
@ -185,16 +149,19 @@ typedef struct Exynos4210UartState {
|
|||
Exynos4210UartFIFO rx;
|
||||
Exynos4210UartFIFO tx;
|
||||
|
||||
QEMUTimer *fifo_timeout_timer;
|
||||
uint64_t wordtime; /* word time in ns */
|
||||
|
||||
CharBackend chr;
|
||||
qemu_irq irq;
|
||||
qemu_irq dmairq;
|
||||
|
||||
uint32_t channel;
|
||||
|
||||
} Exynos4210UartState;
|
||||
|
||||
|
||||
#if DEBUG_UART
|
||||
/* Used only for debugging inside PRINT_DEBUG_... macros */
|
||||
/* Used only for tracing */
|
||||
static const char *exynos4210_uart_regname(hwaddr offset)
|
||||
{
|
||||
|
||||
|
@ -208,7 +175,6 @@ static const char *exynos4210_uart_regname(hwaddr offset)
|
|||
|
||||
return NULL;
|
||||
}
|
||||
#endif
|
||||
|
||||
|
||||
static void fifo_store(Exynos4210UartFIFO *q, uint8_t ch)
|
||||
|
@ -249,15 +215,12 @@ static void fifo_reset(Exynos4210UartFIFO *q)
|
|||
q->rp = 0;
|
||||
}
|
||||
|
||||
static uint32_t exynos4210_uart_Tx_FIFO_trigger_level(const Exynos4210UartState *s)
|
||||
static uint32_t exynos4210_uart_FIFO_trigger_level(uint32_t channel,
|
||||
uint32_t reg)
|
||||
{
|
||||
uint32_t level = 0;
|
||||
uint32_t reg;
|
||||
uint32_t level;
|
||||
|
||||
reg = (s->reg[I_(UFCON)] & UFCON_Tx_FIFO_TRIGGER_LEVEL) >>
|
||||
UFCON_Tx_FIFO_TRIGGER_LEVEL_SHIFT;
|
||||
|
||||
switch (s->channel) {
|
||||
switch (channel) {
|
||||
case 0:
|
||||
level = reg * 32;
|
||||
break;
|
||||
|
@ -271,12 +234,52 @@ static uint32_t exynos4210_uart_Tx_FIFO_trigger_level(const Exynos4210UartState
|
|||
break;
|
||||
default:
|
||||
level = 0;
|
||||
PRINT_ERROR("Wrong UART channel number: %d\n", s->channel);
|
||||
trace_exynos_uart_channel_error(channel);
|
||||
break;
|
||||
}
|
||||
|
||||
return level;
|
||||
}
|
||||
|
||||
static uint32_t
|
||||
exynos4210_uart_Tx_FIFO_trigger_level(const Exynos4210UartState *s)
|
||||
{
|
||||
uint32_t reg;
|
||||
|
||||
reg = (s->reg[I_(UFCON)] & UFCON_Tx_FIFO_TRIGGER_LEVEL) >>
|
||||
UFCON_Tx_FIFO_TRIGGER_LEVEL_SHIFT;
|
||||
|
||||
return exynos4210_uart_FIFO_trigger_level(s->channel, reg);
|
||||
}
|
||||
|
||||
static uint32_t
|
||||
exynos4210_uart_Rx_FIFO_trigger_level(const Exynos4210UartState *s)
|
||||
{
|
||||
uint32_t reg;
|
||||
|
||||
reg = ((s->reg[I_(UFCON)] & UFCON_Rx_FIFO_TRIGGER_LEVEL) >>
|
||||
UFCON_Rx_FIFO_TRIGGER_LEVEL_SHIFT) + 1;
|
||||
|
||||
return exynos4210_uart_FIFO_trigger_level(s->channel, reg);
|
||||
}
|
||||
|
||||
/*
|
||||
* Update Rx DMA busy signal if Rx DMA is enabled. For simplicity,
|
||||
* mark DMA as busy if DMA is enabled and the receive buffer is empty.
|
||||
*/
|
||||
static void exynos4210_uart_update_dmabusy(Exynos4210UartState *s)
|
||||
{
|
||||
bool rx_dma_enabled = (s->reg[I_(UCON)] & 0x03) == 0x02;
|
||||
uint32_t count = fifo_elements_number(&s->rx);
|
||||
|
||||
if (rx_dma_enabled && !count) {
|
||||
qemu_irq_raise(s->dmairq);
|
||||
trace_exynos_uart_dmabusy(s->channel);
|
||||
} else {
|
||||
qemu_irq_lower(s->dmairq);
|
||||
trace_exynos_uart_dmaready(s->channel);
|
||||
}
|
||||
}
|
||||
|
||||
static void exynos4210_uart_update_irq(Exynos4210UartState *s)
|
||||
{
|
||||
/*
|
||||
|
@ -284,27 +287,53 @@ static void exynos4210_uart_update_irq(Exynos4210UartState *s)
|
|||
* transmit FIFO is smaller than the trigger level.
|
||||
*/
|
||||
if (s->reg[I_(UFCON)] & UFCON_FIFO_ENABLE) {
|
||||
|
||||
uint32_t count = (s->reg[I_(UFSTAT)] & UFSTAT_Tx_FIFO_COUNT) >>
|
||||
UFSTAT_Tx_FIFO_COUNT_SHIFT;
|
||||
|
||||
if (count <= exynos4210_uart_Tx_FIFO_trigger_level(s)) {
|
||||
s->reg[I_(UINTSP)] |= UINTSP_TXD;
|
||||
}
|
||||
|
||||
/*
|
||||
* Rx interrupt if trigger level is reached or if rx timeout
|
||||
* interrupt is disabled and there is data in the receive buffer
|
||||
*/
|
||||
count = fifo_elements_number(&s->rx);
|
||||
if ((count && !(s->reg[I_(UCON)] & 0x80)) ||
|
||||
count >= exynos4210_uart_Rx_FIFO_trigger_level(s)) {
|
||||
exynos4210_uart_update_dmabusy(s);
|
||||
s->reg[I_(UINTSP)] |= UINTSP_RXD;
|
||||
timer_del(s->fifo_timeout_timer);
|
||||
}
|
||||
} else if (s->reg[I_(UTRSTAT)] & UTRSTAT_Rx_BUFFER_DATA_READY) {
|
||||
exynos4210_uart_update_dmabusy(s);
|
||||
s->reg[I_(UINTSP)] |= UINTSP_RXD;
|
||||
}
|
||||
|
||||
s->reg[I_(UINTP)] = s->reg[I_(UINTSP)] & ~s->reg[I_(UINTM)];
|
||||
|
||||
if (s->reg[I_(UINTP)]) {
|
||||
qemu_irq_raise(s->irq);
|
||||
|
||||
#if DEBUG_IRQ
|
||||
fprintf(stderr, "UART%d: IRQ has been raised: %08x\n",
|
||||
s->channel, s->reg[I_(UINTP)]);
|
||||
#endif
|
||||
|
||||
trace_exynos_uart_irq_raised(s->channel, s->reg[I_(UINTP)]);
|
||||
} else {
|
||||
qemu_irq_lower(s->irq);
|
||||
trace_exynos_uart_irq_lowered(s->channel);
|
||||
}
|
||||
}
|
||||
|
||||
static void exynos4210_uart_timeout_int(void *opaque)
|
||||
{
|
||||
Exynos4210UartState *s = opaque;
|
||||
|
||||
trace_exynos_uart_rx_timeout(s->channel, s->reg[I_(UTRSTAT)],
|
||||
s->reg[I_(UINTSP)]);
|
||||
|
||||
if ((s->reg[I_(UTRSTAT)] & UTRSTAT_Rx_BUFFER_DATA_READY) ||
|
||||
(s->reg[I_(UCON)] & (1 << 11))) {
|
||||
s->reg[I_(UINTSP)] |= UINTSP_RXD;
|
||||
s->reg[I_(UTRSTAT)] |= UTRSTAT_Rx_TIMEOUT;
|
||||
exynos4210_uart_update_dmabusy(s);
|
||||
exynos4210_uart_update_irq(s);
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -346,10 +375,24 @@ static void exynos4210_uart_update_parameters(Exynos4210UartState *s)
|
|||
ssp.data_bits = data_bits;
|
||||
ssp.stop_bits = stop_bits;
|
||||
|
||||
s->wordtime = NANOSECONDS_PER_SECOND * (data_bits + stop_bits + 1) / speed;
|
||||
|
||||
qemu_chr_fe_ioctl(&s->chr, CHR_IOCTL_SERIAL_SET_PARAMS, &ssp);
|
||||
|
||||
PRINT_DEBUG("UART%d: speed: %d, parity: %c, data: %d, stop: %d\n",
|
||||
s->channel, speed, parity, data_bits, stop_bits);
|
||||
trace_exynos_uart_update_params(
|
||||
s->channel, speed, parity, data_bits, stop_bits, s->wordtime);
|
||||
}
|
||||
|
||||
static void exynos4210_uart_rx_timeout_set(Exynos4210UartState *s)
|
||||
{
|
||||
if (s->reg[I_(UCON)] & 0x80) {
|
||||
uint32_t timeout = ((s->reg[I_(UCON)] >> 12) & 0x0f) * s->wordtime;
|
||||
|
||||
timer_mod(s->fifo_timeout_timer,
|
||||
qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) + timeout);
|
||||
} else {
|
||||
timer_del(s->fifo_timeout_timer);
|
||||
}
|
||||
}
|
||||
|
||||
static void exynos4210_uart_write(void *opaque, hwaddr offset,
|
||||
|
@ -358,8 +401,8 @@ static void exynos4210_uart_write(void *opaque, hwaddr offset,
|
|||
Exynos4210UartState *s = (Exynos4210UartState *)opaque;
|
||||
uint8_t ch;
|
||||
|
||||
PRINT_DEBUG_EXTEND("UART%d: <0x%04x> %s <- 0x%08llx\n", s->channel,
|
||||
offset, exynos4210_uart_regname(offset), (long long unsigned int)val);
|
||||
trace_exynos_uart_write(s->channel, offset,
|
||||
exynos4210_uart_regname(offset), val);
|
||||
|
||||
switch (offset) {
|
||||
case ULCON:
|
||||
|
@ -373,12 +416,12 @@ static void exynos4210_uart_write(void *opaque, hwaddr offset,
|
|||
if (val & UFCON_Rx_FIFO_RESET) {
|
||||
fifo_reset(&s->rx);
|
||||
s->reg[I_(UFCON)] &= ~UFCON_Rx_FIFO_RESET;
|
||||
PRINT_DEBUG("UART%d: Rx FIFO Reset\n", s->channel);
|
||||
trace_exynos_uart_rx_fifo_reset(s->channel);
|
||||
}
|
||||
if (val & UFCON_Tx_FIFO_RESET) {
|
||||
fifo_reset(&s->tx);
|
||||
s->reg[I_(UFCON)] &= ~UFCON_Tx_FIFO_RESET;
|
||||
PRINT_DEBUG("UART%d: Tx FIFO Reset\n", s->channel);
|
||||
trace_exynos_uart_tx_fifo_reset(s->channel);
|
||||
}
|
||||
break;
|
||||
|
||||
|
@ -390,9 +433,7 @@ static void exynos4210_uart_write(void *opaque, hwaddr offset,
|
|||
/* XXX this blocks entire thread. Rewrite to use
|
||||
* qemu_chr_fe_write and background I/O callbacks */
|
||||
qemu_chr_fe_write_all(&s->chr, &ch, 1);
|
||||
#if DEBUG_Tx_DATA
|
||||
fprintf(stderr, "%c", ch);
|
||||
#endif
|
||||
trace_exynos_uart_tx(s->channel, ch);
|
||||
s->reg[I_(UTRSTAT)] |= UTRSTAT_TRANSMITTER_EMPTY |
|
||||
UTRSTAT_Tx_BUFFER_EMPTY;
|
||||
s->reg[I_(UINTSP)] |= UINTSP_TXD;
|
||||
|
@ -403,16 +444,19 @@ static void exynos4210_uart_write(void *opaque, hwaddr offset,
|
|||
case UINTP:
|
||||
s->reg[I_(UINTP)] &= ~val;
|
||||
s->reg[I_(UINTSP)] &= ~val;
|
||||
PRINT_DEBUG("UART%d: UINTP [%04x] have been cleared: %08x\n",
|
||||
s->channel, offset, s->reg[I_(UINTP)]);
|
||||
trace_exynos_uart_intclr(s->channel, s->reg[I_(UINTP)]);
|
||||
exynos4210_uart_update_irq(s);
|
||||
break;
|
||||
case UTRSTAT:
|
||||
if (val & UTRSTAT_Rx_TIMEOUT) {
|
||||
s->reg[I_(UTRSTAT)] &= ~UTRSTAT_Rx_TIMEOUT;
|
||||
}
|
||||
break;
|
||||
case UERSTAT:
|
||||
case UFSTAT:
|
||||
case UMSTAT:
|
||||
case URXH:
|
||||
PRINT_DEBUG("UART%d: Trying to write into RO register: %s [%04x]\n",
|
||||
trace_exynos_uart_ro_write(
|
||||
s->channel, exynos4210_uart_regname(offset), offset);
|
||||
break;
|
||||
case UINTSP:
|
||||
|
@ -429,6 +473,7 @@ static void exynos4210_uart_write(void *opaque, hwaddr offset,
|
|||
break;
|
||||
}
|
||||
}
|
||||
|
||||
static uint64_t exynos4210_uart_read(void *opaque, hwaddr offset,
|
||||
unsigned size)
|
||||
{
|
||||
|
@ -439,6 +484,8 @@ static uint64_t exynos4210_uart_read(void *opaque, hwaddr offset,
|
|||
case UERSTAT: /* Read Only */
|
||||
res = s->reg[I_(UERSTAT)];
|
||||
s->reg[I_(UERSTAT)] = 0;
|
||||
trace_exynos_uart_read(s->channel, offset,
|
||||
exynos4210_uart_regname(offset), res);
|
||||
return res;
|
||||
case UFSTAT: /* Read Only */
|
||||
s->reg[I_(UFSTAT)] = fifo_elements_number(&s->rx) & 0xff;
|
||||
|
@ -446,20 +493,22 @@ static uint64_t exynos4210_uart_read(void *opaque, hwaddr offset,
|
|||
s->reg[I_(UFSTAT)] |= UFSTAT_Rx_FIFO_FULL;
|
||||
s->reg[I_(UFSTAT)] &= ~0xff;
|
||||
}
|
||||
trace_exynos_uart_read(s->channel, offset,
|
||||
exynos4210_uart_regname(offset),
|
||||
s->reg[I_(UFSTAT)]);
|
||||
return s->reg[I_(UFSTAT)];
|
||||
case URXH:
|
||||
if (s->reg[I_(UFCON)] & UFCON_FIFO_ENABLE) {
|
||||
if (fifo_elements_number(&s->rx)) {
|
||||
res = fifo_retrieve(&s->rx);
|
||||
#if DEBUG_Rx_DATA
|
||||
fprintf(stderr, "%c", res);
|
||||
#endif
|
||||
trace_exynos_uart_rx(s->channel, res);
|
||||
if (!fifo_elements_number(&s->rx)) {
|
||||
s->reg[I_(UTRSTAT)] &= ~UTRSTAT_Rx_BUFFER_DATA_READY;
|
||||
} else {
|
||||
s->reg[I_(UTRSTAT)] |= UTRSTAT_Rx_BUFFER_DATA_READY;
|
||||
}
|
||||
} else {
|
||||
trace_exynos_uart_rx_error(s->channel);
|
||||
s->reg[I_(UINTSP)] |= UINTSP_ERROR;
|
||||
exynos4210_uart_update_irq(s);
|
||||
res = 0;
|
||||
|
@ -468,15 +517,23 @@ static uint64_t exynos4210_uart_read(void *opaque, hwaddr offset,
|
|||
s->reg[I_(UTRSTAT)] &= ~UTRSTAT_Rx_BUFFER_DATA_READY;
|
||||
res = s->reg[I_(URXH)];
|
||||
}
|
||||
exynos4210_uart_update_dmabusy(s);
|
||||
trace_exynos_uart_read(s->channel, offset,
|
||||
exynos4210_uart_regname(offset), res);
|
||||
return res;
|
||||
case UTXH:
|
||||
PRINT_DEBUG("UART%d: Trying to read from WO register: %s [%04x]\n",
|
||||
s->channel, exynos4210_uart_regname(offset), offset);
|
||||
trace_exynos_uart_wo_read(s->channel, exynos4210_uart_regname(offset),
|
||||
offset);
|
||||
break;
|
||||
default:
|
||||
trace_exynos_uart_read(s->channel, offset,
|
||||
exynos4210_uart_regname(offset),
|
||||
s->reg[I_(offset)]);
|
||||
return s->reg[I_(offset)];
|
||||
}
|
||||
|
||||
trace_exynos_uart_read(s->channel, offset, exynos4210_uart_regname(offset),
|
||||
0);
|
||||
return 0;
|
||||
}
|
||||
|
||||
|
@ -497,7 +554,6 @@ static int exynos4210_uart_can_receive(void *opaque)
|
|||
return fifo_empty_elements_number(&s->rx);
|
||||
}
|
||||
|
||||
|
||||
static void exynos4210_uart_receive(void *opaque, const uint8_t *buf, int size)
|
||||
{
|
||||
Exynos4210UartState *s = (Exynos4210UartState *)opaque;
|
||||
|
@ -505,24 +561,17 @@ static void exynos4210_uart_receive(void *opaque, const uint8_t *buf, int size)
|
|||
|
||||
if (s->reg[I_(UFCON)] & UFCON_FIFO_ENABLE) {
|
||||
if (fifo_empty_elements_number(&s->rx) < size) {
|
||||
for (i = 0; i < fifo_empty_elements_number(&s->rx); i++) {
|
||||
fifo_store(&s->rx, buf[i]);
|
||||
}
|
||||
size = fifo_empty_elements_number(&s->rx);
|
||||
s->reg[I_(UINTSP)] |= UINTSP_ERROR;
|
||||
s->reg[I_(UTRSTAT)] |= UTRSTAT_Rx_BUFFER_DATA_READY;
|
||||
} else {
|
||||
for (i = 0; i < size; i++) {
|
||||
fifo_store(&s->rx, buf[i]);
|
||||
}
|
||||
s->reg[I_(UTRSTAT)] |= UTRSTAT_Rx_BUFFER_DATA_READY;
|
||||
}
|
||||
/* XXX: Around here we maybe should check Rx trigger level */
|
||||
s->reg[I_(UINTSP)] |= UINTSP_RXD;
|
||||
for (i = 0; i < size; i++) {
|
||||
fifo_store(&s->rx, buf[i]);
|
||||
}
|
||||
exynos4210_uart_rx_timeout_set(s);
|
||||
} else {
|
||||
s->reg[I_(URXH)] = buf[0];
|
||||
s->reg[I_(UINTSP)] |= UINTSP_RXD;
|
||||
s->reg[I_(UTRSTAT)] |= UTRSTAT_Rx_BUFFER_DATA_READY;
|
||||
}
|
||||
s->reg[I_(UTRSTAT)] |= UTRSTAT_Rx_BUFFER_DATA_READY;
|
||||
|
||||
exynos4210_uart_update_irq(s);
|
||||
}
|
||||
|
@ -555,13 +604,24 @@ static void exynos4210_uart_reset(DeviceState *dev)
|
|||
fifo_reset(&s->rx);
|
||||
fifo_reset(&s->tx);
|
||||
|
||||
PRINT_DEBUG("UART%d: Rx FIFO size: %d\n", s->channel, s->rx.size);
|
||||
trace_exynos_uart_rxsize(s->channel, s->rx.size);
|
||||
}
|
||||
|
||||
static int exynos4210_uart_post_load(void *opaque, int version_id)
|
||||
{
|
||||
Exynos4210UartState *s = (Exynos4210UartState *)opaque;
|
||||
|
||||
exynos4210_uart_update_parameters(s);
|
||||
exynos4210_uart_rx_timeout_set(s);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
static const VMStateDescription vmstate_exynos4210_uart_fifo = {
|
||||
.name = "exynos4210.uart.fifo",
|
||||
.version_id = 1,
|
||||
.minimum_version_id = 1,
|
||||
.post_load = exynos4210_uart_post_load,
|
||||
.fields = (VMStateField[]) {
|
||||
VMSTATE_UINT32(sp, Exynos4210UartFIFO),
|
||||
VMSTATE_UINT32(rp, Exynos4210UartFIFO),
|
||||
|
@ -614,12 +674,17 @@ static void exynos4210_uart_init(Object *obj)
|
|||
SysBusDevice *dev = SYS_BUS_DEVICE(obj);
|
||||
Exynos4210UartState *s = EXYNOS4210_UART(dev);
|
||||
|
||||
s->fifo_timeout_timer = timer_new_ns(QEMU_CLOCK_VIRTUAL,
|
||||
exynos4210_uart_timeout_int, s);
|
||||
s->wordtime = NANOSECONDS_PER_SECOND * 10 / 9600;
|
||||
|
||||
/* memory mapping */
|
||||
memory_region_init_io(&s->iomem, obj, &exynos4210_uart_ops, s,
|
||||
"exynos4210.uart", EXYNOS4210_UART_REGS_MEM_SIZE);
|
||||
sysbus_init_mmio(dev, &s->iomem);
|
||||
|
||||
sysbus_init_irq(dev, &s->irq);
|
||||
sysbus_init_irq(dev, &s->dmairq);
|
||||
}
|
||||
|
||||
static void exynos4210_uart_realize(DeviceState *dev, Error **errp)
|
||||
|
|
|
@ -77,3 +77,23 @@ cmsdk_apb_uart_set_params(int speed) "CMSDK APB UART: params set to %d 8N1"
|
|||
# nrf51_uart.c
|
||||
nrf51_uart_read(uint64_t addr, uint64_t r, unsigned int size) "addr 0x%" PRIx64 " value 0x%" PRIx64 " size %u"
|
||||
nrf51_uart_write(uint64_t addr, uint64_t value, unsigned int size) "addr 0x%" PRIx64 " value 0x%" PRIx64 " size %u"
|
||||
|
||||
# exynos4210_uart.c
|
||||
exynos_uart_dmabusy(uint32_t channel) "UART%d: DMA busy (Rx buffer empty)"
|
||||
exynos_uart_dmaready(uint32_t channel) "UART%d: DMA ready"
|
||||
exynos_uart_irq_raised(uint32_t channel, uint32_t reg) "UART%d: IRQ raised: 0x%08"PRIx32
|
||||
exynos_uart_irq_lowered(uint32_t channel) "UART%d: IRQ lowered"
|
||||
exynos_uart_update_params(uint32_t channel, int speed, uint8_t parity, int data, int stop, uint64_t wordtime) "UART%d: speed: %d, parity: %c, data bits: %d, stop bits: %d wordtime: %"PRId64"ns"
|
||||
exynos_uart_write(uint32_t channel, uint32_t offset, const char *name, uint64_t val) "UART%d: <0x%04x> %s <- 0x%" PRIx64
|
||||
exynos_uart_read(uint32_t channel, uint32_t offset, const char *name, uint64_t val) "UART%d: <0x%04x> %s -> 0x%" PRIx64
|
||||
exynos_uart_rx_fifo_reset(uint32_t channel) "UART%d: Rx FIFO Reset"
|
||||
exynos_uart_tx_fifo_reset(uint32_t channel) "UART%d: Tx FIFO Reset"
|
||||
exynos_uart_tx(uint32_t channel, uint8_t ch) "UART%d: Tx 0x%02"PRIx32
|
||||
exynos_uart_intclr(uint32_t channel, uint32_t reg) "UART%d: interrupts cleared: 0x%08"PRIx32
|
||||
exynos_uart_ro_write(uint32_t channel, const char *name, uint32_t reg) "UART%d: Trying to write into RO register: %s [0x%04"PRIx32"]"
|
||||
exynos_uart_rx(uint32_t channel, uint8_t ch) "UART%d: Rx 0x%02"PRIx32
|
||||
exynos_uart_rx_error(uint32_t channel) "UART%d: Rx error"
|
||||
exynos_uart_wo_read(uint32_t channel, const char *name, uint32_t reg) "UART%d: Trying to read from WO register: %s [0x%04"PRIx32"]"
|
||||
exynos_uart_rxsize(uint32_t channel, uint32_t size) "UART%d: Rx FIFO size: %d"
|
||||
exynos_uart_channel_error(uint32_t channel) "Wrong UART channel number: %d"
|
||||
exynos_uart_rx_timeout(uint32_t channel, uint32_t stat, uint32_t intsp) "UART%d: Rx timeout stat=0x%x intsp=0x%x"
|
||||
|
|
|
@ -25,19 +25,12 @@
|
|||
#include "sysemu/dma.h"
|
||||
#include "qemu/log.h"
|
||||
#include "qemu/module.h"
|
||||
#include "trace.h"
|
||||
|
||||
#ifndef PL330_ERR_DEBUG
|
||||
#define PL330_ERR_DEBUG 0
|
||||
#endif
|
||||
|
||||
#define DB_PRINT_L(lvl, fmt, args...) do {\
|
||||
if (PL330_ERR_DEBUG >= lvl) {\
|
||||
fprintf(stderr, "PL330: %s:" fmt, __func__, ## args);\
|
||||
} \
|
||||
} while (0)
|
||||
|
||||
#define DB_PRINT(fmt, args...) DB_PRINT_L(1, fmt, ## args)
|
||||
|
||||
#define PL330_PERIPH_NUM 32
|
||||
#define PL330_MAX_BURST_LEN 128
|
||||
#define PL330_INSN_MAXSIZE 6
|
||||
|
@ -319,6 +312,26 @@ typedef struct PL330InsnDesc {
|
|||
void (*exec)(PL330Chan *, uint8_t opcode, uint8_t *args, int len);
|
||||
} PL330InsnDesc;
|
||||
|
||||
static void pl330_hexdump(uint8_t *buf, size_t size)
|
||||
{
|
||||
unsigned int b, i, len;
|
||||
char tmpbuf[80];
|
||||
|
||||
for (b = 0; b < size; b += 16) {
|
||||
len = size - b;
|
||||
if (len > 16) {
|
||||
len = 16;
|
||||
}
|
||||
tmpbuf[0] = '\0';
|
||||
for (i = 0; i < len; i++) {
|
||||
if ((i % 4) == 0) {
|
||||
strcat(tmpbuf, " ");
|
||||
}
|
||||
sprintf(tmpbuf + strlen(tmpbuf), " %02x", buf[b + i]);
|
||||
}
|
||||
trace_pl330_hexdump(b, tmpbuf);
|
||||
}
|
||||
}
|
||||
|
||||
/* MFIFO Implementation
|
||||
*
|
||||
|
@ -582,7 +595,7 @@ static inline void pl330_queue_remove_tagged(PL330Queue *s, uint8_t tag)
|
|||
|
||||
static inline void pl330_fault(PL330Chan *ch, uint32_t flags)
|
||||
{
|
||||
DB_PRINT("ch: %p, flags: %" PRIx32 "\n", ch, flags);
|
||||
trace_pl330_fault(ch, flags);
|
||||
ch->fault_type |= flags;
|
||||
if (ch->state == pl330_chan_fault) {
|
||||
return;
|
||||
|
@ -590,7 +603,7 @@ static inline void pl330_fault(PL330Chan *ch, uint32_t flags)
|
|||
ch->state = pl330_chan_fault;
|
||||
ch->parent->num_faulting++;
|
||||
if (ch->parent->num_faulting == 1) {
|
||||
DB_PRINT("abort interrupt raised\n");
|
||||
trace_pl330_fault_abort();
|
||||
qemu_irq_raise(ch->parent->irq_abort);
|
||||
}
|
||||
}
|
||||
|
@ -648,7 +661,7 @@ static void pl330_dmaend(PL330Chan *ch, uint8_t opcode,
|
|||
return;
|
||||
}
|
||||
}
|
||||
DB_PRINT("DMA ending!\n");
|
||||
trace_pl330_dmaend();
|
||||
pl330_fifo_tagged_remove(&s->fifo, ch->tag);
|
||||
pl330_queue_remove_tagged(&s->read_queue, ch->tag);
|
||||
pl330_queue_remove_tagged(&s->write_queue, ch->tag);
|
||||
|
@ -683,7 +696,7 @@ static void pl330_dmago(PL330Chan *ch, uint8_t opcode, uint8_t *args, int len)
|
|||
uint32_t pc;
|
||||
PL330Chan *s;
|
||||
|
||||
DB_PRINT("\n");
|
||||
trace_pl330_dmago();
|
||||
|
||||
if (!ch->is_manager) {
|
||||
pl330_fault(ch, PL330_FAULT_UNDEF_INSTR);
|
||||
|
@ -740,9 +753,7 @@ static void pl330_dmald(PL330Chan *ch, uint8_t opcode, uint8_t *args, int len)
|
|||
ch->stall = pl330_queue_put_insn(&ch->parent->read_queue, ch->src,
|
||||
size, num, inc, 0, ch->tag);
|
||||
if (!ch->stall) {
|
||||
DB_PRINT("channel:%" PRId8 " address:%08" PRIx32 " size:%" PRIx32
|
||||
" num:%" PRId32 " %c\n",
|
||||
ch->tag, ch->src, size, num, inc ? 'Y' : 'N');
|
||||
trace_pl330_dmald(ch->tag, ch->src, size, num, inc ? 'Y' : 'N');
|
||||
ch->src += inc ? size * num - (ch->src & (size - 1)) : 0;
|
||||
}
|
||||
}
|
||||
|
@ -782,7 +793,7 @@ static void pl330_dmakill(PL330Chan *ch, uint8_t opcode, uint8_t *args, int len)
|
|||
ch->fault_type = 0;
|
||||
ch->parent->num_faulting--;
|
||||
if (ch->parent->num_faulting == 0) {
|
||||
DB_PRINT("abort interrupt lowered\n");
|
||||
trace_pl330_dmakill();
|
||||
qemu_irq_lower(ch->parent->irq_abort);
|
||||
}
|
||||
}
|
||||
|
@ -800,6 +811,8 @@ static void pl330_dmalpend(PL330Chan *ch, uint8_t opcode,
|
|||
uint8_t bs = opcode & 3;
|
||||
uint8_t lc = (opcode & 4) >> 2;
|
||||
|
||||
trace_pl330_dmalpend(nf, bs, lc, ch->lc[lc], ch->request_flag);
|
||||
|
||||
if (bs == 2) {
|
||||
pl330_fault(ch, PL330_FAULT_OPERAND_INVALID);
|
||||
return;
|
||||
|
@ -813,12 +826,12 @@ static void pl330_dmalpend(PL330Chan *ch, uint8_t opcode,
|
|||
if (nf) {
|
||||
ch->lc[lc]--;
|
||||
}
|
||||
DB_PRINT("loop reiteration\n");
|
||||
trace_pl330_dmalpiter();
|
||||
ch->pc -= args[0];
|
||||
ch->pc -= len + 1;
|
||||
/* "ch->pc -= args[0] + len + 1" is incorrect when args[0] == 256 */
|
||||
} else {
|
||||
DB_PRINT("loop fallthrough\n");
|
||||
trace_pl330_dmalpfallthrough();
|
||||
}
|
||||
}
|
||||
|
||||
|
@ -886,10 +899,10 @@ static void pl330_dmasev(PL330Chan *ch, uint8_t opcode, uint8_t *args, int len)
|
|||
}
|
||||
if (ch->parent->inten & (1 << ev_id)) {
|
||||
ch->parent->int_status |= (1 << ev_id);
|
||||
DB_PRINT("event interrupt raised %" PRId8 "\n", ev_id);
|
||||
trace_pl330_dmasev_evirq(ev_id);
|
||||
qemu_irq_raise(ch->parent->irq[ev_id]);
|
||||
}
|
||||
DB_PRINT("event raised %" PRId8 "\n", ev_id);
|
||||
trace_pl330_dmasev_event(ev_id);
|
||||
ch->parent->ev_status |= (1 << ev_id);
|
||||
}
|
||||
|
||||
|
@ -914,9 +927,7 @@ static void pl330_dmast(PL330Chan *ch, uint8_t opcode, uint8_t *args, int len)
|
|||
ch->stall = pl330_queue_put_insn(&ch->parent->write_queue, ch->dst,
|
||||
size, num, inc, 0, ch->tag);
|
||||
if (!ch->stall) {
|
||||
DB_PRINT("channel:%" PRId8 " address:%08" PRIx32 " size:%" PRIx32
|
||||
" num:%" PRId32 " %c\n",
|
||||
ch->tag, ch->dst, size, num, inc ? 'Y' : 'N');
|
||||
trace_pl330_dmast(ch->tag, ch->dst, size, num, inc ? 'Y' : 'N');
|
||||
ch->dst += inc ? size * num - (ch->dst & (size - 1)) : 0;
|
||||
}
|
||||
}
|
||||
|
@ -992,7 +1003,7 @@ static void pl330_dmawfe(PL330Chan *ch, uint8_t opcode,
|
|||
}
|
||||
}
|
||||
ch->parent->ev_status &= ~(1 << ev_id);
|
||||
DB_PRINT("event lowered %" PRIx8 "\n", ev_id);
|
||||
trace_pl330_dmawfe(ev_id);
|
||||
} else {
|
||||
ch->stall = 1;
|
||||
}
|
||||
|
@ -1135,7 +1146,7 @@ static int pl330_chan_exec(PL330Chan *ch)
|
|||
ch->stall = 0;
|
||||
insn = pl330_fetch_insn(ch);
|
||||
if (!insn) {
|
||||
DB_PRINT("pl330 undefined instruction\n");
|
||||
trace_pl330_chan_exec_undef();
|
||||
pl330_fault(ch, PL330_FAULT_UNDEF_INSTR);
|
||||
return 0;
|
||||
}
|
||||
|
@ -1175,10 +1186,9 @@ static int pl330_exec_cycle(PL330Chan *channel)
|
|||
int len = q->len - (q->addr & (q->len - 1));
|
||||
|
||||
dma_memory_read(&address_space_memory, q->addr, buf, len);
|
||||
if (PL330_ERR_DEBUG > 1) {
|
||||
DB_PRINT("PL330 read from memory @%08" PRIx32 " (size = %08x):\n",
|
||||
q->addr, len);
|
||||
qemu_hexdump((char *)buf, stderr, "", len);
|
||||
trace_pl330_exec_cycle(q->addr, len);
|
||||
if (trace_event_get_state_backends(TRACE_PL330_HEXDUMP)) {
|
||||
pl330_hexdump(buf, len);
|
||||
}
|
||||
fifo_res = pl330_fifo_push(&s->fifo, buf, len, q->tag);
|
||||
if (fifo_res == PL330_FIFO_OK) {
|
||||
|
@ -1207,10 +1217,9 @@ static int pl330_exec_cycle(PL330Chan *channel)
|
|||
}
|
||||
if (fifo_res == PL330_FIFO_OK || q->z) {
|
||||
dma_memory_write(&address_space_memory, q->addr, buf, len);
|
||||
if (PL330_ERR_DEBUG > 1) {
|
||||
DB_PRINT("PL330 read from memory @%08" PRIx32
|
||||
" (size = %08x):\n", q->addr, len);
|
||||
qemu_hexdump((char *)buf, stderr, "", len);
|
||||
trace_pl330_exec_cycle(q->addr, len);
|
||||
if (trace_event_get_state_backends(TRACE_PL330_HEXDUMP)) {
|
||||
pl330_hexdump(buf, len);
|
||||
}
|
||||
if (q->inc) {
|
||||
q->addr += len;
|
||||
|
@ -1252,8 +1261,8 @@ static int pl330_exec_channel(PL330Chan *channel)
|
|||
|
||||
static inline void pl330_exec(PL330State *s)
|
||||
{
|
||||
DB_PRINT("\n");
|
||||
int i, insr_exec;
|
||||
trace_pl330_exec();
|
||||
do {
|
||||
insr_exec = pl330_exec_channel(&s->manager);
|
||||
|
||||
|
@ -1298,7 +1307,7 @@ static void pl330_debug_exec(PL330State *s)
|
|||
args[2] = (s->dbg[1] >> 8) & 0xff;
|
||||
args[3] = (s->dbg[1] >> 16) & 0xff;
|
||||
args[4] = (s->dbg[1] >> 24) & 0xff;
|
||||
DB_PRINT("chan id: %" PRIx8 "\n", chan_id);
|
||||
trace_pl330_debug_exec(chan_id);
|
||||
if (s->dbg[0] & 1) {
|
||||
ch = &s->chan[chan_id];
|
||||
} else {
|
||||
|
@ -1320,6 +1329,7 @@ static void pl330_debug_exec(PL330State *s)
|
|||
ch->fault_type |= PL330_FAULT_DBG_INSTR;
|
||||
}
|
||||
if (ch->stall) {
|
||||
trace_pl330_debug_exec_stall();
|
||||
qemu_log_mask(LOG_UNIMP, "pl330: stall of debug instruction not "
|
||||
"implemented\n");
|
||||
}
|
||||
|
@ -1334,7 +1344,7 @@ static void pl330_iomem_write(void *opaque, hwaddr offset,
|
|||
PL330State *s = (PL330State *) opaque;
|
||||
int i;
|
||||
|
||||
DB_PRINT("addr: %08x data: %08x\n", (unsigned)offset, (unsigned)value);
|
||||
trace_pl330_iomem_write((unsigned)offset, (unsigned)value);
|
||||
|
||||
switch (offset) {
|
||||
case PL330_REG_INTEN:
|
||||
|
@ -1343,7 +1353,7 @@ static void pl330_iomem_write(void *opaque, hwaddr offset,
|
|||
case PL330_REG_INTCLR:
|
||||
for (i = 0; i < s->num_events; i++) {
|
||||
if (s->int_status & s->inten & value & (1 << i)) {
|
||||
DB_PRINT("event interrupt lowered %d\n", i);
|
||||
trace_pl330_iomem_write_clr(i);
|
||||
qemu_irq_lower(s->irq[i]);
|
||||
}
|
||||
}
|
||||
|
@ -1361,11 +1371,9 @@ static void pl330_iomem_write(void *opaque, hwaddr offset,
|
|||
}
|
||||
break;
|
||||
case PL330_REG_DBGINST0:
|
||||
DB_PRINT("s->dbg[0] = %08x\n", (unsigned)value);
|
||||
s->dbg[0] = value;
|
||||
break;
|
||||
case PL330_REG_DBGINST1:
|
||||
DB_PRINT("s->dbg[1] = %08x\n", (unsigned)value);
|
||||
s->dbg[1] = value;
|
||||
break;
|
||||
default:
|
||||
|
@ -1489,7 +1497,7 @@ static uint64_t pl330_iomem_read(void *opaque, hwaddr offset,
|
|||
unsigned size)
|
||||
{
|
||||
uint32_t ret = pl330_iomem_read_imp(opaque, offset);
|
||||
DB_PRINT("addr: %08" HWADDR_PRIx " data: %08" PRIx32 "\n", offset, ret);
|
||||
trace_pl330_iomem_read((uint32_t)offset, ret);
|
||||
return ret;
|
||||
}
|
||||
|
||||
|
|
|
@ -20,3 +20,27 @@ sparc32_dma_enable_lower(void) "Lower DMA enable"
|
|||
|
||||
# i8257.c
|
||||
i8257_unregistered_dma(int nchan, int dma_pos, int dma_len) "unregistered DMA channel used nchan=%d dma_pos=%d dma_len=%d"
|
||||
|
||||
# pl330.c
|
||||
pl330_fault(void *ptr, uint32_t flags) "ch: %p, flags: 0x%"PRIx32
|
||||
pl330_fault_abort(void) "abort interrupt raised"
|
||||
pl330_dmaend(void) "DMA ending"
|
||||
pl330_dmago(void) "DMA run"
|
||||
pl330_dmald(uint8_t chan, uint32_t addr, uint32_t size, uint32_t num, char ch) "channel:%"PRId8" address:0x%08"PRIx32" size:0x%"PRIx32" num:%"PRId32"%c"
|
||||
pl330_dmakill(void) "abort interrupt lowered"
|
||||
pl330_dmalpend(uint8_t nf, uint8_t bs, uint8_t lc, uint8_t ch, uint8_t flag) "nf=0x%02x bs=0x%02x lc=0x%02x ch=0x%02x flag=0x%02x"
|
||||
pl330_dmalpiter(void) "loop reiteration"
|
||||
pl330_dmalpfallthrough(void) "loop fallthrough"
|
||||
pl330_dmasev_evirq(uint8_t ev_id) "event interrupt raised %"PRId8
|
||||
pl330_dmasev_event(uint8_t ev_id) "event raised %"PRId8
|
||||
pl330_dmast(uint8_t chan, uint32_t addr, uint32_t sz, uint32_t num, char ch) "channel:%"PRId8" address:0x%08"PRIx32" size:0x%"PRIx32" num:%"PRId32" %c"
|
||||
pl330_dmawfe(uint8_t ev_id) "event lowered 0x%"PRIx8
|
||||
pl330_chan_exec_undef(void) "undefined instruction"
|
||||
pl330_exec_cycle(uint32_t addr, uint32_t size) "PL330 read from memory @0x%08"PRIx32" (size = 0x%08"PRIx32")"
|
||||
pl330_hexdump(uint32_t offset, char *str) " 0x%04"PRIx32":%s"
|
||||
pl330_exec(void) "pl330_exec"
|
||||
pl330_debug_exec(uint8_t ch) "chan id: 0x%"PRIx8
|
||||
pl330_debug_exec_stall(void) "stall of debug instruction not implemented"
|
||||
pl330_iomem_write(uint32_t offset, uint32_t value) "addr: 0x%08"PRIx32" data: 0x%08"PRIx32
|
||||
pl330_iomem_write_clr(int i) "event interrupt lowered %d"
|
||||
pl330_iomem_read(uint32_t addr, uint32_t data) "addr: 0x%08"PRIx32" data: 0x%08"PRIx32
|
||||
|
|
|
@ -47,7 +47,7 @@ static void stm32f4xx_syscfg_set_irq(void *opaque, int irq, int level)
|
|||
STM32F4xxSyscfgState *s = opaque;
|
||||
int icrreg = irq / 4;
|
||||
int startbit = (irq & 3) * 4;
|
||||
uint8_t config = config = irq / 16;
|
||||
uint8_t config = irq / 16;
|
||||
|
||||
trace_stm32f4xx_syscfg_set_irq(irq / 16, irq % 16, level);
|
||||
|
||||
|
|
|
@ -1650,6 +1650,7 @@ typedef struct elf64_shdr {
|
|||
#define NT_ARM_HW_BREAK 0x402 /* ARM hardware breakpoint registers */
|
||||
#define NT_ARM_HW_WATCH 0x403 /* ARM hardware watchpoint registers */
|
||||
#define NT_ARM_SYSTEM_CALL 0x404 /* ARM system call number */
|
||||
#define NT_ARM_SVE 0x405 /* ARM Scalable Vector Extension regs */
|
||||
|
||||
/*
|
||||
* Physical entry point into the kernel.
|
||||
|
|
|
@ -24,6 +24,7 @@
|
|||
#ifndef EXYNOS4210_H
|
||||
#define EXYNOS4210_H
|
||||
|
||||
#include "hw/or-irq.h"
|
||||
#include "hw/sysbus.h"
|
||||
#include "target/arm/cpu-qom.h"
|
||||
|
||||
|
@ -74,6 +75,8 @@
|
|||
|
||||
#define EXYNOS4210_I2C_NUMBER 9
|
||||
|
||||
#define EXYNOS4210_NUM_DMA 3
|
||||
|
||||
typedef struct Exynos4210Irq {
|
||||
qemu_irq int_combiner_irq[EXYNOS4210_MAX_INT_COMBINER_IN_IRQ];
|
||||
qemu_irq ext_combiner_irq[EXYNOS4210_MAX_EXT_COMBINER_IN_IRQ];
|
||||
|
@ -97,6 +100,7 @@ typedef struct Exynos4210State {
|
|||
MemoryRegion boot_secondary;
|
||||
MemoryRegion bootreg_mem;
|
||||
I2CBus *i2c_if[EXYNOS4210_I2C_NUMBER];
|
||||
qemu_or_irq pl330_irq_orgate[EXYNOS4210_NUM_DMA];
|
||||
} Exynos4210State;
|
||||
|
||||
#define TYPE_EXYNOS4210_SOC "exynos4210"
|
||||
|
|
|
@ -33,7 +33,7 @@
|
|||
/* This can safely be increased if necessary without breaking
|
||||
* migration compatibility (as long as it remains greater than 15).
|
||||
*/
|
||||
#define MAX_OR_LINES 32
|
||||
#define MAX_OR_LINES 48
|
||||
|
||||
typedef struct OrIRQState qemu_or_irq;
|
||||
|
||||
|
|
|
@ -633,17 +633,6 @@ encrypted disk images.
|
|||
* disk_images_snapshot_mode:: Snapshot mode
|
||||
* vm_snapshots:: VM snapshots
|
||||
* qemu_img_invocation:: qemu-img Invocation
|
||||
* qemu_nbd_invocation:: qemu-nbd Invocation
|
||||
* disk_images_formats:: Disk image file formats
|
||||
* host_drives:: Using host drives
|
||||
* disk_images_fat_images:: Virtual FAT disk images
|
||||
* disk_images_nbd:: NBD access
|
||||
* disk_images_sheepdog:: Sheepdog disk images
|
||||
* disk_images_iscsi:: iSCSI LUNs
|
||||
* disk_images_gluster:: GlusterFS disk images
|
||||
* disk_images_ssh:: Secure Shell (ssh) disk images
|
||||
* disk_images_nvme:: NVMe userspace driver
|
||||
* disk_image_locking:: Disk image file locking
|
||||
@end menu
|
||||
|
||||
@node disk_images_quickstart
|
||||
|
@ -724,13 +713,6 @@ state is not saved or restored properly (in particular USB).
|
|||
|
||||
@include qemu-img.texi
|
||||
|
||||
@node qemu_nbd_invocation
|
||||
@subsection @code{qemu-nbd} Invocation
|
||||
|
||||
@include qemu-nbd.texi
|
||||
|
||||
@include docs/qemu-block-drivers.texi
|
||||
|
||||
@node pcsys_network
|
||||
@section Network emulation
|
||||
|
||||
|
|
214
qemu-nbd.texi
214
qemu-nbd.texi
|
@ -1,214 +0,0 @@
|
|||
@example
|
||||
@c man begin SYNOPSIS
|
||||
@command{qemu-nbd} [OPTION]... @var{filename}
|
||||
|
||||
@command{qemu-nbd} @option{-L} [OPTION]...
|
||||
|
||||
@command{qemu-nbd} @option{-d} @var{dev}
|
||||
@c man end
|
||||
@end example
|
||||
|
||||
@c man begin DESCRIPTION
|
||||
|
||||
Export a QEMU disk image using the NBD protocol.
|
||||
|
||||
Other uses:
|
||||
@itemize
|
||||
@item
|
||||
Bind a /dev/nbdX block device to a QEMU server (on Linux).
|
||||
@item
|
||||
As a client to query exports of a remote NBD server.
|
||||
@end itemize
|
||||
|
||||
@c man end
|
||||
|
||||
@c man begin OPTIONS
|
||||
@var{filename} is a disk image filename, or a set of block
|
||||
driver options if @option{--image-opts} is specified.
|
||||
|
||||
@var{dev} is an NBD device.
|
||||
|
||||
@table @option
|
||||
@item --object type,id=@var{id},...props...
|
||||
Define a new instance of the @var{type} object class identified by @var{id}.
|
||||
See the @code{qemu(1)} manual page for full details of the properties
|
||||
supported. The common object types that it makes sense to define are the
|
||||
@code{secret} object, which is used to supply passwords and/or encryption
|
||||
keys, and the @code{tls-creds} object, which is used to supply TLS
|
||||
credentials for the qemu-nbd server or client.
|
||||
@item -p, --port=@var{port}
|
||||
The TCP port to listen on as a server, or connect to as a client
|
||||
(default @samp{10809}).
|
||||
@item -o, --offset=@var{offset}
|
||||
The offset into the image.
|
||||
@item -b, --bind=@var{iface}
|
||||
The interface to bind to as a server, or connect to as a client
|
||||
(default @samp{0.0.0.0}).
|
||||
@item -k, --socket=@var{path}
|
||||
Use a unix socket with path @var{path}.
|
||||
@item --image-opts
|
||||
Treat @var{filename} as a set of image options, instead of a plain
|
||||
filename. If this flag is specified, the @var{-f} flag should
|
||||
not be used, instead the '@code{format=}' option should be set.
|
||||
@item -f, --format=@var{fmt}
|
||||
Force the use of the block driver for format @var{fmt} instead of
|
||||
auto-detecting.
|
||||
@item -r, --read-only
|
||||
Export the disk as read-only.
|
||||
@item -P, --partition=@var{num}
|
||||
Deprecated: Only expose MBR partition @var{num}. Understands physical
|
||||
partitions 1-4 and logical partition 5. New code should instead use
|
||||
@option{--image-opts} with the raw driver wrapping a subset of the
|
||||
original image.
|
||||
@item -B, --bitmap=@var{name}
|
||||
If @var{filename} has a qcow2 persistent bitmap @var{name}, expose
|
||||
that bitmap via the ``qemu:dirty-bitmap:@var{name}'' context
|
||||
accessible through NBD_OPT_SET_META_CONTEXT.
|
||||
@item -s, --snapshot
|
||||
Use @var{filename} as an external snapshot, create a temporary
|
||||
file with backing_file=@var{filename}, redirect the write to
|
||||
the temporary one.
|
||||
@item -l, --load-snapshot=@var{snapshot_param}
|
||||
Load an internal snapshot inside @var{filename} and export it
|
||||
as an read-only device, @var{snapshot_param} format is
|
||||
'snapshot.id=[ID],snapshot.name=[NAME]' or '[ID_OR_NAME]'
|
||||
@item -n, --nocache
|
||||
@itemx --cache=@var{cache}
|
||||
The cache mode to be used with the file. See the documentation of
|
||||
the emulator's @code{-drive cache=...} option for allowed values.
|
||||
@item --aio=@var{aio}
|
||||
Set the asynchronous I/O mode between @samp{threads} (the default)
|
||||
and @samp{native} (Linux only).
|
||||
@item --discard=@var{discard}
|
||||
Control whether @dfn{discard} (also known as @dfn{trim} or @dfn{unmap})
|
||||
requests are ignored or passed to the filesystem. @var{discard} is one of
|
||||
@samp{ignore} (or @samp{off}), @samp{unmap} (or @samp{on}). The default is
|
||||
@samp{ignore}.
|
||||
@item --detect-zeroes=@var{detect-zeroes}
|
||||
Control the automatic conversion of plain zero writes by the OS to
|
||||
driver-specific optimized zero write commands. @var{detect-zeroes} is one of
|
||||
@samp{off}, @samp{on} or @samp{unmap}. @samp{unmap}
|
||||
converts a zero write to an unmap operation and can only be used if
|
||||
@var{discard} is set to @samp{unmap}. The default is @samp{off}.
|
||||
@item -c, --connect=@var{dev}
|
||||
Connect @var{filename} to NBD device @var{dev} (Linux only).
|
||||
@item -d, --disconnect
|
||||
Disconnect the device @var{dev} (Linux only).
|
||||
@item -e, --shared=@var{num}
|
||||
Allow up to @var{num} clients to share the device (default
|
||||
@samp{1}). Safe for readers, but for now, consistency is not
|
||||
guaranteed between multiple writers.
|
||||
@item -t, --persistent
|
||||
Don't exit on the last connection.
|
||||
@item -x, --export-name=@var{name}
|
||||
Set the NBD volume export name (default of a zero-length string).
|
||||
@item -D, --description=@var{description}
|
||||
Set the NBD volume export description, as a human-readable
|
||||
string.
|
||||
@item -L, --list
|
||||
Connect as a client and list all details about the exports exposed by
|
||||
a remote NBD server. This enables list mode, and is incompatible
|
||||
with options that change behavior related to a specific export (such as
|
||||
@option{--export-name}, @option{--offset}, ...).
|
||||
@item --tls-creds=ID
|
||||
Enable mandatory TLS encryption for the server by setting the ID
|
||||
of the TLS credentials object previously created with the --object
|
||||
option; or provide the credentials needed for connecting as a client
|
||||
in list mode.
|
||||
@item --fork
|
||||
Fork off the server process and exit the parent once the server is running.
|
||||
@item --pid-file=PATH
|
||||
Store the server's process ID in the given file.
|
||||
@item --tls-authz=ID
|
||||
Specify the ID of a qauthz object previously created with the
|
||||
--object option. This will be used to authorize connecting users
|
||||
against their x509 distinguished name.
|
||||
@item -v, --verbose
|
||||
Display extra debugging information.
|
||||
@item -h, --help
|
||||
Display this help and exit.
|
||||
@item -V, --version
|
||||
Display version information and exit.
|
||||
@item -T, --trace [[enable=]@var{pattern}][,events=@var{file}][,file=@var{file}]
|
||||
@findex --trace
|
||||
@include qemu-option-trace.texi
|
||||
@end table
|
||||
|
||||
@c man end
|
||||
|
||||
@c man begin EXAMPLES
|
||||
Start a server listening on port 10809 that exposes only the
|
||||
guest-visible contents of a qcow2 file, with no TLS encryption, and
|
||||
with the default export name (an empty string). The command is
|
||||
one-shot, and will block until the first successful client
|
||||
disconnects:
|
||||
|
||||
@example
|
||||
qemu-nbd -f qcow2 file.qcow2
|
||||
@end example
|
||||
|
||||
Start a long-running server listening with encryption on port 10810,
|
||||
and whitelist clients with a specific X.509 certificate to connect to
|
||||
a 1 megabyte subset of a raw file, using the export name 'subset':
|
||||
|
||||
@example
|
||||
qemu-nbd \
|
||||
--object tls-creds-x509,id=tls0,endpoint=server,dir=/path/to/qemutls \
|
||||
--object 'authz-simple,id=auth0,identity=CN=laptop.example.com,,\
|
||||
O=Example Org,,L=London,,ST=London,,C=GB' \
|
||||
--tls-creds tls0 --tls-authz auth0 \
|
||||
-t -x subset -p 10810 \
|
||||
--image-opts driver=raw,offset=1M,size=1M,file.driver=file,file.filename=file.raw
|
||||
@end example
|
||||
|
||||
Serve a read-only copy of just the first MBR partition of a guest
|
||||
image over a Unix socket with as many as 5 simultaneous readers, with
|
||||
a persistent process forked as a daemon:
|
||||
|
||||
@example
|
||||
qemu-nbd --fork --persistent --shared=5 --socket=/path/to/sock \
|
||||
--partition=1 --read-only --format=qcow2 file.qcow2
|
||||
@end example
|
||||
|
||||
Expose the guest-visible contents of a qcow2 file via a block device
|
||||
/dev/nbd0 (and possibly creating /dev/nbd0p1 and friends for
|
||||
partitions found within), then disconnect the device when done.
|
||||
Access to bind qemu-nbd to an /dev/nbd device generally requires root
|
||||
privileges, and may also require the execution of @code{modprobe nbd}
|
||||
to enable the kernel NBD client module. @emph{CAUTION}: Do not use
|
||||
this method to mount filesystems from an untrusted guest image - a
|
||||
malicious guest may have prepared the image to attempt to trigger
|
||||
kernel bugs in partition probing or file system mounting.
|
||||
|
||||
@example
|
||||
qemu-nbd -c /dev/nbd0 -f qcow2 file.qcow2
|
||||
qemu-nbd -d /dev/nbd0
|
||||
@end example
|
||||
|
||||
Query a remote server to see details about what export(s) it is
|
||||
serving on port 10809, and authenticating via PSK:
|
||||
|
||||
@example
|
||||
qemu-nbd \
|
||||
--object tls-creds-psk,id=tls0,dir=/tmp/keys,username=eblake,endpoint=client \
|
||||
--tls-creds tls0 -L -b remote.example.com
|
||||
@end example
|
||||
|
||||
@c man end
|
||||
|
||||
@ignore
|
||||
|
||||
@setfilename qemu-nbd
|
||||
@settitle QEMU Disk Network Block Device Server
|
||||
|
||||
@c man begin AUTHOR
|
||||
Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>.
|
||||
This is free software; see the source for copying conditions. There is NO
|
||||
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
|
||||
@c man end
|
||||
|
||||
@c man begin SEEALSO
|
||||
qemu(1), qemu-img(1)
|
||||
@c man end
|
||||
|
||||
@end ignore
|
|
@ -1,3 +1,7 @@
|
|||
@c The contents of this file must be kept in sync with qemu-option-trace.rst.inc
|
||||
@c until all the users of the texi file have been converted to rst and
|
||||
@c the texi file can be removed.
|
||||
|
||||
Specify tracing options.
|
||||
|
||||
@table @option
|
||||
|
|
|
@ -953,7 +953,7 @@ STEXI
|
|||
@findex -cdrom
|
||||
Use @var{file} as CD-ROM image (you cannot use @option{-hdc} and
|
||||
@option{-cdrom} at the same time). You can use the host CD-ROM by
|
||||
using @file{/dev/cdrom} as filename (@pxref{host_drives}).
|
||||
using @file{/dev/cdrom} as filename.
|
||||
ETEXI
|
||||
|
||||
DEF("blockdev", HAS_ARG, QEMU_OPTION_blockdev,
|
||||
|
|
|
@ -62,12 +62,23 @@ struct aarch64_user_vfp_state {
|
|||
|
||||
QEMU_BUILD_BUG_ON(sizeof(struct aarch64_user_vfp_state) != 528);
|
||||
|
||||
/* struct user_sve_header from arch/arm64/include/uapi/asm/ptrace.h */
|
||||
struct aarch64_user_sve_header {
|
||||
uint32_t size;
|
||||
uint32_t max_size;
|
||||
uint16_t vl;
|
||||
uint16_t max_vl;
|
||||
uint16_t flags;
|
||||
uint16_t reserved;
|
||||
} QEMU_PACKED;
|
||||
|
||||
struct aarch64_note {
|
||||
Elf64_Nhdr hdr;
|
||||
char name[8]; /* align_up(sizeof("CORE"), 4) */
|
||||
union {
|
||||
struct aarch64_elf_prstatus prstatus;
|
||||
struct aarch64_user_vfp_state vfp;
|
||||
struct aarch64_user_sve_header sve;
|
||||
};
|
||||
} QEMU_PACKED;
|
||||
|
||||
|
@ -76,6 +87,8 @@ struct aarch64_note {
|
|||
(AARCH64_NOTE_HEADER_SIZE + sizeof(struct aarch64_elf_prstatus))
|
||||
#define AARCH64_PRFPREG_NOTE_SIZE \
|
||||
(AARCH64_NOTE_HEADER_SIZE + sizeof(struct aarch64_user_vfp_state))
|
||||
#define AARCH64_SVE_NOTE_SIZE(env) \
|
||||
(AARCH64_NOTE_HEADER_SIZE + sve_size(env))
|
||||
|
||||
static void aarch64_note_init(struct aarch64_note *note, DumpState *s,
|
||||
const char *name, Elf64_Word namesz,
|
||||
|
@ -128,11 +141,102 @@ static int aarch64_write_elf64_prfpreg(WriteCoreDumpFunction f,
|
|||
return 0;
|
||||
}
|
||||
|
||||
#ifdef TARGET_AARCH64
|
||||
static off_t sve_zreg_offset(uint32_t vq, int n)
|
||||
{
|
||||
off_t off = sizeof(struct aarch64_user_sve_header);
|
||||
return ROUND_UP(off, 16) + vq * 16 * n;
|
||||
}
|
||||
|
||||
static off_t sve_preg_offset(uint32_t vq, int n)
|
||||
{
|
||||
return sve_zreg_offset(vq, 32) + vq * 16 / 8 * n;
|
||||
}
|
||||
|
||||
static off_t sve_fpsr_offset(uint32_t vq)
|
||||
{
|
||||
off_t off = sve_preg_offset(vq, 17);
|
||||
return ROUND_UP(off, 16);
|
||||
}
|
||||
|
||||
static off_t sve_fpcr_offset(uint32_t vq)
|
||||
{
|
||||
return sve_fpsr_offset(vq) + sizeof(uint32_t);
|
||||
}
|
||||
|
||||
static uint32_t sve_current_vq(CPUARMState *env)
|
||||
{
|
||||
return sve_zcr_len_for_el(env, arm_current_el(env)) + 1;
|
||||
}
|
||||
|
||||
static size_t sve_size_vq(uint32_t vq)
|
||||
{
|
||||
off_t off = sve_fpcr_offset(vq) + sizeof(uint32_t);
|
||||
return ROUND_UP(off, 16);
|
||||
}
|
||||
|
||||
static size_t sve_size(CPUARMState *env)
|
||||
{
|
||||
return sve_size_vq(sve_current_vq(env));
|
||||
}
|
||||
|
||||
static int aarch64_write_elf64_sve(WriteCoreDumpFunction f,
|
||||
CPUARMState *env, int cpuid,
|
||||
DumpState *s)
|
||||
{
|
||||
struct aarch64_note *note;
|
||||
ARMCPU *cpu = env_archcpu(env);
|
||||
uint32_t vq = sve_current_vq(env);
|
||||
uint64_t tmp[ARM_MAX_VQ * 2], *r;
|
||||
uint32_t fpr;
|
||||
uint8_t *buf;
|
||||
int ret, i;
|
||||
|
||||
note = g_malloc0(AARCH64_SVE_NOTE_SIZE(env));
|
||||
buf = (uint8_t *)¬e->sve;
|
||||
|
||||
aarch64_note_init(note, s, "LINUX", 6, NT_ARM_SVE, sve_size_vq(vq));
|
||||
|
||||
note->sve.size = cpu_to_dump32(s, sve_size_vq(vq));
|
||||
note->sve.max_size = cpu_to_dump32(s, sve_size_vq(cpu->sve_max_vq));
|
||||
note->sve.vl = cpu_to_dump16(s, vq * 16);
|
||||
note->sve.max_vl = cpu_to_dump16(s, cpu->sve_max_vq * 16);
|
||||
note->sve.flags = cpu_to_dump16(s, 1);
|
||||
|
||||
for (i = 0; i < 32; ++i) {
|
||||
r = sve_bswap64(tmp, &env->vfp.zregs[i].d[0], vq * 2);
|
||||
memcpy(&buf[sve_zreg_offset(vq, i)], r, vq * 16);
|
||||
}
|
||||
|
||||
for (i = 0; i < 17; ++i) {
|
||||
r = sve_bswap64(tmp, r = &env->vfp.pregs[i].p[0],
|
||||
DIV_ROUND_UP(vq * 2, 8));
|
||||
memcpy(&buf[sve_preg_offset(vq, i)], r, vq * 16 / 8);
|
||||
}
|
||||
|
||||
fpr = cpu_to_dump32(s, vfp_get_fpsr(env));
|
||||
memcpy(&buf[sve_fpsr_offset(vq)], &fpr, sizeof(uint32_t));
|
||||
|
||||
fpr = cpu_to_dump32(s, vfp_get_fpcr(env));
|
||||
memcpy(&buf[sve_fpcr_offset(vq)], &fpr, sizeof(uint32_t));
|
||||
|
||||
ret = f(note, AARCH64_SVE_NOTE_SIZE(env), s);
|
||||
g_free(note);
|
||||
|
||||
if (ret < 0) {
|
||||
return -1;
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
#endif
|
||||
|
||||
int arm_cpu_write_elf64_note(WriteCoreDumpFunction f, CPUState *cs,
|
||||
int cpuid, void *opaque)
|
||||
{
|
||||
struct aarch64_note note;
|
||||
CPUARMState *env = &ARM_CPU(cs)->env;
|
||||
ARMCPU *cpu = ARM_CPU(cs);
|
||||
CPUARMState *env = &cpu->env;
|
||||
DumpState *s = opaque;
|
||||
uint64_t pstate, sp;
|
||||
int ret, i;
|
||||
|
@ -163,7 +267,18 @@ int arm_cpu_write_elf64_note(WriteCoreDumpFunction f, CPUState *cs,
|
|||
return -1;
|
||||
}
|
||||
|
||||
return aarch64_write_elf64_prfpreg(f, env, cpuid, s);
|
||||
ret = aarch64_write_elf64_prfpreg(f, env, cpuid, s);
|
||||
if (ret) {
|
||||
return ret;
|
||||
}
|
||||
|
||||
#ifdef TARGET_AARCH64
|
||||
if (cpu_isar_feature(aa64_sve, cpu)) {
|
||||
ret = aarch64_write_elf64_sve(f, env, cpuid, s);
|
||||
}
|
||||
#endif
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
/* struct pt_regs from arch/arm/include/asm/ptrace.h */
|
||||
|
@ -335,6 +450,11 @@ ssize_t cpu_get_note_size(int class, int machine, int nr_cpus)
|
|||
if (class == ELFCLASS64) {
|
||||
note_size = AARCH64_PRSTATUS_NOTE_SIZE;
|
||||
note_size += AARCH64_PRFPREG_NOTE_SIZE;
|
||||
#ifdef TARGET_AARCH64
|
||||
if (cpu_isar_feature(aa64_sve, cpu)) {
|
||||
note_size += AARCH64_SVE_NOTE_SIZE(env);
|
||||
}
|
||||
#endif
|
||||
} else {
|
||||
note_size = ARM_PRSTATUS_NOTE_SIZE;
|
||||
if (arm_feature(env, ARM_FEATURE_VFP)) {
|
||||
|
|
|
@ -2121,6 +2121,7 @@ static void cortex_r5_initfn(Object *obj)
|
|||
set_feature(&cpu->env, ARM_FEATURE_V7);
|
||||
set_feature(&cpu->env, ARM_FEATURE_V7MP);
|
||||
set_feature(&cpu->env, ARM_FEATURE_PMSA);
|
||||
set_feature(&cpu->env, ARM_FEATURE_PMU);
|
||||
cpu->midr = 0x411fc153; /* r1p3 */
|
||||
cpu->id_pfr0 = 0x0131;
|
||||
cpu->id_pfr1 = 0x001;
|
||||
|
|
|
@ -980,6 +980,31 @@ void aarch64_sve_narrow_vq(CPUARMState *env, unsigned vq);
|
|||
void aarch64_sve_change_el(CPUARMState *env, int old_el,
|
||||
int new_el, bool el0_a64);
|
||||
void aarch64_add_sve_properties(Object *obj);
|
||||
|
||||
/*
|
||||
* SVE registers are encoded in KVM's memory in an endianness-invariant format.
|
||||
* The byte at offset i from the start of the in-memory representation contains
|
||||
* the bits [(7 + 8 * i) : (8 * i)] of the register value. As this means the
|
||||
* lowest offsets are stored in the lowest memory addresses, then that nearly
|
||||
* matches QEMU's representation, which is to use an array of host-endian
|
||||
* uint64_t's, where the lower offsets are at the lower indices. To complete
|
||||
* the translation we just need to byte swap the uint64_t's on big-endian hosts.
|
||||
*/
|
||||
static inline uint64_t *sve_bswap64(uint64_t *dst, uint64_t *src, int nr)
|
||||
{
|
||||
#ifdef HOST_WORDS_BIGENDIAN
|
||||
int i;
|
||||
|
||||
for (i = 0; i < nr; ++i) {
|
||||
dst[i] = bswap64(src[i]);
|
||||
}
|
||||
|
||||
return dst;
|
||||
#else
|
||||
return src;
|
||||
#endif
|
||||
}
|
||||
|
||||
#else
|
||||
static inline void aarch64_sve_narrow_vq(CPUARMState *env, unsigned vq) { }
|
||||
static inline void aarch64_sve_change_el(CPUARMState *env, int o,
|
||||
|
|
|
@ -876,30 +876,6 @@ static int kvm_arch_put_fpsimd(CPUState *cs)
|
|||
return 0;
|
||||
}
|
||||
|
||||
/*
|
||||
* SVE registers are encoded in KVM's memory in an endianness-invariant format.
|
||||
* The byte at offset i from the start of the in-memory representation contains
|
||||
* the bits [(7 + 8 * i) : (8 * i)] of the register value. As this means the
|
||||
* lowest offsets are stored in the lowest memory addresses, then that nearly
|
||||
* matches QEMU's representation, which is to use an array of host-endian
|
||||
* uint64_t's, where the lower offsets are at the lower indices. To complete
|
||||
* the translation we just need to byte swap the uint64_t's on big-endian hosts.
|
||||
*/
|
||||
static uint64_t *sve_bswap64(uint64_t *dst, uint64_t *src, int nr)
|
||||
{
|
||||
#ifdef HOST_WORDS_BIGENDIAN
|
||||
int i;
|
||||
|
||||
for (i = 0; i < nr; ++i) {
|
||||
dst[i] = bswap64(src[i]);
|
||||
}
|
||||
|
||||
return dst;
|
||||
#else
|
||||
return src;
|
||||
#endif
|
||||
}
|
||||
|
||||
/*
|
||||
* KVM SVE registers come in slices where ZREGs have a slice size of 2048 bits
|
||||
* and PREGS and the FFR have a slice size of 256 bits. However we simply hard
|
||||
|
|
|
@ -89,7 +89,7 @@ static uint64_t pac_sub(uint64_t i)
|
|||
uint64_t o = 0;
|
||||
int b;
|
||||
|
||||
for (b = 0; b < 64; b += 16) {
|
||||
for (b = 0; b < 64; b += 4) {
|
||||
o |= (uint64_t)sub[(i >> b) & 0xf] << b;
|
||||
}
|
||||
return o;
|
||||
|
@ -104,7 +104,7 @@ static uint64_t pac_inv_sub(uint64_t i)
|
|||
uint64_t o = 0;
|
||||
int b;
|
||||
|
||||
for (b = 0; b < 64; b += 16) {
|
||||
for (b = 0; b < 64; b += 4) {
|
||||
o |= (uint64_t)inv_sub[(i >> b) & 0xf] << b;
|
||||
}
|
||||
return o;
|
||||
|
|
|
@ -61,4 +61,7 @@ run-memory-replay: memory-replay run-memory-record
|
|||
$(QEMU_OPTS) memory, \
|
||||
"$< on $(TARGET_NAME)")
|
||||
|
||||
EXTRA_TESTS+=memory-record memory-replay
|
||||
run-pauth-3: pauth-3
|
||||
pauth-3: CFLAGS += -march=armv8.3-a
|
||||
|
||||
EXTRA_TESTS+=memory-record memory-replay pauth-3
|
||||
|
|
|
@ -18,8 +18,9 @@ run-fcvt: fcvt
|
|||
$(call diff-out,$<,$(AARCH64_SRC)/fcvt.ref)
|
||||
|
||||
# Pauth Tests
|
||||
AARCH64_TESTS += pauth-1 pauth-2
|
||||
AARCH64_TESTS += pauth-1 pauth-2 pauth-4
|
||||
run-pauth-%: QEMU_OPTS += -cpu max
|
||||
pauth-%: CFLAGS += -march=armv8.3-a
|
||||
|
||||
# Semihosting smoke test for linux-user
|
||||
AARCH64_TESTS += semihosting
|
||||
|
|
|
@ -2,8 +2,6 @@
|
|||
#include <sys/prctl.h>
|
||||
#include <stdio.h>
|
||||
|
||||
asm(".arch armv8.4-a");
|
||||
|
||||
#ifndef PR_PAC_RESET_KEYS
|
||||
#define PR_PAC_RESET_KEYS 54
|
||||
#define PR_PAC_APDAKEY (1 << 2)
|
||||
|
|
|
@ -1,8 +1,6 @@
|
|||
#include <stdint.h>
|
||||
#include <assert.h>
|
||||
|
||||
asm(".arch armv8.4-a");
|
||||
|
||||
void do_test(uint64_t value)
|
||||
{
|
||||
uint64_t salt1, salt2;
|
||||
|
|
|
@ -0,0 +1,25 @@
|
|||
#include <stdint.h>
|
||||
#include <assert.h>
|
||||
|
||||
int main()
|
||||
{
|
||||
uintptr_t x, y;
|
||||
|
||||
asm("mov %0, lr\n\t"
|
||||
"pacia %0, sp\n\t" /* sigill if pauth not supported */
|
||||
"eor %0, %0, #4\n\t" /* corrupt single bit */
|
||||
"mov %1, %0\n\t"
|
||||
"autia %1, sp\n\t" /* validate corrupted pointer */
|
||||
"xpaci %0\n\t" /* strip pac from corrupted pointer */
|
||||
: "=r"(x), "=r"(y));
|
||||
|
||||
/*
|
||||
* Once stripped, the corrupted pointer is of the form 0x0000...wxyz.
|
||||
* We expect the autia to indicate failure, producing a pointer of the
|
||||
* form 0x000e....wxyz. Use xpaci and != for the test, rather than
|
||||
* extracting explicit bits from the top, because the location of the
|
||||
* error code "e" depends on the configuration of virtual memory.
|
||||
*/
|
||||
assert(x != y);
|
||||
return 0;
|
||||
}
|
|
@ -0,0 +1,40 @@
|
|||
#include <inttypes.h>
|
||||
#include <minilib.h>
|
||||
|
||||
int main()
|
||||
{
|
||||
/*
|
||||
* Test vector from QARMA paper (https://eprint.iacr.org/2016/444.pdf)
|
||||
* to verify one computation of the pauth_computepac() function,
|
||||
* which uses sbox2.
|
||||
*
|
||||
* Use PACGA, because it returns the most bits from ComputePAC.
|
||||
* We still only get the most significant 32-bits of the result.
|
||||
*/
|
||||
|
||||
static const uint64_t d[5] = {
|
||||
0xfb623599da6e8127ull,
|
||||
0x477d469dec0b8762ull,
|
||||
0x84be85ce9804e94bull,
|
||||
0xec2802d4e0a488e9ull,
|
||||
0xc003b93999b33765ull & 0xffffffff00000000ull
|
||||
};
|
||||
uint64_t r;
|
||||
|
||||
asm("msr apgakeyhi_el1, %[w0]\n\t"
|
||||
"msr apgakeylo_el1, %[k0]\n\t"
|
||||
"pacga %[r], %[P], %[T]"
|
||||
: [r] "=r"(r)
|
||||
: [P] "r" (d[0]),
|
||||
[T] "r" (d[1]),
|
||||
[w0] "r" (d[2]),
|
||||
[k0] "r" (d[3]));
|
||||
|
||||
if (r == d[4]) {
|
||||
ml_printf("OK\n");
|
||||
return 0;
|
||||
} else {
|
||||
ml_printf("FAIL: %lx != %lx\n", r, d[4]);
|
||||
return 1;
|
||||
}
|
||||
}
|
Loading…
Reference in New Issue