Welcome to QEMU’s Documentation

Contents:

• QEMU System Emulation Management and Interoperability Guide
  • Dirty Bitmaps and Incremental Backup
    • Overview
    • Supported Image Formats
    • Dirty Bitmap Names
    • Bitmap Status
    • Basic QMP Usage
    • Bitmap Persistence
    • Transactions
    • Incremental Backups - Push Model
    • Push Backup Errors & Recovery
  • Live Block Device Operations
    • Disk image backing chain notation
    • Brief overview of live block QMP primitives
    • Interacting with a QEMU instance
    • Example disk image chain
    • A note on points-in-time vs file names
    • Live block streaming — block-stream
    • Live block commit — block-commit
    • Live disk synchronization — drive-mirror and blockdev-mirror
    • Live disk backup — drive-backup and blockdev-backup
  • Persistent reservation helper protocol
    • Connection and initialization
    • Command format
• Live Block Device Operations
  • Disk image backing chain notation
  • Brief overview of live block QMP primitives
  • Interacting with a QEMU instance
  • Example disk image chain
  • A note on points-in-time vs file names
  • Live block streaming — block-stream
    • QMP invocation for block-stream
  • Live block commit — block-commit
    • QMP invocation for block-commit
  • Live disk synchronization — drive-mirror and blockdev-mirror
    • QMP invocation for drive-mirror
    • QMP invocation for live storage migration with drive-mirror + NBD
    • Notes on blockdev-mirror
    • QMP invocation for blockdev-mirror
  • Live disk backup — drive-backup and blockdev-backup
    • QMP invocation for drive-backup
    • Notes on blockdev-backup
    • QMP invocation for blockdev-backup
• Dirty Bitmaps and Incremental Backup
  • Overview
  • Supported Image Formats
  • Dirty Bitmap Names
  • Bitmap Status
  • Basic QMP Usage
    • Supported Commands
    • Creation: block-dirty-bitmap-add
    • Deletion: block-dirty-bitmap-remove
    • Resetting: block-dirty-bitmap-clear
    • Enabling: block-dirty-bitmap-enable
    • Enabling: block-dirty-bitmap-disable
    • Merging, Copying: block-dirty-bitmap-merge
    • Querying: query-block
  • Bitmap Persistence
  • Transactions
    • Justification
    • Supported Bitmap Transactions
  • Incremental Backups - Push Model
    • Example: New Incremental Backup Anchor Point
    • Example: Resetting an Incremental Backup Anchor Point
    • Example: First Incremental Backup
    • Example: Second Incremental Backup
    • Example: Incremental Push Backups without Backing Files
    • Example: Multi-drive Incremental Backup
  • Push Backup Errors & Recovery
    • Example: Individual Failures
    • Example: Partial Transactional Failures
    • Example: Grouped Completion Mode
• Persistent reservation helper protocol
  • Connection and initialization
  • Command format
• QEMU Developer’s Guide
  • QEMU and Kconfig
    • The Kconfig language
    • Guidelines for writing Kconfig files
    • Writing and modifying default configurations
    • Kconfig.host
  • Load and Store APIs
    • ld*_p and st*_p
    • cpu_{ld,st}_*
    • cpu_{ld,st}_*_ra
    • helper_*_{ld,st}*mmu
    • address_space_*
    • address_space_write_rom
    • {ld,st}*_phys
    • cpu_physical_memory_*
    • cpu_memory_rw_debug
    • dma_memory_*
    • pci_dma_* and {ld,st}*_pci_dma
  • The memory API
    • Types of regions
    • Migration
    • Region names
    • Region lifecycle
    • Overlapping regions and priority
    • Visibility
    • Example memory map
    • MMIO Operations
  • Migration
    • Transports
    • Common infrastructure
    • Saving the state of one device
    • Stream structure
    • Postcopy
    • Firmware
  • QEMU and the stable process
    • QEMU stable releases
    • What should go into a stable release?
    • How to get a patch into QEMU stable
    • Stable release process
  • Testing in QEMU
    • Testing with “make check”
    • QEMU iotests
    • Docker based tests
    • VM testing
    • Image fuzzer testing
    • Acceptance tests using the Avocado Framework
  • Decodetree Specification
    • Fields
    • Argument Sets
    • Formats
    • Patterns
    • Pattern Groups
• Load and Store APIs
  • ld*_p and st*_p
  • cpu_{ld,st}_*
  • cpu_{ld,st}_*_ra
  • helper_*_{ld,st}*mmu
  • address_space_*
  • address_space_write_rom
  • {ld,st}*_phys
  • cpu_physical_memory_*
  • cpu_memory_rw_debug
  • dma_memory_*
  • pci_dma_* and {ld,st}*_pci_dma
• Migration
  • Transports
  • Common infrastructure
  • Saving the state of one device
    • General advice for device developers
    • VMState
    • Legacy way
    • Changing migration data structures
    • Subsections
    • Connecting subsections to properties
    • Not sending existing elements
    • Versions
    • Massaging functions
    • Iterative device migration
    • Device ordering
  • Stream structure
    • Return path
  • Postcopy
    • Enabling postcopy
    • Postcopy device transfer
    • Source behaviour
    • Destination behaviour
    • Postcopy states
    • Source side page maps
    • Postcopy with hugepages
    • Postcopy with shared memory
  • Firmware
• QEMU and the stable process
  • QEMU stable releases
  • What should go into a stable release?
  • How to get a patch into QEMU stable
  • Stable release process
• Testing in QEMU
  • Testing with “make check”
    • Unit tests
    • QTest
    • QAPI schema tests
    • check-block
    • GCC gcov support
  • QEMU iotests
    • Writing a new test case
  • Docker based tests
    • Introduction
    • Prerequisites
    • Quickstart
    • Images
    • Tests
    • Tools
    • Debugging a Docker test failure
    • Options
  • VM testing
    • Quickstart
    • QEMU binary
    • Make jobs
    • Debugging
    • Manual invocation
    • Adding new guests
  • Image fuzzer testing
  • Acceptance tests using the Avocado Framework
    • Running tests
    • Manual Installation
    • Overview
    • The avocado_qemu.Test base test class
    • Attribute reference
    • Parameter reference
    • Uninstalling Avocado
• Persistent reservation managers
  • Defining a persistent reservation manager
  • Invoking qemu-pr-helper
  • Multipath devices and persistent reservations
• Virtual CPU hotplug
  • vCPU hotplug
  • vCPU hot-unplug

Indices and tables

• Index
• Module Index
• Search Page