summaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* docs: fix one issue in qcow2 specsZhi Yong Wu2012-05-021-1/+1
| | | | | Signed-off-by: Zhi Yong Wu <wuzhy@linux.vnet.ibm.com> Signed-off-by: Kevin Wolf <kwolf@redhat.com>
* Specification for qcow2 version 3Kevin Wolf2012-04-201-23/+99
| | | | | | | | | | | | | | | | | | | | | | | | | This updates the qcow2 specification to cover version 3. It contains the following changes: - Added compatible/incompatible/auto-clear feature bits plus an optional feature name table to allow useful error messages even if an older version doesn't know some feature at all. - Configurable refcount width. If you don't want to use internal snapshots, make refcounts one bit and save cache space and I/O. - Zero cluster flags. This allows discard even with a backing file that doesn't contain zeros. It is also useful for copy-on-read/image streaming, as you'll want to keep sparseness without accessing the remote image for an unallocated cluster all the time. - Fixed internal snapshot metadata to use 64 bit VM state size. You can't save a snapshot of a VM with >= 4 GB RAM today. - Extended internal snapshot metadata to contain the disk size, so that resizing images that have snapshots can be allowed in the future. Signed-off-by: Kevin Wolf <kwolf@redhat.com>
* acpi_piix4: Re-define PCI hotplug eject register readAlex Williamson2012-04-151-2/+10
| | | | | | | | | | | | The PCI hotplug eject register has always returned 0, so let's redefine it as a hotplug feature register. The existing model of using separate up & down read-only registers and an eject via write to this register becomes the base implementation. As we make use of new interfaces we'll set bits here to allow the BIOS and AML implementation to optimize for the platform implementation. Signed-off-by: Alex Williamson <alex.williamson@redhat.com> Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
* acpi_piix4: Remove PCI_RMV_BASE write codeAlex Williamson2012-04-151-1/+1
| | | | | | | | Clarify this register as read-only and remove write code. No change in existing behavior. Signed-off-by: Alex Williamson <alex.williamson@redhat.com> Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
* acpi_piix4: Disallow write to up/down PCI hotplug registersAlex Williamson2012-04-151-2/+2
| | | | | | | | | | The write side of these registers is never used and actually can't be used as defined because any read/modify/write sequence from the guest potentially races with qemu. Drop the write support and define these as read-only registers. Signed-off-by: Alex Williamson <alex.williamson@redhat.com> Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
* Replace Qemu by QEMU in internal documentationStefan Weil2012-04-072-2/+2
| | | | | | | | The official spelling is QEMU. Signed-off-by: Stefan Weil <sw@weilnetz.de> Reviewed-by: Andreas Färber <afaerber@suse.de> Signed-off-by: Blue Swirl <blauwirbel@gmail.com>
* qapi: untangle next_listPaolo Bonzini2012-03-271-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | Right now, the semantics of next_list are complicated. The caller must: * call start_list * call next_list for each element *including the first* * on the first call to next_list, the second argument should point to NULL and the result is the head of the list. On subsequent calls, the second argument should point to the last node (last result of next_list) and next_list itself tacks the element at the tail of the list. This works for both input and output visitor, but having the visitor write memory when it is only reading the list is ugly. Plus, relying on *list to detect the first call is tricky and undocumented. We can initialize so->entry in next_list instead of start_list, leaving it NULL in start_list. This way next_list sees clearly whether it is on the first call---as a bonus, it discriminates the cases based on internal state of the visitor rather than external state. We can also pull the assignment of the list head from generated code up to next_list. Signed-off-by: Paolo Bonzini <pbonzini@redhat.com> Reviewed-by: Michael Roth <mdroth@linux.vnet.ibm.com> Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
* Merge remote-tracking branch 'sstabellini/saverestore-8' into stagingAnthony Liguori2012-03-191-0/+34
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | * sstabellini/saverestore-8: xen: do not allocate RAM during INMIGRATE runstate xen mapcache: check if memory region has moved. xen: record physmap changes to xenstore Set runstate to INMIGRATE earlier Introduce "xen-save-devices-state" cirrus_vga: do not reset videoram Conflicts: qapi-schema.json Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
| * Introduce "xen-save-devices-state"Stefano Stabellini2012-03-191-0/+34
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - add an "is_ram" flag to SaveStateEntry; - register_savevm_live sets is_ram for live_savevm devices; - introduce a "xen-save-devices-state" QAPI command that can be used to save the state of all devices, but not the RAM or the block devices of the VM. Changes in v8: - rename save-devices-state to xen-save-devices-state. Changes in v7: - rename save_devices to save-devices-state. Changes in v6: - remove the is_ram parameter from register_savevm_live and sets is_ram if the device is a live_savevm device; - introduce save_devices as a QAPI command, write a better description for it; - fix CODING_STYLE; - introduce a new doc to explain the save format used by save_devices. Signed-off-by: Stefano Stabellini <stefano.stabellini@eu.citrix.com> Reviewed-by: Anthony Liguori <aliguori@us.ibm.com> Acked-by: Luiz Capitulino <lcapitulino@redhat.com>
* | docs: correct ./configure line in tracing.txtJun Koi2012-03-121-1/+1
| | | | | | | | | | | | | | This patch corrects the configure's trace option in docs/tracing.txt. Signed-off-by: Jun Koi <junkoi2004@gmail.com> Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
* | trace: Provide a per-event status define for conditional compilationLluís Vilanova2012-03-121-6/+40
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Adds a 'TRACE_${NAME}_ENABLED' preprocessor define for each tracing event in "trace.h". This lets the user conditionally compile code with a relatively high execution cost that is only necessary when producing the tracing information for an event that is enabled. Note that events using this define will probably have the "disable" property by default, in order to avoid such costs on regular builds. Signed-off-by: Lluís Vilanova <vilanova@ac.upc.edu> Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
* | libcacard: Spelling and grammar fixes in documentationStefan Weil2012-03-081-13/+13
|/ | | | | | | | | | | | | | | | | | | | | | | | | | * it's -> its * it's -> it is (that's no fix, but makes future checks easier) * this functions -> this function * replacable -> replaceable * reader's -> readers * logins into -> logs into v2: Also replace 'aid' by 'AID' (thanks to Peter Maydell for this hint). v3: Fix sentence (contributed by Alon Levy / Robert Relyea). Cc: Alon Levy <alevy@redhat.com> Cc: Robert Relyea <rrelyea@redhat.com> Cc: Peter Maydell <peter.maydell@linaro.org> Signed-off-by: Stefan Weil <sw@weilnetz.de> Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
* docs: describe live block operationsMarcelo Tosatti2012-01-261-0/+58
| | | | | | Signed-off-by: Marcelo Tosatti <mtosatti@redhat.com> Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com> Signed-off-by: Kevin Wolf <kwolf@redhat.com>
* Spelling fixes in comments and documentationStefan Weil2012-01-131-1/+1
| | | | | | | Codespell detected these new spelling issues. Signed-off-by: Stefan Weil <sw@weilnetz.de> Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
* Merge remote-tracking branch 'qemu-kvm/memory/mutators' into stagingAnthony Liguori2011-12-191-0/+12
|\ | | | | | | | | Conflicts: memory.h
| * docs: document memory API interaction with migrationAvi Kivity2011-12-071-0/+12
| | | | | | | | Signed-off-by: Avi Kivity <avi@redhat.com>
* | qcow2: Allow >4 GB VM stateKevin Wolf2011-12-151-1/+7
| | | | | | | | | | | | | | This is a compatible extension to the snapshot header format that allows saving a 64 bit VM state size. Signed-off-by: Kevin Wolf <kwolf@redhat.com>
* | Merge remote-tracking branch 'stefanha/trivial-patches-next' into stagingAnthony Liguori2011-12-141-3/+3
|\ \
| * | memory: minor documentation fixes/enhancementsAdemar de Souza Reis Jr2011-12-061-3/+3
| |/ | | | | | | | | | | | | | | | | | | | | | | Fix typos and minor documentation errors in both memory.h and docs/memory.txt. Also add missing documentation formatting tags to transaction functions. Reviewed-by: Stefan Weil <sw@weilnetz.de> Signed-off-by: Ademar de Souza Reis Jr <areis@redhat.com> Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
* | docs: Add writing-qmp-commands.txtLuiz Capitulino2011-12-061-0/+642
|/ | | | | | Explains how to write QMP commands using the QAPI. Signed-off-by: Luiz Capitulino <lcapitulino@redhat.com>
* Fixing some spelling in docs/libcacard.txtMatthias Brugger2011-11-171-6/+6
| | | | | | Reviewed-by: Alon Levy <alevy@redhat.com> Signed-off-by: Matthias Brugger <matthias.bgg@gmail.com> Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
* Fix some spelling bugs in documentation and commentsStefan Weil2011-11-172-4/+4
| | | | | | | | | | | | | | These errors were detected by codespell: remaing -> remaining soley -> solely virutal -> virtual seperate -> separate libcacard.txt still needs some more patches. Signed-off-by: Stefan Weil <sw@weilnetz.de> Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
* Fix spelling in documentation and comments (similiar -> similar)Stefan Weil2011-11-171-1/+1
| | | | | | | | This bug was detected by codespell. In mips_mipssim.c a grammatical error was fixed, too. Signed-off-by: Stefan Weil <sw@weilnetz.de> Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
* Merge remote-tracking branch 'stefanha/tracing' into stagingAnthony Liguori2011-11-011-1/+8
|\
| * trace: Add wildcard trace event supportMark Wu2011-11-011-1/+8
| | | | | | | | | | | | | | | | | | | | | | A basic wildcard matching is supported in both the monitor command "trace-event" and the events list file. That means you can enable/disable the events having a common prefix in a batch. For example, virtio-blk trace events could be enabled using: trace-event virtio_blk_* on Signed-off-by: Mark Wu <wudxw@linux.vnet.ibm.com> Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
* | qapi: fix typos in documentation JSON examplesStefan Hajnoczi2011-11-011-2/+2
|/ | | | Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
* qcow2: fix some errors and typo in qcow2.txtZhi Yong Wu2011-10-281-3/+3
| | | | | Signed-off-by: Zhi Yong Wu <wuzhy@linux.vnet.ibm.com> Signed-off-by: Kevin Wolf <kwolf@redhat.com>
* trace: Update docs to use example events that existLluís Vilanova2011-09-211-7/+9
| | | | | | | | The events 'qemu_malloc' and 'qemu_free' used in the examples no longer exist, so use 'qemu_vmalloc' and 'qemu_vfree' instead. Signed-off-by: Lluís Vilanova <vilanova@ac.upc.edu> Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
* trace: allow trace events with string argumentsStefan Hajnoczi2011-09-211-5/+3
| | | | | | | | | String arguments are useful for producing human-readable traces without post-processing (e.g. stderr backend). Although the simple backend cannot handles strings all others can. Strings should be allowed and the simple backend can be extended to support them. Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
* trace: allow PRI*64 at beginning and ending of format stringStefan Hajnoczi2011-09-171-4/+1
| | | | | | | | | | | | | | | | | | | The tracetool parser only picks up PRI*64 and other format string macros when enclosed between double quoted strings. Lift this restriction by extracting everything after the closing ')' as the format string: cpu_set_apic_base(uint64_t val) "%016"PRIx64 ^^ ^^ One trick here: it turns out that backslashes in the format string like "\n" were being interpreted by echo(1). Fix this by using the POSIX printf(1) command instead. Although it normally does not make sense to include backslashes in trace event format strings, an injected newline causes tracetool to emit a broken header file and I want to eliminate cases where broken output is emitted, even if the input was bad. Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com> Signed-off-by: Blue Swirl <blauwirbel@gmail.com>
* docs: Fix qdev-device-use.txt typo in -chardev serial, path=COM<NUM>Markus Armbruster2011-09-091-1/+1
| | | | | Signed-off-by: Markus Armbruster <armbru@redhat.com> Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
* Merge remote-tracking branch 'stefanha/tracing' into stagingAnthony Liguori2011-09-021-26/+47
|\
| * trace: [stderr] add support for dynamically enabling/disabling eventsLluís2011-09-011-5/+0
| | | | | | | | | | | | | | | | Uses the generic interface provided in "trace/control.h" in order to provide a programmatic interface as well as command line and monitor controls. Signed-off-by: Fabien Chouteau <chouteau@adacore.com> Signed-off-by: Lluís Vilanova <vilanova@ac.upc.edu>
| * trace: [simple] disable all trace points by defaultLluís2011-09-011-3/+8
| | | | | | | | | | | | | | | | Note that this refers to the backend-specific state (whether the output must be generated), not the event "disabled" property (which always uses the "nop" backend). Signed-off-by: Lluís Vilanova <vilanova@ac.upc.edu>
| * trace: always use the "nop" backend on events with the "disable" keywordLluís2011-09-011-10/+15
| | | | | | | | | | | | | | Any event with the keyword/property "disable" generates an empty trace event using the "nop" backend, regardless of the current backend. Signed-off-by: Lluís Vilanova <vilanova@ac.upc.edu>
| * trace: add "-trace events" argument to control initial stateLluís2011-09-011-0/+4
| | | | | | | | | | | | | | | | | | | | | | The "-trace events" argument can be used to provide a file with a list of trace event names that will be enabled prior to starting execution, thus providing early tracing. This saves the user from manually toggling event states through the monitor interface or whichever backend-specific interface. Signed-off-by: Lluís Vilanova <vilanova@ac.upc.edu>
| * trace: always compile support for controlling and querying trace event statesLluís2011-09-011-18/+30
| | | | | | | | | | | | | | | | The current interface is generic for this small set of operations, and thus other backends can easily modify the "trace/control.c" file to add their own implementation. Signed-off-by: Lluís Vilanova <vilanova@ac.upc.edu>
| * trace: generalize the "property" concept in the trace-events fileLluís2011-09-011-2/+2
| | | | | | | | | | | | | | | | | | | | This adds/modifies the following functions: * get_name: Get _only_ the event name * has_property: Return whether an event has a property (keyword before the event name) Signed-off-by: Lluís Vilanova <vilanova@ac.upc.edu>
* | Fix spelling in comments and debug messages (recieve -> receive)Stefan Weil2011-08-291-1/+1
|/ | | | | | Signed-off-by: Stefan Weil <weil@mail.berlios.de> Reviewed-by: Andreas Färber <andreas.faerber@web.de> Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
* memory: correct documentation typosAvi Kivity2011-08-121-4/+4
| | | | | | | Noted by Drew Jones. Signed-off-by: Avi Kivity <avi@redhat.com> Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
* Add memory API documentationAvi Kivity2011-07-291-0/+172
| | | | | Signed-off-by: Avi Kivity <avi@redhat.com> Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
* qapi: add QAPI code generation documentationMichael Roth2011-07-211-0/+316
| | | | | Signed-off-by: Michael Roth <mdroth@linux.vnet.ibm.com> Signed-off-by: Luiz Capitulino <lcapitulino@gmail.com>
* usb: update documentationGerd Hoffmann2011-07-082-5/+65
| | | | | | | Add a paragraph on companion controller mode and a configuration file which sets it all up for you. Signed-off-by: Gerd Hoffmann <kraxel@redhat.com>
* usb: documentation updateGerd Hoffmann2011-06-141-0/+85
| | | | | | | Add some more informations to docs/usb2.txt about using usb2 (also usb1) devices. Signed-off-by: Gerd Hoffmann <kraxel@redhat.com>
* docs: qdev-device-use.txt has become stale, update itMarkus Armbruster2011-06-071-66/+114
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Document more bus addresses. Update for bugs fixed. Describe where exactly the -drive options go. Update for recent split of qdev ide-drive into ide-{cd,hd}, scsi-disk into scsi-{cd,hd}. Document scsi-hd's removable property only for usb-storage, because that's where it's used. Fix description of -global isa.fdc. Document usb-storage lossage. Clean up misleading description of network device's split into guest and host part. Document -vga's machine dependence. New qdevs: virtconsole, qxl-vga, isa-vga, intel-hda, usb-ccid Update for changed pci-assign property iommu. New section "Default Devices". Signed-off-by: Markus Armbruster <armbru@redhat.com> Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
* usb: add ehci adapterGerd Hoffmann2011-05-261-0/+38
| | | | | | | | | | | | | | | | | | | | This patch finally merges the EHCI host adapter aka USB 2.0 support. Based on the ehci bits collected @ git://git.kiszka.org/qemu.git ehci EHCI has a long out-of-tree history. Project was started by Mark Burkley, with contributions by Niels de Vos. David S. Ahern continued working on it. Kevin Wolf, Jan Kiszka and Vincent Palatin contributed bugfixes. /me (Gerd Hoffmann) picked it up where it left off, prepared the code for merge, fixed a few bugs and added basic user docs. Cc: David S. Ahern <daahern@cisco.com> Cc: Jan Kiszka <jan.kiszka@web.de> Cc: Kevin Wolf <mail@kevin-wolf.de> Cc: Vincent Palatin <vincent.palatin_qemu@m4x.org> Signed-off-by: Gerd Hoffmann <kraxel@redhat.com>
* docs/tracing.txt: minor documentation fixesLluís2011-04-261-9/+9
| | | | | Signed-off-by: Lluís Vilanova <vilanova@ac.upc.edu> Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
* docs: Trace events must not expect pointer dereferencingStefan Hajnoczi2011-04-261-0/+5
| | | | Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com>
* docs: Describe zero data clusters in QED specificationStefan Hajnoczi2011-04-131-0/+8
| | | | | | | | Zero data clusters are a space-efficient way of storing zeroed regions of the image. Signed-off-by: Stefan Hajnoczi <stefanha@linux.vnet.ibm.com> Signed-off-by: Kevin Wolf <kwolf@redhat.com>
* ccid: add docsAlon Levy2011-04-011-0/+135
| | | | | | | Add documentation for the usb-ccid device and accompanying two card devices, ccid-card-emulated and ccid-card-passthru. Signed-off-by: Alon Levy <alevy@redhat.com>
OpenPOWER on IntegriCloud