1# -*- Mode: Python -*- 2# 3# QAPI block core definitions (vm unrelated) 4 5# QAPI common definitions 6{ 'include': 'common.json' } 7 8## 9# @SnapshotInfo 10# 11# @id: unique snapshot id 12# 13# @name: user chosen name 14# 15# @vm-state-size: size of the VM state 16# 17# @date-sec: UTC date of the snapshot in seconds 18# 19# @date-nsec: fractional part in nano seconds to be used with date-sec 20# 21# @vm-clock-sec: VM clock relative to boot in seconds 22# 23# @vm-clock-nsec: fractional part in nano seconds to be used with vm-clock-sec 24# 25# Since: 1.3 26# 27## 28 29{ 'type': 'SnapshotInfo', 30 'data': { 'id': 'str', 'name': 'str', 'vm-state-size': 'int', 31 'date-sec': 'int', 'date-nsec': 'int', 32 'vm-clock-sec': 'int', 'vm-clock-nsec': 'int' } } 33 34## 35# @ImageInfoSpecificQCow2: 36# 37# @compat: compatibility level 38# 39# @lazy-refcounts: #optional on or off; only valid for compat >= 1.1 40# 41# @corrupt: #optional true if the image has been marked corrupt; only valid for 42# compat >= 1.1 (since 2.2) 43# 44# @refcount-bits: width of a refcount entry in bits (since 2.3) 45# 46# Since: 1.7 47## 48{ 'type': 'ImageInfoSpecificQCow2', 49 'data': { 50 'compat': 'str', 51 '*lazy-refcounts': 'bool', 52 '*corrupt': 'bool', 53 'refcount-bits': 'int' 54 } } 55 56## 57# @ImageInfoSpecificVmdk: 58# 59# @create-type: The create type of VMDK image 60# 61# @cid: Content id of image 62# 63# @parent-cid: Parent VMDK image's cid 64# 65# @extents: List of extent files 66# 67# Since: 1.7 68## 69{ 'type': 'ImageInfoSpecificVmdk', 70 'data': { 71 'create-type': 'str', 72 'cid': 'int', 73 'parent-cid': 'int', 74 'extents': ['ImageInfo'] 75 } } 76 77## 78# @ImageInfoSpecific: 79# 80# A discriminated record of image format specific information structures. 81# 82# Since: 1.7 83## 84 85{ 'union': 'ImageInfoSpecific', 86 'data': { 87 'qcow2': 'ImageInfoSpecificQCow2', 88 'vmdk': 'ImageInfoSpecificVmdk' 89 } } 90 91## 92# @ImageInfo: 93# 94# Information about a QEMU image file 95# 96# @filename: name of the image file 97# 98# @format: format of the image file 99# 100# @virtual-size: maximum capacity in bytes of the image 101# 102# @actual-size: #optional actual size on disk in bytes of the image 103# 104# @dirty-flag: #optional true if image is not cleanly closed 105# 106# @cluster-size: #optional size of a cluster in bytes 107# 108# @encrypted: #optional true if the image is encrypted 109# 110# @compressed: #optional true if the image is compressed (Since 1.7) 111# 112# @backing-filename: #optional name of the backing file 113# 114# @full-backing-filename: #optional full path of the backing file 115# 116# @backing-filename-format: #optional the format of the backing file 117# 118# @snapshots: #optional list of VM snapshots 119# 120# @backing-image: #optional info of the backing image (since 1.6) 121# 122# @format-specific: #optional structure supplying additional format-specific 123# information (since 1.7) 124# 125# Since: 1.3 126# 127## 128 129{ 'type': 'ImageInfo', 130 'data': {'filename': 'str', 'format': 'str', '*dirty-flag': 'bool', 131 '*actual-size': 'int', 'virtual-size': 'int', 132 '*cluster-size': 'int', '*encrypted': 'bool', '*compressed': 'bool', 133 '*backing-filename': 'str', '*full-backing-filename': 'str', 134 '*backing-filename-format': 'str', '*snapshots': ['SnapshotInfo'], 135 '*backing-image': 'ImageInfo', 136 '*format-specific': 'ImageInfoSpecific' } } 137 138## 139# @ImageCheck: 140# 141# Information about a QEMU image file check 142# 143# @filename: name of the image file checked 144# 145# @format: format of the image file checked 146# 147# @check-errors: number of unexpected errors occurred during check 148# 149# @image-end-offset: #optional offset (in bytes) where the image ends, this 150# field is present if the driver for the image format 151# supports it 152# 153# @corruptions: #optional number of corruptions found during the check if any 154# 155# @leaks: #optional number of leaks found during the check if any 156# 157# @corruptions-fixed: #optional number of corruptions fixed during the check 158# if any 159# 160# @leaks-fixed: #optional number of leaks fixed during the check if any 161# 162# @total-clusters: #optional total number of clusters, this field is present 163# if the driver for the image format supports it 164# 165# @allocated-clusters: #optional total number of allocated clusters, this 166# field is present if the driver for the image format 167# supports it 168# 169# @fragmented-clusters: #optional total number of fragmented clusters, this 170# field is present if the driver for the image format 171# supports it 172# 173# @compressed-clusters: #optional total number of compressed clusters, this 174# field is present if the driver for the image format 175# supports it 176# 177# Since: 1.4 178# 179## 180 181{ 'type': 'ImageCheck', 182 'data': {'filename': 'str', 'format': 'str', 'check-errors': 'int', 183 '*image-end-offset': 'int', '*corruptions': 'int', '*leaks': 'int', 184 '*corruptions-fixed': 'int', '*leaks-fixed': 'int', 185 '*total-clusters': 'int', '*allocated-clusters': 'int', 186 '*fragmented-clusters': 'int', '*compressed-clusters': 'int' } } 187 188## 189# @BlockdevCacheInfo 190# 191# Cache mode information for a block device 192# 193# @writeback: true if writeback mode is enabled 194# @direct: true if the host page cache is bypassed (O_DIRECT) 195# @no-flush: true if flush requests are ignored for the device 196# 197# Since: 2.3 198## 199{ 'type': 'BlockdevCacheInfo', 200 'data': { 'writeback': 'bool', 201 'direct': 'bool', 202 'no-flush': 'bool' } } 203 204## 205# @BlockDeviceInfo: 206# 207# Information about the backing device for a block device. 208# 209# @file: the filename of the backing device 210# 211# @node-name: #optional the name of the block driver node (Since 2.0) 212# 213# @ro: true if the backing device was open read-only 214# 215# @drv: the name of the block format used to open the backing device. As of 216# 0.14.0 this can be: 'blkdebug', 'bochs', 'cloop', 'cow', 'dmg', 217# 'file', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device', 218# 'host_floppy', 'http', 'https', 'nbd', 'parallels', 'qcow', 219# 'qcow2', 'raw', 'tftp', 'vdi', 'vmdk', 'vpc', 'vvfat' 220# 2.2: 'archipelago' added, 'cow' dropped 221# 2.3: 'host_floppy' deprecated 222# 223# @backing_file: #optional the name of the backing file (for copy-on-write) 224# 225# @backing_file_depth: number of files in the backing file chain (since: 1.2) 226# 227# @encrypted: true if the backing device is encrypted 228# 229# @encryption_key_missing: true if the backing device is encrypted but an 230# valid encryption key is missing 231# 232# @detect_zeroes: detect and optimize zero writes (Since 2.1) 233# 234# @bps: total throughput limit in bytes per second is specified 235# 236# @bps_rd: read throughput limit in bytes per second is specified 237# 238# @bps_wr: write throughput limit in bytes per second is specified 239# 240# @iops: total I/O operations per second is specified 241# 242# @iops_rd: read I/O operations per second is specified 243# 244# @iops_wr: write I/O operations per second is specified 245# 246# @image: the info of image used (since: 1.6) 247# 248# @bps_max: #optional total max in bytes (Since 1.7) 249# 250# @bps_rd_max: #optional read max in bytes (Since 1.7) 251# 252# @bps_wr_max: #optional write max in bytes (Since 1.7) 253# 254# @iops_max: #optional total I/O operations max (Since 1.7) 255# 256# @iops_rd_max: #optional read I/O operations max (Since 1.7) 257# 258# @iops_wr_max: #optional write I/O operations max (Since 1.7) 259# 260# @iops_size: #optional an I/O size in bytes (Since 1.7) 261# 262# @cache: the cache mode used for the block device (since: 2.3) 263# 264# @write_threshold: configured write threshold for the device. 265# 0 if disabled. (Since 2.3) 266# 267# Since: 0.14.0 268# 269## 270{ 'type': 'BlockDeviceInfo', 271 'data': { 'file': 'str', '*node-name': 'str', 'ro': 'bool', 'drv': 'str', 272 '*backing_file': 'str', 'backing_file_depth': 'int', 273 'encrypted': 'bool', 'encryption_key_missing': 'bool', 274 'detect_zeroes': 'BlockdevDetectZeroesOptions', 275 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int', 276 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int', 277 'image': 'ImageInfo', 278 '*bps_max': 'int', '*bps_rd_max': 'int', 279 '*bps_wr_max': 'int', '*iops_max': 'int', 280 '*iops_rd_max': 'int', '*iops_wr_max': 'int', 281 '*iops_size': 'int', 'cache': 'BlockdevCacheInfo', 282 'write_threshold': 'int' } } 283 284## 285# @BlockDeviceIoStatus: 286# 287# An enumeration of block device I/O status. 288# 289# @ok: The last I/O operation has succeeded 290# 291# @failed: The last I/O operation has failed 292# 293# @nospace: The last I/O operation has failed due to a no-space condition 294# 295# Since: 1.0 296## 297{ 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] } 298 299## 300# @BlockDeviceMapEntry: 301# 302# Entry in the metadata map of the device (returned by "qemu-img map") 303# 304# @start: Offset in the image of the first byte described by this entry 305# (in bytes) 306# 307# @length: Length of the range described by this entry (in bytes) 308# 309# @depth: Number of layers (0 = top image, 1 = top image's backing file, etc.) 310# before reaching one for which the range is allocated. The value is 311# in the range 0 to the depth of the image chain - 1. 312# 313# @zero: the sectors in this range read as zeros 314# 315# @data: reading the image will actually read data from a file (in particular, 316# if @offset is present this means that the sectors are not simply 317# preallocated, but contain actual data in raw format) 318# 319# @offset: if present, the image file stores the data for this range in 320# raw format at the given offset. 321# 322# Since 1.7 323## 324{ 'type': 'BlockDeviceMapEntry', 325 'data': { 'start': 'int', 'length': 'int', 'depth': 'int', 'zero': 'bool', 326 'data': 'bool', '*offset': 'int' } } 327 328## 329# @BlockDirtyInfo: 330# 331# Block dirty bitmap information. 332# 333# @count: number of dirty bytes according to the dirty bitmap 334# 335# @granularity: granularity of the dirty bitmap in bytes (since 1.4) 336# 337# Since: 1.3 338## 339{ 'type': 'BlockDirtyInfo', 340 'data': {'count': 'int', 'granularity': 'int'} } 341 342## 343# @BlockInfo: 344# 345# Block device information. This structure describes a virtual device and 346# the backing device associated with it. 347# 348# @device: The device name associated with the virtual device. 349# 350# @type: This field is returned only for compatibility reasons, it should 351# not be used (always returns 'unknown') 352# 353# @removable: True if the device supports removable media. 354# 355# @locked: True if the guest has locked this device from having its media 356# removed 357# 358# @tray_open: #optional True if the device has a tray and it is open 359# (only present if removable is true) 360# 361# @dirty-bitmaps: #optional dirty bitmaps information (only present if the 362# driver has one or more dirty bitmaps) (Since 2.0) 363# 364# @io-status: #optional @BlockDeviceIoStatus. Only present if the device 365# supports it and the VM is configured to stop on errors 366# (supported device models: virtio-blk, ide, scsi-disk) 367# 368# @inserted: #optional @BlockDeviceInfo describing the device if media is 369# present 370# 371# Since: 0.14.0 372## 373{ 'type': 'BlockInfo', 374 'data': {'device': 'str', 'type': 'str', 'removable': 'bool', 375 'locked': 'bool', '*inserted': 'BlockDeviceInfo', 376 '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus', 377 '*dirty-bitmaps': ['BlockDirtyInfo'] } } 378 379## 380# @query-block: 381# 382# Get a list of BlockInfo for all virtual block devices. 383# 384# Returns: a list of @BlockInfo describing each virtual block device 385# 386# Since: 0.14.0 387## 388{ 'command': 'query-block', 'returns': ['BlockInfo'] } 389 390## 391# @BlockDeviceStats: 392# 393# Statistics of a virtual block device or a block backing device. 394# 395# @rd_bytes: The number of bytes read by the device. 396# 397# @wr_bytes: The number of bytes written by the device. 398# 399# @rd_operations: The number of read operations performed by the device. 400# 401# @wr_operations: The number of write operations performed by the device. 402# 403# @flush_operations: The number of cache flush operations performed by the 404# device (since 0.15.0) 405# 406# @flush_total_time_ns: Total time spend on cache flushes in nano-seconds 407# (since 0.15.0). 408# 409# @wr_total_time_ns: Total time spend on writes in nano-seconds (since 0.15.0). 410# 411# @rd_total_time_ns: Total_time_spend on reads in nano-seconds (since 0.15.0). 412# 413# @wr_highest_offset: The offset after the greatest byte written to the 414# device. The intended use of this information is for 415# growable sparse files (like qcow2) that are used on top 416# of a physical device. 417# 418# @rd_merged: Number of read requests that have been merged into another 419# request (Since 2.3). 420# 421# @wr_merged: Number of write requests that have been merged into another 422# request (Since 2.3). 423# 424# Since: 0.14.0 425## 426{ 'type': 'BlockDeviceStats', 427 'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'rd_operations': 'int', 428 'wr_operations': 'int', 'flush_operations': 'int', 429 'flush_total_time_ns': 'int', 'wr_total_time_ns': 'int', 430 'rd_total_time_ns': 'int', 'wr_highest_offset': 'int', 431 'rd_merged': 'int', 'wr_merged': 'int' } } 432 433## 434# @BlockStats: 435# 436# Statistics of a virtual block device or a block backing device. 437# 438# @device: #optional If the stats are for a virtual block device, the name 439# corresponding to the virtual block device. 440# 441# @node-name: #optional The node name of the device. (Since 2.3) 442# 443# @stats: A @BlockDeviceStats for the device. 444# 445# @parent: #optional This describes the file block device if it has one. 446# 447# @backing: #optional This describes the backing block device if it has one. 448# (Since 2.0) 449# 450# Since: 0.14.0 451## 452{ 'type': 'BlockStats', 453 'data': {'*device': 'str', '*node-name': 'str', 454 'stats': 'BlockDeviceStats', 455 '*parent': 'BlockStats', 456 '*backing': 'BlockStats'} } 457 458## 459# @query-blockstats: 460# 461# Query the @BlockStats for all virtual block devices. 462# 463# @query-nodes: #optional If true, the command will query all the block nodes 464# that have a node name, in a list which will include "parent" 465# information, but not "backing". 466# If false or omitted, the behavior is as before - query all the 467# device backends, recursively including their "parent" and 468# "backing". (Since 2.3) 469# 470# Returns: A list of @BlockStats for each virtual block devices. 471# 472# Since: 0.14.0 473## 474{ 'command': 'query-blockstats', 475 'data': { '*query-nodes': 'bool' }, 476 'returns': ['BlockStats'] } 477 478## 479# @BlockdevOnError: 480# 481# An enumeration of possible behaviors for errors on I/O operations. 482# The exact meaning depends on whether the I/O was initiated by a guest 483# or by a block job 484# 485# @report: for guest operations, report the error to the guest; 486# for jobs, cancel the job 487# 488# @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR 489# or BLOCK_JOB_ERROR) 490# 491# @enospc: same as @stop on ENOSPC, same as @report otherwise. 492# 493# @stop: for guest operations, stop the virtual machine; 494# for jobs, pause the job 495# 496# Since: 1.3 497## 498{ 'enum': 'BlockdevOnError', 499 'data': ['report', 'ignore', 'enospc', 'stop'] } 500 501## 502# @MirrorSyncMode: 503# 504# An enumeration of possible behaviors for the initial synchronization 505# phase of storage mirroring. 506# 507# @top: copies data in the topmost image to the destination 508# 509# @full: copies data from all images to the destination 510# 511# @none: only copy data written from now on 512# 513# Since: 1.3 514## 515{ 'enum': 'MirrorSyncMode', 516 'data': ['top', 'full', 'none'] } 517 518## 519# @BlockJobType: 520# 521# Type of a block job. 522# 523# @commit: block commit job type, see "block-commit" 524# 525# @stream: block stream job type, see "block-stream" 526# 527# @mirror: drive mirror job type, see "drive-mirror" 528# 529# @backup: drive backup job type, see "drive-backup" 530# 531# Since: 1.7 532## 533{ 'enum': 'BlockJobType', 534 'data': ['commit', 'stream', 'mirror', 'backup'] } 535 536## 537# @BlockJobInfo: 538# 539# Information about a long-running block device operation. 540# 541# @type: the job type ('stream' for image streaming) 542# 543# @device: the block device name 544# 545# @len: the maximum progress value 546# 547# @busy: false if the job is known to be in a quiescent state, with 548# no pending I/O. Since 1.3. 549# 550# @paused: whether the job is paused or, if @busy is true, will 551# pause itself as soon as possible. Since 1.3. 552# 553# @offset: the current progress value 554# 555# @speed: the rate limit, bytes per second 556# 557# @io-status: the status of the job (since 1.3) 558# 559# @ready: true if the job may be completed (since 2.2) 560# 561# Since: 1.1 562## 563{ 'type': 'BlockJobInfo', 564 'data': {'type': 'str', 'device': 'str', 'len': 'int', 565 'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int', 566 'io-status': 'BlockDeviceIoStatus', 'ready': 'bool'} } 567 568## 569# @query-block-jobs: 570# 571# Return information about long-running block device operations. 572# 573# Returns: a list of @BlockJobInfo for each active block job 574# 575# Since: 1.1 576## 577{ 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'] } 578 579## 580# @block_passwd: 581# 582# This command sets the password of a block device that has not been open 583# with a password and requires one. 584# 585# The two cases where this can happen are a block device is created through 586# QEMU's initial command line or a block device is changed through the legacy 587# @change interface. 588# 589# In the event that the block device is created through the initial command 590# line, the VM will start in the stopped state regardless of whether '-S' is 591# used. The intention is for a management tool to query the block devices to 592# determine which ones are encrypted, set the passwords with this command, and 593# then start the guest with the @cont command. 594# 595# Either @device or @node-name must be set but not both. 596# 597# @device: #optional the name of the block backend device to set the password on 598# 599# @node-name: #optional graph node name to set the password on (Since 2.0) 600# 601# @password: the password to use for the device 602# 603# Returns: nothing on success 604# If @device is not a valid block device, DeviceNotFound 605# If @device is not encrypted, DeviceNotEncrypted 606# 607# Notes: Not all block formats support encryption and some that do are not 608# able to validate that a password is correct. Disk corruption may 609# occur if an invalid password is specified. 610# 611# Since: 0.14.0 612## 613{ 'command': 'block_passwd', 'data': {'*device': 'str', 614 '*node-name': 'str', 'password': 'str'} } 615 616## 617# @block_resize 618# 619# Resize a block image while a guest is running. 620# 621# Either @device or @node-name must be set but not both. 622# 623# @device: #optional the name of the device to get the image resized 624# 625# @node-name: #optional graph node name to get the image resized (Since 2.0) 626# 627# @size: new image size in bytes 628# 629# Returns: nothing on success 630# If @device is not a valid block device, DeviceNotFound 631# 632# Since: 0.14.0 633## 634{ 'command': 'block_resize', 'data': { '*device': 'str', 635 '*node-name': 'str', 636 'size': 'int' }} 637 638## 639# @NewImageMode 640# 641# An enumeration that tells QEMU how to set the backing file path in 642# a new image file. 643# 644# @existing: QEMU should look for an existing image file. 645# 646# @absolute-paths: QEMU should create a new image with absolute paths 647# for the backing file. If there is no backing file available, the new 648# image will not be backed either. 649# 650# Since: 1.1 651## 652{ 'enum': 'NewImageMode', 653 'data': [ 'existing', 'absolute-paths' ] } 654 655## 656# @BlockdevSnapshot 657# 658# Either @device or @node-name must be set but not both. 659# 660# @device: #optional the name of the device to generate the snapshot from. 661# 662# @node-name: #optional graph node name to generate the snapshot from (Since 2.0) 663# 664# @snapshot-file: the target of the new image. A new file will be created. 665# 666# @snapshot-node-name: #optional the graph node name of the new image (Since 2.0) 667# 668# @format: #optional the format of the snapshot image, default is 'qcow2'. 669# 670# @mode: #optional whether and how QEMU should create a new image, default is 671# 'absolute-paths'. 672## 673{ 'type': 'BlockdevSnapshot', 674 'data': { '*device': 'str', '*node-name': 'str', 675 'snapshot-file': 'str', '*snapshot-node-name': 'str', 676 '*format': 'str', '*mode': 'NewImageMode' } } 677 678## 679# @DriveBackup 680# 681# @device: the name of the device which should be copied. 682# 683# @target: the target of the new image. If the file exists, or if it 684# is a device, the existing file/device will be used as the new 685# destination. If it does not exist, a new file will be created. 686# 687# @format: #optional the format of the new destination, default is to 688# probe if @mode is 'existing', else the format of the source 689# 690# @sync: what parts of the disk image should be copied to the destination 691# (all the disk, only the sectors allocated in the topmost image, or 692# only new I/O). 693# 694# @mode: #optional whether and how QEMU should create a new image, default is 695# 'absolute-paths'. 696# 697# @speed: #optional the maximum speed, in bytes per second 698# 699# @on-source-error: #optional the action to take on an error on the source, 700# default 'report'. 'stop' and 'enospc' can only be used 701# if the block device supports io-status (see BlockInfo). 702# 703# @on-target-error: #optional the action to take on an error on the target, 704# default 'report' (no limitations, since this applies to 705# a different block device than @device). 706# 707# Note that @on-source-error and @on-target-error only affect background I/O. 708# If an error occurs during a guest write request, the device's rerror/werror 709# actions will be used. 710# 711# Since: 1.6 712## 713{ 'type': 'DriveBackup', 714 'data': { 'device': 'str', 'target': 'str', '*format': 'str', 715 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode', 716 '*speed': 'int', 717 '*on-source-error': 'BlockdevOnError', 718 '*on-target-error': 'BlockdevOnError' } } 719 720## 721# @BlockdevBackup 722# 723# @device: the name of the device which should be copied. 724# 725# @target: the name of the backup target device. 726# 727# @sync: what parts of the disk image should be copied to the destination 728# (all the disk, only the sectors allocated in the topmost image, or 729# only new I/O). 730# 731# @speed: #optional the maximum speed, in bytes per second. The default is 0, 732# for unlimited. 733# 734# @on-source-error: #optional the action to take on an error on the source, 735# default 'report'. 'stop' and 'enospc' can only be used 736# if the block device supports io-status (see BlockInfo). 737# 738# @on-target-error: #optional the action to take on an error on the target, 739# default 'report' (no limitations, since this applies to 740# a different block device than @device). 741# 742# Note that @on-source-error and @on-target-error only affect background I/O. 743# If an error occurs during a guest write request, the device's rerror/werror 744# actions will be used. 745# 746# Since: 2.3 747## 748{ 'type': 'BlockdevBackup', 749 'data': { 'device': 'str', 'target': 'str', 750 'sync': 'MirrorSyncMode', 751 '*speed': 'int', 752 '*on-source-error': 'BlockdevOnError', 753 '*on-target-error': 'BlockdevOnError' } } 754 755## 756# @blockdev-snapshot-sync 757# 758# Generates a synchronous snapshot of a block device. 759# 760# For the arguments, see the documentation of BlockdevSnapshot. 761# 762# Returns: nothing on success 763# If @device is not a valid block device, DeviceNotFound 764# 765# Since 0.14.0 766## 767{ 'command': 'blockdev-snapshot-sync', 768 'data': 'BlockdevSnapshot' } 769 770## 771# @change-backing-file 772# 773# Change the backing file in the image file metadata. This does not 774# cause QEMU to reopen the image file to reparse the backing filename 775# (it may, however, perform a reopen to change permissions from 776# r/o -> r/w -> r/o, if needed). The new backing file string is written 777# into the image file metadata, and the QEMU internal strings are 778# updated. 779# 780# @image-node-name: The name of the block driver state node of the 781# image to modify. 782# 783# @device: The name of the device that owns image-node-name. 784# 785# @backing-file: The string to write as the backing file. This 786# string is not validated, so care should be taken 787# when specifying the string or the image chain may 788# not be able to be reopened again. 789# 790# Since: 2.1 791## 792{ 'command': 'change-backing-file', 793 'data': { 'device': 'str', 'image-node-name': 'str', 794 'backing-file': 'str' } } 795 796## 797# @block-commit 798# 799# Live commit of data from overlay image nodes into backing nodes - i.e., 800# writes data between 'top' and 'base' into 'base'. 801# 802# @device: the name of the device 803# 804# @base: #optional The file name of the backing image to write data into. 805# If not specified, this is the deepest backing image 806# 807# @top: #optional The file name of the backing image within the image chain, 808# which contains the topmost data to be committed down. If 809# not specified, this is the active layer. 810# 811# @backing-file: #optional The backing file string to write into the overlay 812# image of 'top'. If 'top' is the active layer, 813# specifying a backing file string is an error. This 814# filename is not validated. 815# 816# If a pathname string is such that it cannot be 817# resolved by QEMU, that means that subsequent QMP or 818# HMP commands must use node-names for the image in 819# question, as filename lookup methods will fail. 820# 821# If not specified, QEMU will automatically determine 822# the backing file string to use, or error out if 823# there is no obvious choice. Care should be taken 824# when specifying the string, to specify a valid 825# filename or protocol. 826# (Since 2.1) 827# 828# If top == base, that is an error. 829# If top == active, the job will not be completed by itself, 830# user needs to complete the job with the block-job-complete 831# command after getting the ready event. (Since 2.0) 832# 833# If the base image is smaller than top, then the base image 834# will be resized to be the same size as top. If top is 835# smaller than the base image, the base will not be 836# truncated. If you want the base image size to match the 837# size of the smaller top, you can safely truncate it 838# yourself once the commit operation successfully completes. 839# 840# @speed: #optional the maximum speed, in bytes per second 841# 842# Returns: Nothing on success 843# If commit or stream is already active on this device, DeviceInUse 844# If @device does not exist, DeviceNotFound 845# If image commit is not supported by this device, NotSupported 846# If @base or @top is invalid, a generic error is returned 847# If @speed is invalid, InvalidParameter 848# 849# Since: 1.3 850# 851## 852{ 'command': 'block-commit', 853 'data': { 'device': 'str', '*base': 'str', '*top': 'str', 854 '*backing-file': 'str', '*speed': 'int' } } 855 856## 857# @drive-backup 858# 859# Start a point-in-time copy of a block device to a new destination. The 860# status of ongoing drive-backup operations can be checked with 861# query-block-jobs where the BlockJobInfo.type field has the value 'backup'. 862# The operation can be stopped before it has completed using the 863# block-job-cancel command. 864# 865# For the arguments, see the documentation of DriveBackup. 866# 867# Returns: nothing on success 868# If @device is not a valid block device, DeviceNotFound 869# 870# Since 1.6 871## 872{ 'command': 'drive-backup', 'data': 'DriveBackup' } 873 874## 875# @blockdev-backup 876# 877# Start a point-in-time copy of a block device to a new destination. The 878# status of ongoing blockdev-backup operations can be checked with 879# query-block-jobs where the BlockJobInfo.type field has the value 'backup'. 880# The operation can be stopped before it has completed using the 881# block-job-cancel command. 882# 883# For the arguments, see the documentation of BlockdevBackup. 884# 885# Since 2.3 886## 887{ 'command': 'blockdev-backup', 'data': 'BlockdevBackup' } 888 889 890## 891# @query-named-block-nodes 892# 893# Get the named block driver list 894# 895# Returns: the list of BlockDeviceInfo 896# 897# Since 2.0 898## 899{ 'command': 'query-named-block-nodes', 'returns': [ 'BlockDeviceInfo' ] } 900 901## 902# @drive-mirror 903# 904# Start mirroring a block device's writes to a new destination. 905# 906# @device: the name of the device whose writes should be mirrored. 907# 908# @target: the target of the new image. If the file exists, or if it 909# is a device, the existing file/device will be used as the new 910# destination. If it does not exist, a new file will be created. 911# 912# @format: #optional the format of the new destination, default is to 913# probe if @mode is 'existing', else the format of the source 914# 915# @node-name: #optional the new block driver state node name in the graph 916# (Since 2.1) 917# 918# @replaces: #optional with sync=full graph node name to be replaced by the new 919# image when a whole image copy is done. This can be used to repair 920# broken Quorum files. (Since 2.1) 921# 922# @mode: #optional whether and how QEMU should create a new image, default is 923# 'absolute-paths'. 924# 925# @speed: #optional the maximum speed, in bytes per second 926# 927# @sync: what parts of the disk image should be copied to the destination 928# (all the disk, only the sectors allocated in the topmost image, or 929# only new I/O). 930# 931# @granularity: #optional granularity of the dirty bitmap, default is 64K 932# if the image format doesn't have clusters, 4K if the clusters 933# are smaller than that, else the cluster size. Must be a 934# power of 2 between 512 and 64M (since 1.4). 935# 936# @buf-size: #optional maximum amount of data in flight from source to 937# target (since 1.4). 938# 939# @on-source-error: #optional the action to take on an error on the source, 940# default 'report'. 'stop' and 'enospc' can only be used 941# if the block device supports io-status (see BlockInfo). 942# 943# @on-target-error: #optional the action to take on an error on the target, 944# default 'report' (no limitations, since this applies to 945# a different block device than @device). 946# 947# Returns: nothing on success 948# If @device is not a valid block device, DeviceNotFound 949# 950# Since 1.3 951## 952{ 'command': 'drive-mirror', 953 'data': { 'device': 'str', 'target': 'str', '*format': 'str', 954 '*node-name': 'str', '*replaces': 'str', 955 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode', 956 '*speed': 'int', '*granularity': 'uint32', 957 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError', 958 '*on-target-error': 'BlockdevOnError' } } 959 960## 961# @block_set_io_throttle: 962# 963# Change I/O throttle limits for a block drive. 964# 965# @device: The name of the device 966# 967# @bps: total throughput limit in bytes per second 968# 969# @bps_rd: read throughput limit in bytes per second 970# 971# @bps_wr: write throughput limit in bytes per second 972# 973# @iops: total I/O operations per second 974# 975# @ops_rd: read I/O operations per second 976# 977# @iops_wr: write I/O operations per second 978# 979# @bps_max: #optional total max in bytes (Since 1.7) 980# 981# @bps_rd_max: #optional read max in bytes (Since 1.7) 982# 983# @bps_wr_max: #optional write max in bytes (Since 1.7) 984# 985# @iops_max: #optional total I/O operations max (Since 1.7) 986# 987# @iops_rd_max: #optional read I/O operations max (Since 1.7) 988# 989# @iops_wr_max: #optional write I/O operations max (Since 1.7) 990# 991# @iops_size: #optional an I/O size in bytes (Since 1.7) 992# 993# Returns: Nothing on success 994# If @device is not a valid block device, DeviceNotFound 995# 996# Since: 1.1 997## 998{ 'command': 'block_set_io_throttle', 999 'data': { 'device': 'str', 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int', 1000 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int', 1001 '*bps_max': 'int', '*bps_rd_max': 'int', 1002 '*bps_wr_max': 'int', '*iops_max': 'int', 1003 '*iops_rd_max': 'int', '*iops_wr_max': 'int', 1004 '*iops_size': 'int' } } 1005 1006## 1007# @block-stream: 1008# 1009# Copy data from a backing file into a block device. 1010# 1011# The block streaming operation is performed in the background until the entire 1012# backing file has been copied. This command returns immediately once streaming 1013# has started. The status of ongoing block streaming operations can be checked 1014# with query-block-jobs. The operation can be stopped before it has completed 1015# using the block-job-cancel command. 1016# 1017# If a base file is specified then sectors are not copied from that base file and 1018# its backing chain. When streaming completes the image file will have the base 1019# file as its backing file. This can be used to stream a subset of the backing 1020# file chain instead of flattening the entire image. 1021# 1022# On successful completion the image file is updated to drop the backing file 1023# and the BLOCK_JOB_COMPLETED event is emitted. 1024# 1025# @device: the device name 1026# 1027# @base: #optional the common backing file name 1028# 1029# @backing-file: #optional The backing file string to write into the active 1030# layer. This filename is not validated. 1031# 1032# If a pathname string is such that it cannot be 1033# resolved by QEMU, that means that subsequent QMP or 1034# HMP commands must use node-names for the image in 1035# question, as filename lookup methods will fail. 1036# 1037# If not specified, QEMU will automatically determine 1038# the backing file string to use, or error out if there 1039# is no obvious choice. Care should be taken when 1040# specifying the string, to specify a valid filename or 1041# protocol. 1042# (Since 2.1) 1043# 1044# @speed: #optional the maximum speed, in bytes per second 1045# 1046# @on-error: #optional the action to take on an error (default report). 1047# 'stop' and 'enospc' can only be used if the block device 1048# supports io-status (see BlockInfo). Since 1.3. 1049# 1050# Returns: Nothing on success 1051# If @device does not exist, DeviceNotFound 1052# 1053# Since: 1.1 1054## 1055{ 'command': 'block-stream', 1056 'data': { 'device': 'str', '*base': 'str', '*backing-file': 'str', 1057 '*speed': 'int', '*on-error': 'BlockdevOnError' } } 1058 1059## 1060# @block-job-set-speed: 1061# 1062# Set maximum speed for a background block operation. 1063# 1064# This command can only be issued when there is an active block job. 1065# 1066# Throttling can be disabled by setting the speed to 0. 1067# 1068# @device: the device name 1069# 1070# @speed: the maximum speed, in bytes per second, or 0 for unlimited. 1071# Defaults to 0. 1072# 1073# Returns: Nothing on success 1074# If no background operation is active on this device, DeviceNotActive 1075# 1076# Since: 1.1 1077## 1078{ 'command': 'block-job-set-speed', 1079 'data': { 'device': 'str', 'speed': 'int' } } 1080 1081## 1082# @block-job-cancel: 1083# 1084# Stop an active background block operation. 1085# 1086# This command returns immediately after marking the active background block 1087# operation for cancellation. It is an error to call this command if no 1088# operation is in progress. 1089# 1090# The operation will cancel as soon as possible and then emit the 1091# BLOCK_JOB_CANCELLED event. Before that happens the job is still visible when 1092# enumerated using query-block-jobs. 1093# 1094# For streaming, the image file retains its backing file unless the streaming 1095# operation happens to complete just as it is being cancelled. A new streaming 1096# operation can be started at a later time to finish copying all data from the 1097# backing file. 1098# 1099# @device: the device name 1100# 1101# @force: #optional whether to allow cancellation of a paused job (default 1102# false). Since 1.3. 1103# 1104# Returns: Nothing on success 1105# If no background operation is active on this device, DeviceNotActive 1106# 1107# Since: 1.1 1108## 1109{ 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' } } 1110 1111## 1112# @block-job-pause: 1113# 1114# Pause an active background block operation. 1115# 1116# This command returns immediately after marking the active background block 1117# operation for pausing. It is an error to call this command if no 1118# operation is in progress. Pausing an already paused job has no cumulative 1119# effect; a single block-job-resume command will resume the job. 1120# 1121# The operation will pause as soon as possible. No event is emitted when 1122# the operation is actually paused. Cancelling a paused job automatically 1123# resumes it. 1124# 1125# @device: the device name 1126# 1127# Returns: Nothing on success 1128# If no background operation is active on this device, DeviceNotActive 1129# 1130# Since: 1.3 1131## 1132{ 'command': 'block-job-pause', 'data': { 'device': 'str' } } 1133 1134## 1135# @block-job-resume: 1136# 1137# Resume an active background block operation. 1138# 1139# This command returns immediately after resuming a paused background block 1140# operation. It is an error to call this command if no operation is in 1141# progress. Resuming an already running job is not an error. 1142# 1143# This command also clears the error status of the job. 1144# 1145# @device: the device name 1146# 1147# Returns: Nothing on success 1148# If no background operation is active on this device, DeviceNotActive 1149# 1150# Since: 1.3 1151## 1152{ 'command': 'block-job-resume', 'data': { 'device': 'str' } } 1153 1154## 1155# @block-job-complete: 1156# 1157# Manually trigger completion of an active background block operation. This 1158# is supported for drive mirroring, where it also switches the device to 1159# write to the target path only. The ability to complete is signaled with 1160# a BLOCK_JOB_READY event. 1161# 1162# This command completes an active background block operation synchronously. 1163# The ordering of this command's return with the BLOCK_JOB_COMPLETED event 1164# is not defined. Note that if an I/O error occurs during the processing of 1165# this command: 1) the command itself will fail; 2) the error will be processed 1166# according to the rerror/werror arguments that were specified when starting 1167# the operation. 1168# 1169# A cancelled or paused job cannot be completed. 1170# 1171# @device: the device name 1172# 1173# Returns: Nothing on success 1174# If no background operation is active on this device, DeviceNotActive 1175# 1176# Since: 1.3 1177## 1178{ 'command': 'block-job-complete', 'data': { 'device': 'str' } } 1179 1180## 1181# @BlockdevDiscardOptions 1182# 1183# Determines how to handle discard requests. 1184# 1185# @ignore: Ignore the request 1186# @unmap: Forward as an unmap request 1187# 1188# Since: 1.7 1189## 1190{ 'enum': 'BlockdevDiscardOptions', 1191 'data': [ 'ignore', 'unmap' ] } 1192 1193## 1194# @BlockdevDetectZeroesOptions 1195# 1196# Describes the operation mode for the automatic conversion of plain 1197# zero writes by the OS to driver specific optimized zero write commands. 1198# 1199# @off: Disabled (default) 1200# @on: Enabled 1201# @unmap: Enabled and even try to unmap blocks if possible. This requires 1202# also that @BlockdevDiscardOptions is set to unmap for this device. 1203# 1204# Since: 2.1 1205## 1206{ 'enum': 'BlockdevDetectZeroesOptions', 1207 'data': [ 'off', 'on', 'unmap' ] } 1208 1209## 1210# @BlockdevAioOptions 1211# 1212# Selects the AIO backend to handle I/O requests 1213# 1214# @threads: Use qemu's thread pool 1215# @native: Use native AIO backend (only Linux and Windows) 1216# 1217# Since: 1.7 1218## 1219{ 'enum': 'BlockdevAioOptions', 1220 'data': [ 'threads', 'native' ] } 1221 1222## 1223# @BlockdevCacheOptions 1224# 1225# Includes cache-related options for block devices 1226# 1227# @writeback: #optional enables writeback mode for any caches (default: true) 1228# @direct: #optional enables use of O_DIRECT (bypass the host page cache; 1229# default: false) 1230# @no-flush: #optional ignore any flush requests for the device (default: 1231# false) 1232# 1233# Since: 1.7 1234## 1235{ 'type': 'BlockdevCacheOptions', 1236 'data': { '*writeback': 'bool', 1237 '*direct': 'bool', 1238 '*no-flush': 'bool' } } 1239 1240## 1241# @BlockdevDriver 1242# 1243# Drivers that are supported in block device operations. 1244# 1245# @host_device, @host_cdrom, @host_floppy: Since 2.1 1246# @host_floppy: deprecated since 2.3 1247# 1248# Since: 2.0 1249## 1250{ 'enum': 'BlockdevDriver', 1251 'data': [ 'archipelago', 'blkdebug', 'blkverify', 'bochs', 'cloop', 1252 'dmg', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device', 1253 'host_floppy', 'http', 'https', 'null-aio', 'null-co', 'parallels', 1254 'qcow', 'qcow2', 'qed', 'quorum', 'raw', 'tftp', 'vdi', 'vhdx', 1255 'vmdk', 'vpc', 'vvfat' ] } 1256 1257## 1258# @BlockdevOptionsBase 1259# 1260# Options that are available for all block devices, independent of the block 1261# driver. 1262# 1263# @driver: block driver name 1264# @id: #optional id by which the new block device can be referred to. 1265# This is a required option on the top level of blockdev-add, and 1266# currently not allowed on any other level. 1267# @node-name: #optional the name of a block driver state node (Since 2.0) 1268# @discard: #optional discard-related options (default: ignore) 1269# @cache: #optional cache-related options 1270# @aio: #optional AIO backend (default: threads) 1271# @rerror: #optional how to handle read errors on the device 1272# (default: report) 1273# @werror: #optional how to handle write errors on the device 1274# (default: enospc) 1275# @read-only: #optional whether the block device should be read-only 1276# (default: false) 1277# @detect-zeroes: #optional detect and optimize zero writes (Since 2.1) 1278# (default: off) 1279# 1280# Since: 1.7 1281## 1282{ 'type': 'BlockdevOptionsBase', 1283 'data': { 'driver': 'BlockdevDriver', 1284 '*id': 'str', 1285 '*node-name': 'str', 1286 '*discard': 'BlockdevDiscardOptions', 1287 '*cache': 'BlockdevCacheOptions', 1288 '*aio': 'BlockdevAioOptions', 1289 '*rerror': 'BlockdevOnError', 1290 '*werror': 'BlockdevOnError', 1291 '*read-only': 'bool', 1292 '*detect-zeroes': 'BlockdevDetectZeroesOptions' } } 1293 1294## 1295# @BlockdevOptionsFile 1296# 1297# Driver specific block device options for the file backend and similar 1298# protocols. 1299# 1300# @filename: path to the image file 1301# 1302# Since: 1.7 1303## 1304{ 'type': 'BlockdevOptionsFile', 1305 'data': { 'filename': 'str' } } 1306 1307## 1308# @BlockdevOptionsNull 1309# 1310# Driver specific block device options for the null backend. 1311# 1312# @size: #optional size of the device in bytes. 1313# @latency-ns: #optional emulated latency (in nanoseconds) in processing 1314# requests. Default to zero which completes requests immediately. 1315# (Since 2.4) 1316# 1317# Since: 2.2 1318## 1319{ 'type': 'BlockdevOptionsNull', 1320 'data': { '*size': 'int', '*latency-ns': 'uint64' } } 1321 1322## 1323# @BlockdevOptionsVVFAT 1324# 1325# Driver specific block device options for the vvfat protocol. 1326# 1327# @dir: directory to be exported as FAT image 1328# @fat-type: #optional FAT type: 12, 16 or 32 1329# @floppy: #optional whether to export a floppy image (true) or 1330# partitioned hard disk (false; default) 1331# @rw: #optional whether to allow write operations (default: false) 1332# 1333# Since: 1.7 1334## 1335{ 'type': 'BlockdevOptionsVVFAT', 1336 'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool', 1337 '*rw': 'bool' } } 1338 1339## 1340# @BlockdevOptionsGenericFormat 1341# 1342# Driver specific block device options for image format that have no option 1343# besides their data source. 1344# 1345# @file: reference to or definition of the data source block device 1346# 1347# Since: 1.7 1348## 1349{ 'type': 'BlockdevOptionsGenericFormat', 1350 'data': { 'file': 'BlockdevRef' } } 1351 1352## 1353# @BlockdevOptionsGenericCOWFormat 1354# 1355# Driver specific block device options for image format that have no option 1356# besides their data source and an optional backing file. 1357# 1358# @backing: #optional reference to or definition of the backing file block 1359# device (if missing, taken from the image file content). It is 1360# allowed to pass an empty string here in order to disable the 1361# default backing file. 1362# 1363# Since: 1.7 1364## 1365{ 'type': 'BlockdevOptionsGenericCOWFormat', 1366 'base': 'BlockdevOptionsGenericFormat', 1367 'data': { '*backing': 'BlockdevRef' } } 1368 1369## 1370# @Qcow2OverlapCheckMode 1371# 1372# General overlap check modes. 1373# 1374# @none: Do not perform any checks 1375# 1376# @constant: Perform only checks which can be done in constant time and 1377# without reading anything from disk 1378# 1379# @cached: Perform only checks which can be done without reading anything 1380# from disk 1381# 1382# @all: Perform all available overlap checks 1383# 1384# Since: 2.2 1385## 1386{ 'enum': 'Qcow2OverlapCheckMode', 1387 'data': [ 'none', 'constant', 'cached', 'all' ] } 1388 1389## 1390# @Qcow2OverlapCheckFlags 1391# 1392# Structure of flags for each metadata structure. Setting a field to 'true' 1393# makes qemu guard that structure against unintended overwriting. The default 1394# value is chosen according to the template given. 1395# 1396# @template: Specifies a template mode which can be adjusted using the other 1397# flags, defaults to 'cached' 1398# 1399# Since: 2.2 1400## 1401{ 'type': 'Qcow2OverlapCheckFlags', 1402 'data': { '*template': 'Qcow2OverlapCheckMode', 1403 '*main-header': 'bool', 1404 '*active-l1': 'bool', 1405 '*active-l2': 'bool', 1406 '*refcount-table': 'bool', 1407 '*refcount-block': 'bool', 1408 '*snapshot-table': 'bool', 1409 '*inactive-l1': 'bool', 1410 '*inactive-l2': 'bool' } } 1411 1412## 1413# @Qcow2OverlapChecks 1414# 1415# Specifies which metadata structures should be guarded against unintended 1416# overwriting. 1417# 1418# @flags: set of flags for separate specification of each metadata structure 1419# type 1420# 1421# @mode: named mode which chooses a specific set of flags 1422# 1423# Since: 2.2 1424## 1425{ 'union': 'Qcow2OverlapChecks', 1426 'discriminator': {}, 1427 'data': { 'flags': 'Qcow2OverlapCheckFlags', 1428 'mode': 'Qcow2OverlapCheckMode' } } 1429 1430## 1431# @BlockdevOptionsQcow2 1432# 1433# Driver specific block device options for qcow2. 1434# 1435# @lazy-refcounts: #optional whether to enable the lazy refcounts 1436# feature (default is taken from the image file) 1437# 1438# @pass-discard-request: #optional whether discard requests to the qcow2 1439# device should be forwarded to the data source 1440# 1441# @pass-discard-snapshot: #optional whether discard requests for the data source 1442# should be issued when a snapshot operation (e.g. 1443# deleting a snapshot) frees clusters in the qcow2 file 1444# 1445# @pass-discard-other: #optional whether discard requests for the data source 1446# should be issued on other occasions where a cluster 1447# gets freed 1448# 1449# @overlap-check: #optional which overlap checks to perform for writes 1450# to the image, defaults to 'cached' (since 2.2) 1451# 1452# @cache-size: #optional the maximum total size of the L2 table and 1453# refcount block caches in bytes (since 2.2) 1454# 1455# @l2-cache-size: #optional the maximum size of the L2 table cache in 1456# bytes (since 2.2) 1457# 1458# @refcount-cache-size: #optional the maximum size of the refcount block cache 1459# in bytes (since 2.2) 1460# 1461# Since: 1.7 1462## 1463{ 'type': 'BlockdevOptionsQcow2', 1464 'base': 'BlockdevOptionsGenericCOWFormat', 1465 'data': { '*lazy-refcounts': 'bool', 1466 '*pass-discard-request': 'bool', 1467 '*pass-discard-snapshot': 'bool', 1468 '*pass-discard-other': 'bool', 1469 '*overlap-check': 'Qcow2OverlapChecks', 1470 '*cache-size': 'int', 1471 '*l2-cache-size': 'int', 1472 '*refcount-cache-size': 'int' } } 1473 1474 1475## 1476# @BlockdevOptionsArchipelago 1477# 1478# Driver specific block device options for Archipelago. 1479# 1480# @volume: Name of the Archipelago volume image 1481# 1482# @mport: #optional The port number on which mapperd is 1483# listening. This is optional 1484# and if not specified, QEMU will make Archipelago 1485# use the default port (1001). 1486# 1487# @vport: #optional The port number on which vlmcd is 1488# listening. This is optional 1489# and if not specified, QEMU will make Archipelago 1490# use the default port (501). 1491# 1492# @segment: #optional The name of the shared memory segment 1493# Archipelago stack is using. This is optional 1494# and if not specified, QEMU will make Archipelago 1495# use the default value, 'archipelago'. 1496# Since: 2.2 1497## 1498{ 'type': 'BlockdevOptionsArchipelago', 1499 'data': { 'volume': 'str', 1500 '*mport': 'int', 1501 '*vport': 'int', 1502 '*segment': 'str' } } 1503 1504 1505## 1506# @BlkdebugEvent 1507# 1508# Trigger events supported by blkdebug. 1509## 1510{ 'enum': 'BlkdebugEvent', 1511 'data': [ 'l1_update', 'l1_grow.alloc_table', 'l1_grow.write_table', 1512 'l1_grow.activate_table', 'l2_load', 'l2_update', 1513 'l2_update_compressed', 'l2_alloc.cow_read', 'l2_alloc.write', 1514 'read_aio', 'read_backing_aio', 'read_compressed', 'write_aio', 1515 'write_compressed', 'vmstate_load', 'vmstate_save', 'cow_read', 1516 'cow_write', 'reftable_load', 'reftable_grow', 'reftable_update', 1517 'refblock_load', 'refblock_update', 'refblock_update_part', 1518 'refblock_alloc', 'refblock_alloc.hookup', 'refblock_alloc.write', 1519 'refblock_alloc.write_blocks', 'refblock_alloc.write_table', 1520 'refblock_alloc.switch_table', 'cluster_alloc', 1521 'cluster_alloc_bytes', 'cluster_free', 'flush_to_os', 1522 'flush_to_disk', 'pwritev_rmw.head', 'pwritev_rmw.after_head', 1523 'pwritev_rmw.tail', 'pwritev_rmw.after_tail', 'pwritev', 1524 'pwritev_zero', 'pwritev_done', 'empty_image_prepare' ] } 1525 1526## 1527# @BlkdebugInjectErrorOptions 1528# 1529# Describes a single error injection for blkdebug. 1530# 1531# @event: trigger event 1532# 1533# @state: #optional the state identifier blkdebug needs to be in to 1534# actually trigger the event; defaults to "any" 1535# 1536# @errno: #optional error identifier (errno) to be returned; defaults to 1537# EIO 1538# 1539# @sector: #optional specifies the sector index which has to be affected 1540# in order to actually trigger the event; defaults to "any 1541# sector" 1542# 1543# @once: #optional disables further events after this one has been 1544# triggered; defaults to false 1545# 1546# @immediately: #optional fail immediately; defaults to false 1547# 1548# Since: 2.0 1549## 1550{ 'type': 'BlkdebugInjectErrorOptions', 1551 'data': { 'event': 'BlkdebugEvent', 1552 '*state': 'int', 1553 '*errno': 'int', 1554 '*sector': 'int', 1555 '*once': 'bool', 1556 '*immediately': 'bool' } } 1557 1558## 1559# @BlkdebugSetStateOptions 1560# 1561# Describes a single state-change event for blkdebug. 1562# 1563# @event: trigger event 1564# 1565# @state: #optional the current state identifier blkdebug needs to be in; 1566# defaults to "any" 1567# 1568# @new_state: the state identifier blkdebug is supposed to assume if 1569# this event is triggered 1570# 1571# Since: 2.0 1572## 1573{ 'type': 'BlkdebugSetStateOptions', 1574 'data': { 'event': 'BlkdebugEvent', 1575 '*state': 'int', 1576 'new_state': 'int' } } 1577 1578## 1579# @BlockdevOptionsBlkdebug 1580# 1581# Driver specific block device options for blkdebug. 1582# 1583# @image: underlying raw block device (or image file) 1584# 1585# @config: #optional filename of the configuration file 1586# 1587# @align: #optional required alignment for requests in bytes 1588# 1589# @inject-error: #optional array of error injection descriptions 1590# 1591# @set-state: #optional array of state-change descriptions 1592# 1593# Since: 2.0 1594## 1595{ 'type': 'BlockdevOptionsBlkdebug', 1596 'data': { 'image': 'BlockdevRef', 1597 '*config': 'str', 1598 '*align': 'int', 1599 '*inject-error': ['BlkdebugInjectErrorOptions'], 1600 '*set-state': ['BlkdebugSetStateOptions'] } } 1601 1602## 1603# @BlockdevOptionsBlkverify 1604# 1605# Driver specific block device options for blkverify. 1606# 1607# @test: block device to be tested 1608# 1609# @raw: raw image used for verification 1610# 1611# Since: 2.0 1612## 1613{ 'type': 'BlockdevOptionsBlkverify', 1614 'data': { 'test': 'BlockdevRef', 1615 'raw': 'BlockdevRef' } } 1616 1617## 1618# @QuorumReadPattern 1619# 1620# An enumeration of quorum read patterns. 1621# 1622# @quorum: read all the children and do a quorum vote on reads 1623# 1624# @fifo: read only from the first child that has not failed 1625# 1626# Since: 2.2 1627## 1628{ 'enum': 'QuorumReadPattern', 'data': [ 'quorum', 'fifo' ] } 1629 1630## 1631# @BlockdevOptionsQuorum 1632# 1633# Driver specific block device options for Quorum 1634# 1635# @blkverify: #optional true if the driver must print content mismatch 1636# set to false by default 1637# 1638# @children: the children block devices to use 1639# 1640# @vote-threshold: the vote limit under which a read will fail 1641# 1642# @rewrite-corrupted: #optional rewrite corrupted data when quorum is reached 1643# (Since 2.1) 1644# 1645# @read-pattern: #optional choose read pattern and set to quorum by default 1646# (Since 2.2) 1647# 1648# Since: 2.0 1649## 1650{ 'type': 'BlockdevOptionsQuorum', 1651 'data': { '*blkverify': 'bool', 1652 'children': [ 'BlockdevRef' ], 1653 'vote-threshold': 'int', 1654 '*rewrite-corrupted': 'bool', 1655 '*read-pattern': 'QuorumReadPattern' } } 1656 1657## 1658# @BlockdevOptions 1659# 1660# Options for creating a block device. 1661# 1662# Since: 1.7 1663## 1664{ 'union': 'BlockdevOptions', 1665 'base': 'BlockdevOptionsBase', 1666 'discriminator': 'driver', 1667 'data': { 1668 'archipelago':'BlockdevOptionsArchipelago', 1669 'blkdebug': 'BlockdevOptionsBlkdebug', 1670 'blkverify': 'BlockdevOptionsBlkverify', 1671 'bochs': 'BlockdevOptionsGenericFormat', 1672 'cloop': 'BlockdevOptionsGenericFormat', 1673 'dmg': 'BlockdevOptionsGenericFormat', 1674 'file': 'BlockdevOptionsFile', 1675 'ftp': 'BlockdevOptionsFile', 1676 'ftps': 'BlockdevOptionsFile', 1677# TODO gluster: Wait for structured options 1678 'host_cdrom': 'BlockdevOptionsFile', 1679 'host_device':'BlockdevOptionsFile', 1680 'host_floppy':'BlockdevOptionsFile', 1681 'http': 'BlockdevOptionsFile', 1682 'https': 'BlockdevOptionsFile', 1683# TODO iscsi: Wait for structured options 1684# TODO nbd: Should take InetSocketAddress for 'host'? 1685# TODO nfs: Wait for structured options 1686 'null-aio': 'BlockdevOptionsNull', 1687 'null-co': 'BlockdevOptionsNull', 1688 'parallels': 'BlockdevOptionsGenericFormat', 1689 'qcow2': 'BlockdevOptionsQcow2', 1690 'qcow': 'BlockdevOptionsGenericCOWFormat', 1691 'qed': 'BlockdevOptionsGenericCOWFormat', 1692 'quorum': 'BlockdevOptionsQuorum', 1693 'raw': 'BlockdevOptionsGenericFormat', 1694# TODO rbd: Wait for structured options 1695# TODO sheepdog: Wait for structured options 1696# TODO ssh: Should take InetSocketAddress for 'host'? 1697 'tftp': 'BlockdevOptionsFile', 1698 'vdi': 'BlockdevOptionsGenericFormat', 1699 'vhdx': 'BlockdevOptionsGenericFormat', 1700 'vmdk': 'BlockdevOptionsGenericCOWFormat', 1701 'vpc': 'BlockdevOptionsGenericFormat', 1702 'vvfat': 'BlockdevOptionsVVFAT' 1703 } } 1704 1705## 1706# @BlockdevRef 1707# 1708# Reference to a block device. 1709# 1710# @definition: defines a new block device inline 1711# @reference: references the ID of an existing block device. An 1712# empty string means that no block device should be 1713# referenced. 1714# 1715# Since: 1.7 1716## 1717{ 'union': 'BlockdevRef', 1718 'discriminator': {}, 1719 'data': { 'definition': 'BlockdevOptions', 1720 'reference': 'str' } } 1721 1722## 1723# @blockdev-add: 1724# 1725# Creates a new block device. 1726# 1727# This command is still a work in progress. It doesn't support all 1728# block drivers, it lacks a matching blockdev-del, and more. Stay 1729# away from it unless you want to help with its development. 1730# 1731# @options: block device options for the new device 1732# 1733# Since: 1.7 1734## 1735{ 'command': 'blockdev-add', 'data': { 'options': 'BlockdevOptions' } } 1736 1737 1738## 1739# @BlockErrorAction 1740# 1741# An enumeration of action that has been taken when a DISK I/O occurs 1742# 1743# @ignore: error has been ignored 1744# 1745# @report: error has been reported to the device 1746# 1747# @stop: error caused VM to be stopped 1748# 1749# Since: 2.1 1750## 1751{ 'enum': 'BlockErrorAction', 1752 'data': [ 'ignore', 'report', 'stop' ] } 1753 1754 1755## 1756# @BLOCK_IMAGE_CORRUPTED 1757# 1758# Emitted when a corruption has been detected in a disk image 1759# 1760# @device: device name. This is always present for compatibility 1761# reasons, but it can be empty ("") if the image does not 1762# have a device name associated. 1763# 1764# @node-name: #optional node name (Since: 2.4) 1765# 1766# @msg: informative message for human consumption, such as the kind of 1767# corruption being detected. It should not be parsed by machine as it is 1768# not guaranteed to be stable 1769# 1770# @offset: #optional, if the corruption resulted from an image access, this is 1771# the access offset into the image 1772# 1773# @size: #optional, if the corruption resulted from an image access, this is 1774# the access size 1775# 1776# fatal: if set, the image is marked corrupt and therefore unusable after this 1777# event and must be repaired (Since 2.2; before, every 1778# BLOCK_IMAGE_CORRUPTED event was fatal) 1779# 1780# Since: 1.7 1781## 1782{ 'event': 'BLOCK_IMAGE_CORRUPTED', 1783 'data': { 'device' : 'str', 1784 '*node-name' : 'str', 1785 'msg' : 'str', 1786 '*offset' : 'int', 1787 '*size' : 'int', 1788 'fatal' : 'bool' } } 1789 1790## 1791# @BLOCK_IO_ERROR 1792# 1793# Emitted when a disk I/O error occurs 1794# 1795# @device: device name 1796# 1797# @operation: I/O operation 1798# 1799# @action: action that has been taken 1800# 1801# @nospace: #optional true if I/O error was caused due to a no-space 1802# condition. This key is only present if query-block's 1803# io-status is present, please see query-block documentation 1804# for more information (since: 2.2) 1805# 1806# @reason: human readable string describing the error cause. 1807# (This field is a debugging aid for humans, it should not 1808# be parsed by applications) (since: 2.2) 1809# 1810# Note: If action is "stop", a STOP event will eventually follow the 1811# BLOCK_IO_ERROR event 1812# 1813# Since: 0.13.0 1814## 1815{ 'event': 'BLOCK_IO_ERROR', 1816 'data': { 'device': 'str', 'operation': 'IoOperationType', 1817 'action': 'BlockErrorAction', '*nospace': 'bool', 1818 'reason': 'str' } } 1819 1820## 1821# @BLOCK_JOB_COMPLETED 1822# 1823# Emitted when a block job has completed 1824# 1825# @type: job type 1826# 1827# @device: device name 1828# 1829# @len: maximum progress value 1830# 1831# @offset: current progress value. On success this is equal to len. 1832# On failure this is less than len 1833# 1834# @speed: rate limit, bytes per second 1835# 1836# @error: #optional, error message. Only present on failure. This field 1837# contains a human-readable error message. There are no semantics 1838# other than that streaming has failed and clients should not try to 1839# interpret the error string 1840# 1841# Since: 1.1 1842## 1843{ 'event': 'BLOCK_JOB_COMPLETED', 1844 'data': { 'type' : 'BlockJobType', 1845 'device': 'str', 1846 'len' : 'int', 1847 'offset': 'int', 1848 'speed' : 'int', 1849 '*error': 'str' } } 1850 1851## 1852# @BLOCK_JOB_CANCELLED 1853# 1854# Emitted when a block job has been cancelled 1855# 1856# @type: job type 1857# 1858# @device: device name 1859# 1860# @len: maximum progress value 1861# 1862# @offset: current progress value. On success this is equal to len. 1863# On failure this is less than len 1864# 1865# @speed: rate limit, bytes per second 1866# 1867# Since: 1.1 1868## 1869{ 'event': 'BLOCK_JOB_CANCELLED', 1870 'data': { 'type' : 'BlockJobType', 1871 'device': 'str', 1872 'len' : 'int', 1873 'offset': 'int', 1874 'speed' : 'int' } } 1875 1876## 1877# @BLOCK_JOB_ERROR 1878# 1879# Emitted when a block job encounters an error 1880# 1881# @device: device name 1882# 1883# @operation: I/O operation 1884# 1885# @action: action that has been taken 1886# 1887# Since: 1.3 1888## 1889{ 'event': 'BLOCK_JOB_ERROR', 1890 'data': { 'device' : 'str', 1891 'operation': 'IoOperationType', 1892 'action' : 'BlockErrorAction' } } 1893 1894## 1895# @BLOCK_JOB_READY 1896# 1897# Emitted when a block job is ready to complete 1898# 1899# @type: job type 1900# 1901# @device: device name 1902# 1903# @len: maximum progress value 1904# 1905# @offset: current progress value. On success this is equal to len. 1906# On failure this is less than len 1907# 1908# @speed: rate limit, bytes per second 1909# 1910# Note: The "ready to complete" status is always reset by a @BLOCK_JOB_ERROR 1911# event 1912# 1913# Since: 1.3 1914## 1915{ 'event': 'BLOCK_JOB_READY', 1916 'data': { 'type' : 'BlockJobType', 1917 'device': 'str', 1918 'len' : 'int', 1919 'offset': 'int', 1920 'speed' : 'int' } } 1921 1922# @PreallocMode 1923# 1924# Preallocation mode of QEMU image file 1925# 1926# @off: no preallocation 1927# @metadata: preallocate only for metadata 1928# @falloc: like @full preallocation but allocate disk space by 1929# posix_fallocate() rather than writing zeros. 1930# @full: preallocate all data by writing zeros to device to ensure disk 1931# space is really available. @full preallocation also sets up 1932# metadata correctly. 1933# 1934# Since 2.2 1935## 1936{ 'enum': 'PreallocMode', 1937 'data': [ 'off', 'metadata', 'falloc', 'full' ] } 1938 1939## 1940# @BLOCK_WRITE_THRESHOLD 1941# 1942# Emitted when writes on block device reaches or exceeds the 1943# configured write threshold. For thin-provisioned devices, this 1944# means the device should be extended to avoid pausing for 1945# disk exhaustion. 1946# The event is one shot. Once triggered, it needs to be 1947# re-registered with another block-set-threshold command. 1948# 1949# @node-name: graph node name on which the threshold was exceeded. 1950# 1951# @amount-exceeded: amount of data which exceeded the threshold, in bytes. 1952# 1953# @write-threshold: last configured threshold, in bytes. 1954# 1955# Since: 2.3 1956## 1957{ 'event': 'BLOCK_WRITE_THRESHOLD', 1958 'data': { 'node-name': 'str', 1959 'amount-exceeded': 'uint64', 1960 'write-threshold': 'uint64' } } 1961 1962## 1963# @block-set-write-threshold 1964# 1965# Change the write threshold for a block drive. An event will be delivered 1966# if a write to this block drive crosses the configured threshold. 1967# This is useful to transparently resize thin-provisioned drives without 1968# the guest OS noticing. 1969# 1970# @node-name: graph node name on which the threshold must be set. 1971# 1972# @write-threshold: configured threshold for the block device, bytes. 1973# Use 0 to disable the threshold. 1974# 1975# Since: 2.3 1976## 1977{ 'command': 'block-set-write-threshold', 1978 'data': { 'node-name': 'str', 'write-threshold': 'uint64' } } 1979