qapi/block-core.json

   1 # -*- Mode: Python -*-
   2
   3 ##
   4 # == QAPI block core definitions (vm unrelated)
   5 ##
   6
   7 # QAPI common definitions
   8 { 'include': 'common.json' }
   9
  10 ##
  11 # @SnapshotInfo:
  12 #
  13 # @id: unique snapshot id
  14 #
  15 # @name: user chosen name
  16 #
  17 # @vm-state-size: size of the VM state
  18 #
  19 # @date-sec: UTC date of the snapshot in seconds
  20 #
  21 # @date-nsec: fractional part in nano seconds to be used with date-sec
  22 #
  23 # @vm-clock-sec: VM clock relative to boot in seconds
  24 #
  25 # @vm-clock-nsec: fractional part in nano seconds to be used with vm-clock-sec
  26 #
  27 # Since: 1.3
  28 #
  29 ##
  30 { 'struct': 'SnapshotInfo',
  31   'data': { 'id': 'str', 'name': 'str', 'vm-state-size': 'int',
  32             'date-sec': 'int', 'date-nsec': 'int',
  33             'vm-clock-sec': 'int', 'vm-clock-nsec': 'int' } }
  34
  35 ##
  36 # @ImageInfoSpecificQCow2:
  37 #
  38 # @compat: compatibility level
  39 #
  40 # @lazy-refcounts: on or off; only valid for compat >= 1.1
  41 #
  42 # @corrupt: true if the image has been marked corrupt; only valid for
  43 #           compat >= 1.1 (since 2.2)
  44 #
  45 # @refcount-bits: width of a refcount entry in bits (since 2.3)
  46 #
  47 # Since: 1.7
  48 ##
  49 { 'struct': 'ImageInfoSpecificQCow2',
  50   'data': {
  51       'compat': 'str',
  52       '*lazy-refcounts': 'bool',
  53       '*corrupt': 'bool',
  54       'refcount-bits': 'int'
  55   } }
  56
  57 ##
  58 # @ImageInfoSpecificVmdk:
  59 #
  60 # @create-type: The create type of VMDK image
  61 #
  62 # @cid: Content id of image
  63 #
  64 # @parent-cid: Parent VMDK image's cid
  65 #
  66 # @extents: List of extent files
  67 #
  68 # Since: 1.7
  69 ##
  70 { 'struct': 'ImageInfoSpecificVmdk',
  71   'data': {
  72       'create-type': 'str',
  73       'cid': 'int',
  74       'parent-cid': 'int',
  75       'extents': ['ImageInfo']
  76   } }
  77
  78 ##
  79 # @ImageInfoSpecific:
  80 #
  81 # A discriminated record of image format specific information structures.
  82 #
  83 # Since: 1.7
  84 ##
  85 { 'union': 'ImageInfoSpecific',
  86   'data': {
  87       'qcow2': 'ImageInfoSpecificQCow2',
  88       'vmdk': 'ImageInfoSpecificVmdk',
  89       # If we need to add block driver specific parameters for
  90       # LUKS in future, then we'll subclass QCryptoBlockInfoLUKS
  91       # to define a ImageInfoSpecificLUKS
  92       'luks': 'QCryptoBlockInfoLUKS'
  93   } }
  94
  95 ##
  96 # @ImageInfo:
  97 #
  98 # Information about a QEMU image file
  99 #
 100 # @filename: name of the image file
 101 #
 102 # @format: format of the image file
 103 #
 104 # @virtual-size: maximum capacity in bytes of the image
 105 #
 106 # @actual-size: actual size on disk in bytes of the image
 107 #
 108 # @dirty-flag: true if image is not cleanly closed
 109 #
 110 # @cluster-size: size of a cluster in bytes
 111 #
 112 # @encrypted: true if the image is encrypted
 113 #
 114 # @compressed: true if the image is compressed (Since 1.7)
 115 #
 116 # @backing-filename: name of the backing file
 117 #
 118 # @full-backing-filename: full path of the backing file
 119 #
 120 # @backing-filename-format: the format of the backing file
 121 #
 122 # @snapshots: list of VM snapshots
 123 #
 124 # @backing-image: info of the backing image (since 1.6)
 125 #
 126 # @format-specific: structure supplying additional format-specific
 127 # information (since 1.7)
 128 #
 129 # Since: 1.3
 130 #
 131 ##
 132 { 'struct': 'ImageInfo',
 133   'data': {'filename': 'str', 'format': 'str', '*dirty-flag': 'bool',
 134            '*actual-size': 'int', 'virtual-size': 'int',
 135            '*cluster-size': 'int', '*encrypted': 'bool', '*compressed': 'bool',
 136            '*backing-filename': 'str', '*full-backing-filename': 'str',
 137            '*backing-filename-format': 'str', '*snapshots': ['SnapshotInfo'],
 138            '*backing-image': 'ImageInfo',
 139            '*format-specific': 'ImageInfoSpecific' } }
 140
 141 ##
 142 # @ImageCheck:
 143 #
 144 # Information about a QEMU image file check
 145 #
 146 # @filename: name of the image file checked
 147 #
 148 # @format: format of the image file checked
 149 #
 150 # @check-errors: number of unexpected errors occurred during check
 151 #
 152 # @image-end-offset: offset (in bytes) where the image ends, this
 153 #                    field is present if the driver for the image format
 154 #                    supports it
 155 #
 156 # @corruptions: number of corruptions found during the check if any
 157 #
 158 # @leaks: number of leaks found during the check if any
 159 #
 160 # @corruptions-fixed: number of corruptions fixed during the check
 161 #                     if any
 162 #
 163 # @leaks-fixed: number of leaks fixed during the check if any
 164 #
 165 # @total-clusters: total number of clusters, this field is present
 166 #                  if the driver for the image format supports it
 167 #
 168 # @allocated-clusters: total number of allocated clusters, this
 169 #                      field is present if the driver for the image format
 170 #                      supports it
 171 #
 172 # @fragmented-clusters: total number of fragmented clusters, this
 173 #                       field is present if the driver for the image format
 174 #                       supports it
 175 #
 176 # @compressed-clusters: total number of compressed clusters, this
 177 #                       field is present if the driver for the image format
 178 #                       supports it
 179 #
 180 # Since: 1.4
 181 #
 182 ##
 183 { 'struct': 'ImageCheck',
 184   'data': {'filename': 'str', 'format': 'str', 'check-errors': 'int',
 185            '*image-end-offset': 'int', '*corruptions': 'int', '*leaks': 'int',
 186            '*corruptions-fixed': 'int', '*leaks-fixed': 'int',
 187            '*total-clusters': 'int', '*allocated-clusters': 'int',
 188            '*fragmented-clusters': 'int', '*compressed-clusters': 'int' } }
 189
 190 ##
 191 # @MapEntry:
 192 #
 193 # Mapping information from a virtual block range to a host file range
 194 #
 195 # @start: the start byte of the mapped virtual range
 196 #
 197 # @length: the number of bytes of the mapped virtual range
 198 #
 199 # @data: whether the mapped range has data
 200 #
 201 # @zero: whether the virtual blocks are zeroed
 202 #
 203 # @depth: the depth of the mapping
 204 #
 205 # @offset: the offset in file that the virtual sectors are mapped to
 206 #
 207 # @filename: filename that is referred to by @offset
 208 #
 209 # Since: 2.6
 210 #
 211 ##
 212 { 'struct': 'MapEntry',
 213   'data': {'start': 'int', 'length': 'int', 'data': 'bool',
 214            'zero': 'bool', 'depth': 'int', '*offset': 'int',
 215            '*filename': 'str' } }
 216
 217 ##
 218 # @BlockdevCacheInfo:
 219 #
 220 # Cache mode information for a block device
 221 #
 222 # @writeback:   true if writeback mode is enabled
 223 # @direct:      true if the host page cache is bypassed (O_DIRECT)
 224 # @no-flush:    true if flush requests are ignored for the device
 225 #
 226 # Since: 2.3
 227 ##
 228 { 'struct': 'BlockdevCacheInfo',
 229   'data': { 'writeback': 'bool',
 230             'direct': 'bool',
 231             'no-flush': 'bool' } }
 232
 233 ##
 234 # @BlockDeviceInfo:
 235 #
 236 # Information about the backing device for a block device.
 237 #
 238 # @file: the filename of the backing device
 239 #
 240 # @node-name: the name of the block driver node (Since 2.0)
 241 #
 242 # @ro: true if the backing device was open read-only
 243 #
 244 # @drv: the name of the block format used to open the backing device. As of
 245 #       0.14.0 this can be: 'blkdebug', 'bochs', 'cloop', 'cow', 'dmg',
 246 #       'file', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
 247 #       'http', 'https', 'luks', 'nbd', 'parallels', 'qcow',
 248 #       'qcow2', 'raw', 'vdi', 'vmdk', 'vpc', 'vvfat'
 249 #       2.2: 'archipelago' added, 'cow' dropped
 250 #       2.3: 'host_floppy' deprecated
 251 #       2.5: 'host_floppy' dropped
 252 #       2.6: 'luks' added
 253 #       2.8: 'replication' added, 'tftp' dropped
 254 #       2.9: 'archipelago' dropped
 255 #
 256 # @backing_file: the name of the backing file (for copy-on-write)
 257 #
 258 # @backing_file_depth: number of files in the backing file chain (since: 1.2)
 259 #
 260 # @encrypted: true if the backing device is encrypted
 261 #
 262 # @encryption_key_missing: true if the backing device is encrypted but an
 263 #                          valid encryption key is missing
 264 #
 265 # @detect_zeroes: detect and optimize zero writes (Since 2.1)
 266 #
 267 # @bps: total throughput limit in bytes per second is specified
 268 #
 269 # @bps_rd: read throughput limit in bytes per second is specified
 270 #
 271 # @bps_wr: write throughput limit in bytes per second is specified
 272 #
 273 # @iops: total I/O operations per second is specified
 274 #
 275 # @iops_rd: read I/O operations per second is specified
 276 #
 277 # @iops_wr: write I/O operations per second is specified
 278 #
 279 # @image: the info of image used (since: 1.6)
 280 #
 281 # @bps_max: total throughput limit during bursts,
 282 #                     in bytes (Since 1.7)
 283 #
 284 # @bps_rd_max: read throughput limit during bursts,
 285 #                        in bytes (Since 1.7)
 286 #
 287 # @bps_wr_max: write throughput limit during bursts,
 288 #                        in bytes (Since 1.7)
 289 #
 290 # @iops_max: total I/O operations per second during bursts,
 291 #                      in bytes (Since 1.7)
 292 #
 293 # @iops_rd_max: read I/O operations per second during bursts,
 294 #                         in bytes (Since 1.7)
 295 #
 296 # @iops_wr_max: write I/O operations per second during bursts,
 297 #                         in bytes (Since 1.7)
 298 #
 299 # @bps_max_length: maximum length of the @bps_max burst
 300 #                            period, in seconds. (Since 2.6)
 301 #
 302 # @bps_rd_max_length: maximum length of the @bps_rd_max
 303 #                               burst period, in seconds. (Since 2.6)
 304 #
 305 # @bps_wr_max_length: maximum length of the @bps_wr_max
 306 #                               burst period, in seconds. (Since 2.6)
 307 #
 308 # @iops_max_length: maximum length of the @iops burst
 309 #                             period, in seconds. (Since 2.6)
 310 #
 311 # @iops_rd_max_length: maximum length of the @iops_rd_max
 312 #                                burst period, in seconds. (Since 2.6)
 313 #
 314 # @iops_wr_max_length: maximum length of the @iops_wr_max
 315 #                                burst period, in seconds. (Since 2.6)
 316 #
 317 # @iops_size: an I/O size in bytes (Since 1.7)
 318 #
 319 # @group: throttle group name (Since 2.4)
 320 #
 321 # @cache: the cache mode used for the block device (since: 2.3)
 322 #
 323 # @write_threshold: configured write threshold for the device.
 324 #                   0 if disabled. (Since 2.3)
 325 #
 326 # Since: 0.14.0
 327 #
 328 ##
 329 { 'struct': 'BlockDeviceInfo',
 330   'data': { 'file': 'str', '*node-name': 'str', 'ro': 'bool', 'drv': 'str',
 331             '*backing_file': 'str', 'backing_file_depth': 'int',
 332             'encrypted': 'bool', 'encryption_key_missing': 'bool',
 333             'detect_zeroes': 'BlockdevDetectZeroesOptions',
 334             'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
 335             'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
 336             'image': 'ImageInfo',
 337             '*bps_max': 'int', '*bps_rd_max': 'int',
 338             '*bps_wr_max': 'int', '*iops_max': 'int',
 339             '*iops_rd_max': 'int', '*iops_wr_max': 'int',
 340             '*bps_max_length': 'int', '*bps_rd_max_length': 'int',
 341             '*bps_wr_max_length': 'int', '*iops_max_length': 'int',
 342             '*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int',
 343             '*iops_size': 'int', '*group': 'str', 'cache': 'BlockdevCacheInfo',
 344             'write_threshold': 'int' } }
 345
 346 ##
 347 # @BlockDeviceIoStatus:
 348 #
 349 # An enumeration of block device I/O status.
 350 #
 351 # @ok: The last I/O operation has succeeded
 352 #
 353 # @failed: The last I/O operation has failed
 354 #
 355 # @nospace: The last I/O operation has failed due to a no-space condition
 356 #
 357 # Since: 1.0
 358 ##
 359 { 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] }
 360
 361 ##
 362 # @BlockDeviceMapEntry:
 363 #
 364 # Entry in the metadata map of the device (returned by "qemu-img map")
 365 #
 366 # @start: Offset in the image of the first byte described by this entry
 367 #         (in bytes)
 368 #
 369 # @length: Length of the range described by this entry (in bytes)
 370 #
 371 # @depth: Number of layers (0 = top image, 1 = top image's backing file, etc.)
 372 #         before reaching one for which the range is allocated.  The value is
 373 #         in the range 0 to the depth of the image chain - 1.
 374 #
 375 # @zero: the sectors in this range read as zeros
 376 #
 377 # @data: reading the image will actually read data from a file (in particular,
 378 #        if @offset is present this means that the sectors are not simply
 379 #        preallocated, but contain actual data in raw format)
 380 #
 381 # @offset: if present, the image file stores the data for this range in
 382 #          raw format at the given offset.
 383 #
 384 # Since: 1.7
 385 ##
 386 { 'struct': 'BlockDeviceMapEntry',
 387   'data': { 'start': 'int', 'length': 'int', 'depth': 'int', 'zero': 'bool',
 388             'data': 'bool', '*offset': 'int' } }
 389
 390 ##
 391 # @DirtyBitmapStatus:
 392 #
 393 # An enumeration of possible states that a dirty bitmap can report to the user.
 394 #
 395 # @frozen: The bitmap is currently in-use by a backup operation or block job,
 396 #          and is immutable.
 397 #
 398 # @disabled: The bitmap is currently in-use by an internal operation and is
 399 #            read-only. It can still be deleted.
 400 #
 401 # @active: The bitmap is actively monitoring for new writes, and can be cleared,
 402 #          deleted, or used for backup operations.
 403 #
 404 # Since: 2.4
 405 ##
 406 { 'enum': 'DirtyBitmapStatus',
 407   'data': ['active', 'disabled', 'frozen'] }
 408
 409 ##
 410 # @BlockDirtyInfo:
 411 #
 412 # Block dirty bitmap information.
 413 #
 414 # @name: the name of the dirty bitmap (Since 2.4)
 415 #
 416 # @count: number of dirty bytes according to the dirty bitmap
 417 #
 418 # @granularity: granularity of the dirty bitmap in bytes (since 1.4)
 419 #
 420 # @status: current status of the dirty bitmap (since 2.4)
 421 #
 422 # Since: 1.3
 423 ##
 424 { 'struct': 'BlockDirtyInfo',
 425   'data': {'*name': 'str', 'count': 'int', 'granularity': 'uint32',
 426            'status': 'DirtyBitmapStatus'} }
 427
 428 ##
 429 # @BlockInfo:
 430 #
 431 # Block device information.  This structure describes a virtual device and
 432 # the backing device associated with it.
 433 #
 434 # @device: The device name associated with the virtual device.
 435 #
 436 # @type: This field is returned only for compatibility reasons, it should
 437 #        not be used (always returns 'unknown')
 438 #
 439 # @removable: True if the device supports removable media.
 440 #
 441 # @locked: True if the guest has locked this device from having its media
 442 #          removed
 443 #
 444 # @tray_open: True if the device's tray is open
 445 #             (only present if it has a tray)
 446 #
 447 # @dirty-bitmaps: dirty bitmaps information (only present if the
 448 #                 driver has one or more dirty bitmaps) (Since 2.0)
 449 #
 450 # @io-status: @BlockDeviceIoStatus. Only present if the device
 451 #             supports it and the VM is configured to stop on errors
 452 #             (supported device models: virtio-blk, ide, scsi-disk)
 453 #
 454 # @inserted: @BlockDeviceInfo describing the device if media is
 455 #            present
 456 #
 457 # Since:  0.14.0
 458 ##
 459 { 'struct': 'BlockInfo',
 460   'data': {'device': 'str', 'type': 'str', 'removable': 'bool',
 461            'locked': 'bool', '*inserted': 'BlockDeviceInfo',
 462            '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus',
 463            '*dirty-bitmaps': ['BlockDirtyInfo'] } }
 464
 465 ##
 466 # @query-block:
 467 #
 468 # Get a list of BlockInfo for all virtual block devices.
 469 #
 470 # Returns: a list of @BlockInfo describing each virtual block device
 471 #
 472 # Since: 0.14.0
 473 #
 474 # Example:
 475 #
 476 # -> { "execute": "query-block" }
 477 # <- {
 478 #       "return":[
 479 #          {
 480 #             "io-status": "ok",
 481 #             "device":"ide0-hd0",
 482 #             "locked":false,
 483 #             "removable":false,
 484 #             "inserted":{
 485 #                "ro":false,
 486 #                "drv":"qcow2",
 487 #                "encrypted":false,
 488 #                "file":"disks/test.qcow2",
 489 #                "backing_file_depth":1,
 490 #                "bps":1000000,
 491 #                "bps_rd":0,
 492 #                "bps_wr":0,
 493 #                "iops":1000000,
 494 #                "iops_rd":0,
 495 #                "iops_wr":0,
 496 #                "bps_max": 8000000,
 497 #                "bps_rd_max": 0,
 498 #                "bps_wr_max": 0,
 499 #                "iops_max": 0,
 500 #                "iops_rd_max": 0,
 501 #                "iops_wr_max": 0,
 502 #                "iops_size": 0,
 503 #                "detect_zeroes": "on",
 504 #                "write_threshold": 0,
 505 #                "image":{
 506 #                   "filename":"disks/test.qcow2",
 507 #                   "format":"qcow2",
 508 #                   "virtual-size":2048000,
 509 #                   "backing_file":"base.qcow2",
 510 #                   "full-backing-filename":"disks/base.qcow2",
 511 #                   "backing-filename-format":"qcow2",
 512 #                   "snapshots":[
 513 #                      {
 514 #                         "id": "1",
 515 #                         "name": "snapshot1",
 516 #                         "vm-state-size": 0,
 517 #                         "date-sec": 10000200,
 518 #                         "date-nsec": 12,
 519 #                         "vm-clock-sec": 206,
 520 #                         "vm-clock-nsec": 30
 521 #                      }
 522 #                   ],
 523 #                   "backing-image":{
 524 #                       "filename":"disks/base.qcow2",
 525 #                       "format":"qcow2",
 526 #                       "virtual-size":2048000
 527 #                   }
 528 #                }
 529 #             },
 530 #             "type":"unknown"
 531 #          },
 532 #          {
 533 #             "io-status": "ok",
 534 #             "device":"ide1-cd0",
 535 #             "locked":false,
 536 #             "removable":true,
 537 #             "type":"unknown"
 538 #          },
 539 #          {
 540 #             "device":"floppy0",
 541 #             "locked":false,
 542 #             "removable":true,
 543 #             "type":"unknown"
 544 #          },
 545 #          {
 546 #             "device":"sd0",
 547 #             "locked":false,
 548 #             "removable":true,
 549 #             "type":"unknown"
 550 #          }
 551 #       ]
 552 #    }
 553 #
 554 ##
 555 { 'command': 'query-block', 'returns': ['BlockInfo'] }
 556
 557
 558 ##
 559 # @BlockDeviceTimedStats:
 560 #
 561 # Statistics of a block device during a given interval of time.
 562 #
 563 # @interval_length: Interval used for calculating the statistics,
 564 #                   in seconds.
 565 #
 566 # @min_rd_latency_ns: Minimum latency of read operations in the
 567 #                     defined interval, in nanoseconds.
 568 #
 569 # @min_wr_latency_ns: Minimum latency of write operations in the
 570 #                     defined interval, in nanoseconds.
 571 #
 572 # @min_flush_latency_ns: Minimum latency of flush operations in the
 573 #                        defined interval, in nanoseconds.
 574 #
 575 # @max_rd_latency_ns: Maximum latency of read operations in the
 576 #                     defined interval, in nanoseconds.
 577 #
 578 # @max_wr_latency_ns: Maximum latency of write operations in the
 579 #                     defined interval, in nanoseconds.
 580 #
 581 # @max_flush_latency_ns: Maximum latency of flush operations in the
 582 #                        defined interval, in nanoseconds.
 583 #
 584 # @avg_rd_latency_ns: Average latency of read operations in the
 585 #                     defined interval, in nanoseconds.
 586 #
 587 # @avg_wr_latency_ns: Average latency of write operations in the
 588 #                     defined interval, in nanoseconds.
 589 #
 590 # @avg_flush_latency_ns: Average latency of flush operations in the
 591 #                        defined interval, in nanoseconds.
 592 #
 593 # @avg_rd_queue_depth: Average number of pending read operations
 594 #                      in the defined interval.
 595 #
 596 # @avg_wr_queue_depth: Average number of pending write operations
 597 #                      in the defined interval.
 598 #
 599 # Since: 2.5
 600 ##
 601 { 'struct': 'BlockDeviceTimedStats',
 602   'data': { 'interval_length': 'int', 'min_rd_latency_ns': 'int',
 603             'max_rd_latency_ns': 'int', 'avg_rd_latency_ns': 'int',
 604             'min_wr_latency_ns': 'int', 'max_wr_latency_ns': 'int',
 605             'avg_wr_latency_ns': 'int', 'min_flush_latency_ns': 'int',
 606             'max_flush_latency_ns': 'int', 'avg_flush_latency_ns': 'int',
 607             'avg_rd_queue_depth': 'number', 'avg_wr_queue_depth': 'number' } }
 608
 609 ##
 610 # @BlockDeviceStats:
 611 #
 612 # Statistics of a virtual block device or a block backing device.
 613 #
 614 # @rd_bytes:      The number of bytes read by the device.
 615 #
 616 # @wr_bytes:      The number of bytes written by the device.
 617 #
 618 # @rd_operations: The number of read operations performed by the device.
 619 #
 620 # @wr_operations: The number of write operations performed by the device.
 621 #
 622 # @flush_operations: The number of cache flush operations performed by the
 623 #                    device (since 0.15.0)
 624 #
 625 # @flush_total_time_ns: Total time spend on cache flushes in nano-seconds
 626 #                       (since 0.15.0).
 627 #
 628 # @wr_total_time_ns: Total time spend on writes in nano-seconds (since 0.15.0).
 629 #
 630 # @rd_total_time_ns: Total_time_spend on reads in nano-seconds (since 0.15.0).
 631 #
 632 # @wr_highest_offset: The offset after the greatest byte written to the
 633 #                     device.  The intended use of this information is for
 634 #                     growable sparse files (like qcow2) that are used on top
 635 #                     of a physical device.
 636 #
 637 # @rd_merged: Number of read requests that have been merged into another
 638 #             request (Since 2.3).
 639 #
 640 # @wr_merged: Number of write requests that have been merged into another
 641 #             request (Since 2.3).
 642 #
 643 # @idle_time_ns: Time since the last I/O operation, in
 644 #                nanoseconds. If the field is absent it means that
 645 #                there haven't been any operations yet (Since 2.5).
 646 #
 647 # @failed_rd_operations: The number of failed read operations
 648 #                        performed by the device (Since 2.5)
 649 #
 650 # @failed_wr_operations: The number of failed write operations
 651 #                        performed by the device (Since 2.5)
 652 #
 653 # @failed_flush_operations: The number of failed flush operations
 654 #                           performed by the device (Since 2.5)
 655 #
 656 # @invalid_rd_operations: The number of invalid read operations
 657 #                          performed by the device (Since 2.5)
 658 #
 659 # @invalid_wr_operations: The number of invalid write operations
 660 #                         performed by the device (Since 2.5)
 661 #
 662 # @invalid_flush_operations: The number of invalid flush operations
 663 #                            performed by the device (Since 2.5)
 664 #
 665 # @account_invalid: Whether invalid operations are included in the
 666 #                   last access statistics (Since 2.5)
 667 #
 668 # @account_failed: Whether failed operations are included in the
 669 #                  latency and last access statistics (Since 2.5)
 670 #
 671 # @timed_stats: Statistics specific to the set of previously defined
 672 #               intervals of time (Since 2.5)
 673 #
 674 # Since: 0.14.0
 675 ##
 676 { 'struct': 'BlockDeviceStats',
 677   'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'rd_operations': 'int',
 678            'wr_operations': 'int', 'flush_operations': 'int',
 679            'flush_total_time_ns': 'int', 'wr_total_time_ns': 'int',
 680            'rd_total_time_ns': 'int', 'wr_highest_offset': 'int',
 681            'rd_merged': 'int', 'wr_merged': 'int', '*idle_time_ns': 'int',
 682            'failed_rd_operations': 'int', 'failed_wr_operations': 'int',
 683            'failed_flush_operations': 'int', 'invalid_rd_operations': 'int',
 684            'invalid_wr_operations': 'int', 'invalid_flush_operations': 'int',
 685            'account_invalid': 'bool', 'account_failed': 'bool',
 686            'timed_stats': ['BlockDeviceTimedStats'] } }
 687
 688 ##
 689 # @BlockStats:
 690 #
 691 # Statistics of a virtual block device or a block backing device.
 692 #
 693 # @device: If the stats are for a virtual block device, the name
 694 #          corresponding to the virtual block device.
 695 #
 696 # @node-name: The node name of the device. (Since 2.3)
 697 #
 698 # @stats:  A @BlockDeviceStats for the device.
 699 #
 700 # @parent: This describes the file block device if it has one.
 701 #          Contains recursively the statistics of the underlying
 702 #          protocol (e.g. the host file for a qcow2 image). If there is
 703 #          no underlying protocol, this field is omitted
 704 #
 705 # @backing: This describes the backing block device if it has one.
 706 #           (Since 2.0)
 707 #
 708 # Since: 0.14.0
 709 ##
 710 { 'struct': 'BlockStats',
 711   'data': {'*device': 'str', '*node-name': 'str',
 712            'stats': 'BlockDeviceStats',
 713            '*parent': 'BlockStats',
 714            '*backing': 'BlockStats'} }
 715
 716 ##
 717 # @query-blockstats:
 718 #
 719 # Query the @BlockStats for all virtual block devices.
 720 #
 721 # @query-nodes: If true, the command will query all the block nodes
 722 #               that have a node name, in a list which will include "parent"
 723 #               information, but not "backing".
 724 #               If false or omitted, the behavior is as before - query all the
 725 #               device backends, recursively including their "parent" and
 726 #               "backing". (Since 2.3)
 727 #
 728 # Returns: A list of @BlockStats for each virtual block devices.
 729 #
 730 # Since: 0.14.0
 731 #
 732 # Example:
 733 #
 734 # -> { "execute": "query-blockstats" }
 735 # <- {
 736 #       "return":[
 737 #          {
 738 #             "device":"ide0-hd0",
 739 #             "parent":{
 740 #                "stats":{
 741 #                   "wr_highest_offset":3686448128,
 742 #                   "wr_bytes":9786368,
 743 #                   "wr_operations":751,
 744 #                   "rd_bytes":122567168,
 745 #                   "rd_operations":36772
 746 #                   "wr_total_times_ns":313253456
 747 #                   "rd_total_times_ns":3465673657
 748 #                   "flush_total_times_ns":49653
 749 #                   "flush_operations":61,
 750 #                   "rd_merged":0,
 751 #                   "wr_merged":0,
 752 #                   "idle_time_ns":2953431879,
 753 #                   "account_invalid":true,
 754 #                   "account_failed":false
 755 #                }
 756 #             },
 757 #             "stats":{
 758 #                "wr_highest_offset":2821110784,
 759 #                "wr_bytes":9786368,
 760 #                "wr_operations":692,
 761 #                "rd_bytes":122739200,
 762 #                "rd_operations":36604
 763 #                "flush_operations":51,
 764 #                "wr_total_times_ns":313253456
 765 #                "rd_total_times_ns":3465673657
 766 #                "flush_total_times_ns":49653,
 767 #                "rd_merged":0,
 768 #                "wr_merged":0,
 769 #                "idle_time_ns":2953431879,
 770 #                "account_invalid":true,
 771 #                "account_failed":false
 772 #             }
 773 #          },
 774 #          {
 775 #             "device":"ide1-cd0",
 776 #             "stats":{
 777 #                "wr_highest_offset":0,
 778 #                "wr_bytes":0,
 779 #                "wr_operations":0,
 780 #                "rd_bytes":0,
 781 #                "rd_operations":0
 782 #                "flush_operations":0,
 783 #                "wr_total_times_ns":0
 784 #                "rd_total_times_ns":0
 785 #                "flush_total_times_ns":0,
 786 #                "rd_merged":0,
 787 #                "wr_merged":0,
 788 #                "account_invalid":false,
 789 #                "account_failed":false
 790 #             }
 791 #          },
 792 #          {
 793 #             "device":"floppy0",
 794 #             "stats":{
 795 #                "wr_highest_offset":0,
 796 #                "wr_bytes":0,
 797 #                "wr_operations":0,
 798 #                "rd_bytes":0,
 799 #                "rd_operations":0
 800 #                "flush_operations":0,
 801 #                "wr_total_times_ns":0
 802 #                "rd_total_times_ns":0
 803 #                "flush_total_times_ns":0,
 804 #                "rd_merged":0,
 805 #                "wr_merged":0,
 806 #                "account_invalid":false,
 807 #                "account_failed":false
 808 #             }
 809 #          },
 810 #          {
 811 #             "device":"sd0",
 812 #             "stats":{
 813 #                "wr_highest_offset":0,
 814 #                "wr_bytes":0,
 815 #                "wr_operations":0,
 816 #                "rd_bytes":0,
 817 #                "rd_operations":0
 818 #                "flush_operations":0,
 819 #                "wr_total_times_ns":0
 820 #                "rd_total_times_ns":0
 821 #                "flush_total_times_ns":0,
 822 #                "rd_merged":0,
 823 #                "wr_merged":0,
 824 #                "account_invalid":false,
 825 #                "account_failed":false
 826 #             }
 827 #          }
 828 #       ]
 829 #    }
 830 #
 831 ##
 832 { 'command': 'query-blockstats',
 833   'data': { '*query-nodes': 'bool' },
 834   'returns': ['BlockStats'] }
 835
 836 ##
 837 # @BlockdevOnError:
 838 #
 839 # An enumeration of possible behaviors for errors on I/O operations.
 840 # The exact meaning depends on whether the I/O was initiated by a guest
 841 # or by a block job
 842 #
 843 # @report: for guest operations, report the error to the guest;
 844 #          for jobs, cancel the job
 845 #
 846 # @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR
 847 #          or BLOCK_JOB_ERROR)
 848 #
 849 # @enospc: same as @stop on ENOSPC, same as @report otherwise.
 850 #
 851 # @stop: for guest operations, stop the virtual machine;
 852 #        for jobs, pause the job
 853 #
 854 # @auto: inherit the error handling policy of the backend (since: 2.7)
 855 #
 856 # Since: 1.3
 857 ##
 858 { 'enum': 'BlockdevOnError',
 859   'data': ['report', 'ignore', 'enospc', 'stop', 'auto'] }
 860
 861 ##
 862 # @MirrorSyncMode:
 863 #
 864 # An enumeration of possible behaviors for the initial synchronization
 865 # phase of storage mirroring.
 866 #
 867 # @top: copies data in the topmost image to the destination
 868 #
 869 # @full: copies data from all images to the destination
 870 #
 871 # @none: only copy data written from now on
 872 #
 873 # @incremental: only copy data described by the dirty bitmap. Since: 2.4
 874 #
 875 # Since: 1.3
 876 ##
 877 { 'enum': 'MirrorSyncMode',
 878   'data': ['top', 'full', 'none', 'incremental'] }
 879
 880 ##
 881 # @BlockJobType:
 882 #
 883 # Type of a block job.
 884 #
 885 # @commit: block commit job type, see "block-commit"
 886 #
 887 # @stream: block stream job type, see "block-stream"
 888 #
 889 # @mirror: drive mirror job type, see "drive-mirror"
 890 #
 891 # @backup: drive backup job type, see "drive-backup"
 892 #
 893 # Since: 1.7
 894 ##
 895 { 'enum': 'BlockJobType',
 896   'data': ['commit', 'stream', 'mirror', 'backup'] }
 897
 898 ##
 899 # @BlockJobInfo:
 900 #
 901 # Information about a long-running block device operation.
 902 #
 903 # @type: the job type ('stream' for image streaming)
 904 #
 905 # @device: The job identifier. Originally the device name but other
 906 #          values are allowed since QEMU 2.7
 907 #
 908 # @len: the maximum progress value
 909 #
 910 # @busy: false if the job is known to be in a quiescent state, with
 911 #        no pending I/O.  Since 1.3.
 912 #
 913 # @paused: whether the job is paused or, if @busy is true, will
 914 #          pause itself as soon as possible.  Since 1.3.
 915 #
 916 # @offset: the current progress value
 917 #
 918 # @speed: the rate limit, bytes per second
 919 #
 920 # @io-status: the status of the job (since 1.3)
 921 #
 922 # @ready: true if the job may be completed (since 2.2)
 923 #
 924 # Since: 1.1
 925 ##
 926 { 'struct': 'BlockJobInfo',
 927   'data': {'type': 'str', 'device': 'str', 'len': 'int',
 928            'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int',
 929            'io-status': 'BlockDeviceIoStatus', 'ready': 'bool'} }
 930
 931 ##
 932 # @query-block-jobs:
 933 #
 934 # Return information about long-running block device operations.
 935 #
 936 # Returns: a list of @BlockJobInfo for each active block job
 937 #
 938 # Since: 1.1
 939 ##
 940 { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'] }
 941
 942 ##
 943 # @block_passwd:
 944 #
 945 # This command sets the password of a block device that has not been open
 946 # with a password and requires one.
 947 #
 948 # The two cases where this can happen are a block device is created through
 949 # QEMU's initial command line or a block device is changed through the legacy
 950 # @change interface.
 951 #
 952 # In the event that the block device is created through the initial command
 953 # line, the VM will start in the stopped state regardless of whether '-S' is
 954 # used.  The intention is for a management tool to query the block devices to
 955 # determine which ones are encrypted, set the passwords with this command, and
 956 # then start the guest with the @cont command.
 957 #
 958 # Either @device or @node-name must be set but not both.
 959 #
 960 # @device: the name of the block backend device to set the password on
 961 #
 962 # @node-name: graph node name to set the password on (Since 2.0)
 963 #
 964 # @password: the password to use for the device
 965 #
 966 # Returns: nothing on success
 967 #          If @device is not a valid block device, DeviceNotFound
 968 #          If @device is not encrypted, DeviceNotEncrypted
 969 #
 970 # Notes:  Not all block formats support encryption and some that do are not
 971 #         able to validate that a password is correct.  Disk corruption may
 972 #         occur if an invalid password is specified.
 973 #
 974 # Since: 0.14.0
 975 #
 976 # Example:
 977 #
 978 # -> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
 979 #                                                "password": "12345" } }
 980 # <- { "return": {} }
 981 #
 982 ##
 983 { 'command': 'block_passwd', 'data': {'*device': 'str',
 984                                       '*node-name': 'str', 'password': 'str'} }
 985
 986 ##
 987 # @block_resize:
 988 #
 989 # Resize a block image while a guest is running.
 990 #
 991 # Either @device or @node-name must be set but not both.
 992 #
 993 # @device: the name of the device to get the image resized
 994 #
 995 # @node-name: graph node name to get the image resized (Since 2.0)
 996 #
 997 # @size:  new image size in bytes
 998 #
 999 # Returns: nothing on success
1000 #          If @device is not a valid block device, DeviceNotFound
1001 #
1002 # Since: 0.14.0
1003 #
1004 # Example:
1005 #
1006 # -> { "execute": "block_resize",
1007 #      "arguments": { "device": "scratch", "size": 1073741824 } }
1008 # <- { "return": {} }
1009 #
1010 ##
1011 { 'command': 'block_resize', 'data': { '*device': 'str',
1012                                        '*node-name': 'str',
1013                                        'size': 'int' }}
1014
1015 ##
1016 # @NewImageMode:
1017 #
1018 # An enumeration that tells QEMU how to set the backing file path in
1019 # a new image file.
1020 #
1021 # @existing: QEMU should look for an existing image file.
1022 #
1023 # @absolute-paths: QEMU should create a new image with absolute paths
1024 # for the backing file. If there is no backing file available, the new
1025 # image will not be backed either.
1026 #
1027 # Since: 1.1
1028 ##
1029 { 'enum': 'NewImageMode',
1030   'data': [ 'existing', 'absolute-paths' ] }
1031
1032 ##
1033 # @BlockdevSnapshotSync:
1034 #
1035 # Either @device or @node-name must be set but not both.
1036 #
1037 # @device: the name of the device to generate the snapshot from.
1038 #
1039 # @node-name: graph node name to generate the snapshot from (Since 2.0)
1040 #
1041 # @snapshot-file: the target of the new image. If the file exists, or
1042 # if it is a device, the snapshot will be created in the existing
1043 # file/device. Otherwise, a new file will be created.
1044 #
1045 # @snapshot-node-name: the graph node name of the new image (Since 2.0)
1046 #
1047 # @format: the format of the snapshot image, default is 'qcow2'.
1048 #
1049 # @mode: whether and how QEMU should create a new image, default is
1050 #        'absolute-paths'.
1051 ##
1052 { 'struct': 'BlockdevSnapshotSync',
1053   'data': { '*device': 'str', '*node-name': 'str',
1054             'snapshot-file': 'str', '*snapshot-node-name': 'str',
1055             '*format': 'str', '*mode': 'NewImageMode' } }
1056
1057 ##
1058 # @BlockdevSnapshot:
1059 #
1060 # @node: device or node name that will have a snapshot created.
1061 #
1062 # @overlay: reference to the existing block device that will become
1063 #           the overlay of @node, as part of creating the snapshot.
1064 #           It must not have a current backing file (this can be
1065 #           achieved by passing "backing": "" to blockdev-add).
1066 #
1067 # Since: 2.5
1068 ##
1069 { 'struct': 'BlockdevSnapshot',
1070   'data': { 'node': 'str', 'overlay': 'str' } }
1071
1072 ##
1073 # @DriveBackup:
1074 #
1075 # @job-id: identifier for the newly-created block job. If
1076 #          omitted, the device name will be used. (Since 2.7)
1077 #
1078 # @device: the device name or node-name of a root node which should be copied.
1079 #
1080 # @target: the target of the new image. If the file exists, or if it
1081 #          is a device, the existing file/device will be used as the new
1082 #          destination.  If it does not exist, a new file will be created.
1083 #
1084 # @format: the format of the new destination, default is to
1085 #          probe if @mode is 'existing', else the format of the source
1086 #
1087 # @sync: what parts of the disk image should be copied to the destination
1088 #        (all the disk, only the sectors allocated in the topmost image, from a
1089 #        dirty bitmap, or only new I/O).
1090 #
1091 # @mode: whether and how QEMU should create a new image, default is
1092 #        'absolute-paths'.
1093 #
1094 # @speed: the maximum speed, in bytes per second
1095 #
1096 # @bitmap: the name of dirty bitmap if sync is "incremental".
1097 #          Must be present if sync is "incremental", must NOT be present
1098 #          otherwise. (Since 2.4)
1099 #
1100 # @compress: true to compress data, if the target format supports it.
1101 #            (default: false) (since 2.8)
1102 #
1103 # @on-source-error: the action to take on an error on the source,
1104 #                   default 'report'.  'stop' and 'enospc' can only be used
1105 #                   if the block device supports io-status (see BlockInfo).
1106 #
1107 # @on-target-error: the action to take on an error on the target,
1108 #                   default 'report' (no limitations, since this applies to
1109 #                   a different block device than @device).
1110 #
1111 # Note: @on-source-error and @on-target-error only affect background
1112 # I/O.  If an error occurs during a guest write request, the device's
1113 # rerror/werror actions will be used.
1114 #
1115 # Since: 1.6
1116 ##
1117 { 'struct': 'DriveBackup',
1118   'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
1119             '*format': 'str', 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
1120             '*speed': 'int', '*bitmap': 'str', '*compress': 'bool',
1121             '*on-source-error': 'BlockdevOnError',
1122             '*on-target-error': 'BlockdevOnError' } }
1123
1124 ##
1125 # @BlockdevBackup:
1126 #
1127 # @job-id: identifier for the newly-created block job. If
1128 #          omitted, the device name will be used. (Since 2.7)
1129 #
1130 # @device: the device name or node-name of a root node which should be copied.
1131 #
1132 # @target: the device name or node-name of the backup target node.
1133 #
1134 # @sync: what parts of the disk image should be copied to the destination
1135 #        (all the disk, only the sectors allocated in the topmost image, or
1136 #        only new I/O).
1137 #
1138 # @speed: the maximum speed, in bytes per second. The default is 0,
1139 #         for unlimited.
1140 #
1141 # @compress: true to compress data, if the target format supports it.
1142 #            (default: false) (since 2.8)
1143 #
1144 # @on-source-error: the action to take on an error on the source,
1145 #                   default 'report'.  'stop' and 'enospc' can only be used
1146 #                   if the block device supports io-status (see BlockInfo).
1147 #
1148 # @on-target-error: the action to take on an error on the target,
1149 #                   default 'report' (no limitations, since this applies to
1150 #                   a different block device than @device).
1151 #
1152 # Note: @on-source-error and @on-target-error only affect background
1153 # I/O.  If an error occurs during a guest write request, the device's
1154 # rerror/werror actions will be used.
1155 #
1156 # Since: 2.3
1157 ##
1158 { 'struct': 'BlockdevBackup',
1159   'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
1160             'sync': 'MirrorSyncMode',
1161             '*speed': 'int',
1162             '*compress': 'bool',
1163             '*on-source-error': 'BlockdevOnError',
1164             '*on-target-error': 'BlockdevOnError' } }
1165
1166 ##
1167 # @blockdev-snapshot-sync:
1168 #
1169 # Generates a synchronous snapshot of a block device.
1170 #
1171 # For the arguments, see the documentation of BlockdevSnapshotSync.
1172 #
1173 # Returns: nothing on success
1174 #          If @device is not a valid block device, DeviceNotFound
1175 #
1176 # Since: 0.14.0
1177 #
1178 # Example:
1179 #
1180 # -> { "execute": "blockdev-snapshot-sync",
1181 #      "arguments": { "device": "ide-hd0",
1182 #                     "snapshot-file":
1183 #                     "/some/place/my-image",
1184 #                     "format": "qcow2" } }
1185 # <- { "return": {} }
1186 #
1187 ##
1188 { 'command': 'blockdev-snapshot-sync',
1189   'data': 'BlockdevSnapshotSync' }
1190
1191
1192 ##
1193 # @blockdev-snapshot:
1194 #
1195 # Generates a snapshot of a block device.
1196 #
1197 # Create a snapshot, by installing 'node' as the backing image of
1198 # 'overlay'. Additionally, if 'node' is associated with a block
1199 # device, the block device changes to using 'overlay' as its new active
1200 # image.
1201 #
1202 # For the arguments, see the documentation of BlockdevSnapshot.
1203 #
1204 # Since: 2.5
1205 #
1206 # Example:
1207 #
1208 # -> { "execute": "blockdev-add",
1209 #      "arguments": { "options": { "driver": "qcow2",
1210 #                                  "node-name": "node1534",
1211 #                                  "file": { "driver": "file",
1212 #                                            "filename": "hd1.qcow2" },
1213 #                                  "backing": "" } } }
1214 #
1215 # <- { "return": {} }
1216 #
1217 # -> { "execute": "blockdev-snapshot",
1218 #      "arguments": { "node": "ide-hd0",
1219 #                     "overlay": "node1534" } }
1220 # <- { "return": {} }
1221 #
1222 ##
1223 { 'command': 'blockdev-snapshot',
1224   'data': 'BlockdevSnapshot' }
1225
1226 ##
1227 # @change-backing-file:
1228 #
1229 # Change the backing file in the image file metadata.  This does not
1230 # cause QEMU to reopen the image file to reparse the backing filename
1231 # (it may, however, perform a reopen to change permissions from
1232 # r/o -> r/w -> r/o, if needed). The new backing file string is written
1233 # into the image file metadata, and the QEMU internal strings are
1234 # updated.
1235 #
1236 # @image-node-name: The name of the block driver state node of the
1237 #                   image to modify. The "device" argument is used
1238 #                   to verify "image-node-name" is in the chain
1239 #                   described by "device".
1240 #
1241 # @device:          The device name or node-name of the root node that owns
1242 #                   image-node-name.
1243 #
1244 # @backing-file:    The string to write as the backing file.  This
1245 #                   string is not validated, so care should be taken
1246 #                   when specifying the string or the image chain may
1247 #                   not be able to be reopened again.
1248 #
1249 # Returns: Nothing on success
1250 #
1251 #          If "device" does not exist or cannot be determined, DeviceNotFound
1252 #
1253 # Since: 2.1
1254 ##
1255 { 'command': 'change-backing-file',
1256   'data': { 'device': 'str', 'image-node-name': 'str',
1257             'backing-file': 'str' } }
1258
1259 ##
1260 # @block-commit:
1261 #
1262 # Live commit of data from overlay image nodes into backing nodes - i.e.,
1263 # writes data between 'top' and 'base' into 'base'.
1264 #
1265 # @job-id: identifier for the newly-created block job. If
1266 #          omitted, the device name will be used. (Since 2.7)
1267 #
1268 # @device:  the device name or node-name of a root node
1269 #
1270 # @base:   The file name of the backing image to write data into.
1271 #                    If not specified, this is the deepest backing image.
1272 #
1273 # @top:    The file name of the backing image within the image chain,
1274 #                    which contains the topmost data to be committed down. If
1275 #                    not specified, this is the active layer.
1276 #
1277 # @backing-file:  The backing file string to write into the overlay
1278 #                           image of 'top'.  If 'top' is the active layer,
1279 #                           specifying a backing file string is an error. This
1280 #                           filename is not validated.
1281 #
1282 #                           If a pathname string is such that it cannot be
1283 #                           resolved by QEMU, that means that subsequent QMP or
1284 #                           HMP commands must use node-names for the image in
1285 #                           question, as filename lookup methods will fail.
1286 #
1287 #                           If not specified, QEMU will automatically determine
1288 #                           the backing file string to use, or error out if
1289 #                           there is no obvious choice. Care should be taken
1290 #                           when specifying the string, to specify a valid
1291 #                           filename or protocol.
1292 #                           (Since 2.1)
1293 #
1294 #                    If top == base, that is an error.
1295 #                    If top == active, the job will not be completed by itself,
1296 #                    user needs to complete the job with the block-job-complete
1297 #                    command after getting the ready event. (Since 2.0)
1298 #
1299 #                    If the base image is smaller than top, then the base image
1300 #                    will be resized to be the same size as top.  If top is
1301 #                    smaller than the base image, the base will not be
1302 #                    truncated.  If you want the base image size to match the
1303 #                    size of the smaller top, you can safely truncate it
1304 #                    yourself once the commit operation successfully completes.
1305 #
1306 # @speed:  the maximum speed, in bytes per second
1307 #
1308 # @filter-node-name: the node name that should be assigned to the
1309 #                    filter driver that the commit job inserts into the graph
1310 #                    above @top. If this option is not given, a node name is
1311 #                    autogenerated. (Since: 2.9)
1312 #
1313 # Returns: Nothing on success
1314 #          If commit or stream is already active on this device, DeviceInUse
1315 #          If @device does not exist, DeviceNotFound
1316 #          If image commit is not supported by this device, NotSupported
1317 #          If @base or @top is invalid, a generic error is returned
1318 #          If @speed is invalid, InvalidParameter
1319 #
1320 # Since: 1.3
1321 #
1322 # Example:
1323 #
1324 # -> { "execute": "block-commit",
1325 #      "arguments": { "device": "virtio0",
1326 #                     "top": "/tmp/snap1.qcow2" } }
1327 # <- { "return": {} }
1328 #
1329 ##
1330 { 'command': 'block-commit',
1331   'data': { '*job-id': 'str', 'device': 'str', '*base': 'str', '*top': 'str',
1332             '*backing-file': 'str', '*speed': 'int',
1333             '*filter-node-name': 'str' } }
1334
1335 ##
1336 # @drive-backup:
1337 #
1338 # Start a point-in-time copy of a block device to a new destination.  The
1339 # status of ongoing drive-backup operations can be checked with
1340 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1341 # The operation can be stopped before it has completed using the
1342 # block-job-cancel command.
1343 #
1344 # Returns: nothing on success
1345 #          If @device is not a valid block device, GenericError
1346 #
1347 # Since: 1.6
1348 #
1349 # Example:
1350 #
1351 # -> { "execute": "drive-backup",
1352 #      "arguments": { "device": "drive0",
1353 #                     "sync": "full",
1354 #                     "target": "backup.img" } }
1355 # <- { "return": {} }
1356 #
1357 ##
1358 { 'command': 'drive-backup', 'boxed': true,
1359   'data': 'DriveBackup' }
1360
1361 ##
1362 # @blockdev-backup:
1363 #
1364 # Start a point-in-time copy of a block device to a new destination.  The
1365 # status of ongoing blockdev-backup operations can be checked with
1366 # query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
1367 # The operation can be stopped before it has completed using the
1368 # block-job-cancel command.
1369 #
1370 # Returns: nothing on success
1371 #          If @device is not a valid block device, DeviceNotFound
1372 #
1373 # Since: 2.3
1374 #
1375 # Example:
1376 # -> { "execute": "blockdev-backup",
1377 #      "arguments": { "device": "src-id",
1378 #                     "sync": "full",
1379 #                     "target": "tgt-id" } }
1380 # <- { "return": {} }
1381 #
1382 ##
1383 { 'command': 'blockdev-backup', 'boxed': true,
1384   'data': 'BlockdevBackup' }
1385
1386
1387 ##
1388 # @query-named-block-nodes:
1389 #
1390 # Get the named block driver list
1391 #
1392 # Returns: the list of BlockDeviceInfo
1393 #
1394 # Since: 2.0
1395 #
1396 # Example:
1397 #
1398 # -> { "execute": "query-named-block-nodes" }
1399 # <- { "return": [ { "ro":false,
1400 #                    "drv":"qcow2",
1401 #                    "encrypted":false,
1402 #                    "file":"disks/test.qcow2",
1403 #                    "node-name": "my-node",
1404 #                    "backing_file_depth":1,
1405 #                    "bps":1000000,
1406 #                    "bps_rd":0,
1407 #                    "bps_wr":0,
1408 #                    "iops":1000000,
1409 #                    "iops_rd":0,
1410 #                    "iops_wr":0,
1411 #                    "bps_max": 8000000,
1412 #                    "bps_rd_max": 0,
1413 #                    "bps_wr_max": 0,
1414 #                    "iops_max": 0,
1415 #                    "iops_rd_max": 0,
1416 #                    "iops_wr_max": 0,
1417 #                    "iops_size": 0,
1418 #                    "write_threshold": 0,
1419 #                    "image":{
1420 #                       "filename":"disks/test.qcow2",
1421 #                       "format":"qcow2",
1422 #                       "virtual-size":2048000,
1423 #                       "backing_file":"base.qcow2",
1424 #                       "full-backing-filename":"disks/base.qcow2",
1425 #                       "backing-filename-format":"qcow2",
1426 #                       "snapshots":[
1427 #                          {
1428 #                             "id": "1",
1429 #                             "name": "snapshot1",
1430 #                             "vm-state-size": 0,
1431 #                             "date-sec": 10000200,
1432 #                             "date-nsec": 12,
1433 #                             "vm-clock-sec": 206,
1434 #                             "vm-clock-nsec": 30
1435 #                          }
1436 #                       ],
1437 #                       "backing-image":{
1438 #                           "filename":"disks/base.qcow2",
1439 #                           "format":"qcow2",
1440 #                           "virtual-size":2048000
1441 #                       }
1442 #                    } } ] }
1443 #
1444 ##
1445 { 'command': 'query-named-block-nodes', 'returns': [ 'BlockDeviceInfo' ] }
1446
1447 ##
1448 # @drive-mirror:
1449 #
1450 # Start mirroring a block device's writes to a new destination. target
1451 # specifies the target of the new image. If the file exists, or if it
1452 # is a device, it will be used as the new destination for writes. If
1453 # it does not exist, a new file will be created. format specifies the
1454 # format of the mirror image, default is to probe if mode='existing',
1455 # else the format of the source.
1456 #
1457 # Returns: nothing on success
1458 #          If @device is not a valid block device, GenericError
1459 #
1460 # Since: 1.3
1461 #
1462 # Example:
1463 #
1464 # -> { "execute": "drive-mirror",
1465 #      "arguments": { "device": "ide-hd0",
1466 #                     "target": "/some/place/my-image",
1467 #                     "sync": "full",
1468 #                     "format": "qcow2" } }
1469 # <- { "return": {} }
1470 #
1471 ##
1472 { 'command': 'drive-mirror', 'boxed': true,
1473   'data': 'DriveMirror' }
1474
1475 ##
1476 # @DriveMirror:
1477 #
1478 # A set of parameters describing drive mirror setup.
1479 #
1480 # @job-id: identifier for the newly-created block job. If
1481 #          omitted, the device name will be used. (Since 2.7)
1482 #
1483 # @device:  the device name or node-name of a root node whose writes should be
1484 #           mirrored.
1485 #
1486 # @target: the target of the new image. If the file exists, or if it
1487 #          is a device, the existing file/device will be used as the new
1488 #          destination.  If it does not exist, a new file will be created.
1489 #
1490 # @format: the format of the new destination, default is to
1491 #          probe if @mode is 'existing', else the format of the source
1492 #
1493 # @node-name: the new block driver state node name in the graph
1494 #             (Since 2.1)
1495 #
1496 # @replaces: with sync=full graph node name to be replaced by the new
1497 #            image when a whole image copy is done. This can be used to repair
1498 #            broken Quorum files. (Since 2.1)
1499 #
1500 # @mode: whether and how QEMU should create a new image, default is
1501 #        'absolute-paths'.
1502 #
1503 # @speed:  the maximum speed, in bytes per second
1504 #
1505 # @sync: what parts of the disk image should be copied to the destination
1506 #        (all the disk, only the sectors allocated in the topmost image, or
1507 #        only new I/O).
1508 #
1509 # @granularity: granularity of the dirty bitmap, default is 64K
1510 #               if the image format doesn't have clusters, 4K if the clusters
1511 #               are smaller than that, else the cluster size.  Must be a
1512 #               power of 2 between 512 and 64M (since 1.4).
1513 #
1514 # @buf-size: maximum amount of data in flight from source to
1515 #            target (since 1.4).
1516 #
1517 # @on-source-error: the action to take on an error on the source,
1518 #                   default 'report'.  'stop' and 'enospc' can only be used
1519 #                   if the block device supports io-status (see BlockInfo).
1520 #
1521 # @on-target-error: the action to take on an error on the target,
1522 #                   default 'report' (no limitations, since this applies to
1523 #                   a different block device than @device).
1524 # @unmap: Whether to try to unmap target sectors where source has
1525 #         only zero. If true, and target unallocated sectors will read as zero,
1526 #         target image sectors will be unmapped; otherwise, zeroes will be
1527 #         written. Both will result in identical contents.
1528 #         Default is true. (Since 2.4)
1529 #
1530 # Since: 1.3
1531 ##
1532 { 'struct': 'DriveMirror',
1533   'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
1534             '*format': 'str', '*node-name': 'str', '*replaces': 'str',
1535             'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
1536             '*speed': 'int', '*granularity': 'uint32',
1537             '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
1538             '*on-target-error': 'BlockdevOnError',
1539             '*unmap': 'bool' } }
1540
1541 ##
1542 # @BlockDirtyBitmap:
1543 #
1544 # @node: name of device/node which the bitmap is tracking
1545 #
1546 # @name: name of the dirty bitmap
1547 #
1548 # Since: 2.4
1549 ##
1550 { 'struct': 'BlockDirtyBitmap',
1551   'data': { 'node': 'str', 'name': 'str' } }
1552
1553 ##
1554 # @BlockDirtyBitmapAdd:
1555 #
1556 # @node: name of device/node which the bitmap is tracking
1557 #
1558 # @name: name of the dirty bitmap
1559 #
1560 # @granularity: the bitmap granularity, default is 64k for
1561 #               block-dirty-bitmap-add
1562 #
1563 # Since: 2.4
1564 ##
1565 { 'struct': 'BlockDirtyBitmapAdd',
1566   'data': { 'node': 'str', 'name': 'str', '*granularity': 'uint32' } }
1567
1568 ##
1569 # @block-dirty-bitmap-add:
1570 #
1571 # Create a dirty bitmap with a name on the node, and start tracking the writes.
1572 #
1573 # Returns: nothing on success
1574 #          If @node is not a valid block device or node, DeviceNotFound
1575 #          If @name is already taken, GenericError with an explanation
1576 #
1577 # Since: 2.4
1578 #
1579 # Example:
1580 #
1581 # -> { "execute": "block-dirty-bitmap-add",
1582 #      "arguments": { "node": "drive0", "name": "bitmap0" } }
1583 # <- { "return": {} }
1584 #
1585 ##
1586 { 'command': 'block-dirty-bitmap-add',
1587   'data': 'BlockDirtyBitmapAdd' }
1588
1589 ##
1590 # @block-dirty-bitmap-remove:
1591 #
1592 # Stop write tracking and remove the dirty bitmap that was created
1593 # with block-dirty-bitmap-add.
1594 #
1595 # Returns: nothing on success
1596 #          If @node is not a valid block device or node, DeviceNotFound
1597 #          If @name is not found, GenericError with an explanation
1598 #          if @name is frozen by an operation, GenericError
1599 #
1600 # Since: 2.4
1601 #
1602 # Example:
1603 #
1604 # -> { "execute": "block-dirty-bitmap-remove",
1605 #      "arguments": { "node": "drive0", "name": "bitmap0" } }
1606 # <- { "return": {} }
1607 #
1608 ##
1609 { 'command': 'block-dirty-bitmap-remove',
1610   'data': 'BlockDirtyBitmap' }
1611
1612 ##
1613 # @block-dirty-bitmap-clear:
1614 #
1615 # Clear (reset) a dirty bitmap on the device, so that an incremental
1616 # backup from this point in time forward will only backup clusters
1617 # modified after this clear operation.
1618 #
1619 # Returns: nothing on success
1620 #          If @node is not a valid block device, DeviceNotFound
1621 #          If @name is not found, GenericError with an explanation
1622 #
1623 # Since: 2.4
1624 #
1625 # Example:
1626 #
1627 # -> { "execute": "block-dirty-bitmap-clear",
1628 #      "arguments": { "node": "drive0", "name": "bitmap0" } }
1629 # <- { "return": {} }
1630 #
1631 ##
1632 { 'command': 'block-dirty-bitmap-clear',
1633   'data': 'BlockDirtyBitmap' }
1634
1635 ##
1636 # @blockdev-mirror:
1637 #
1638 # Start mirroring a block device's writes to a new destination.
1639 #
1640 # @job-id: identifier for the newly-created block job. If
1641 #          omitted, the device name will be used. (Since 2.7)
1642 #
1643 # @device: The device name or node-name of a root node whose writes should be
1644 #          mirrored.
1645 #
1646 # @target: the id or node-name of the block device to mirror to. This mustn't be
1647 #          attached to guest.
1648 #
1649 # @replaces: with sync=full graph node name to be replaced by the new
1650 #            image when a whole image copy is done. This can be used to repair
1651 #            broken Quorum files.
1652 #
1653 # @speed:  the maximum speed, in bytes per second
1654 #
1655 # @sync: what parts of the disk image should be copied to the destination
1656 #        (all the disk, only the sectors allocated in the topmost image, or
1657 #        only new I/O).
1658 #
1659 # @granularity: granularity of the dirty bitmap, default is 64K
1660 #               if the image format doesn't have clusters, 4K if the clusters
1661 #               are smaller than that, else the cluster size.  Must be a
1662 #               power of 2 between 512 and 64M
1663 #
1664 # @buf-size: maximum amount of data in flight from source to
1665 #            target
1666 #
1667 # @on-source-error: the action to take on an error on the source,
1668 #                   default 'report'.  'stop' and 'enospc' can only be used
1669 #                   if the block device supports io-status (see BlockInfo).
1670 #
1671 # @on-target-error: the action to take on an error on the target,
1672 #                   default 'report' (no limitations, since this applies to
1673 #                   a different block device than @device).
1674 #
1675 # @filter-node-name: the node name that should be assigned to the
1676 #                    filter driver that the mirror job inserts into the graph
1677 #                    above @device. If this option is not given, a node name is
1678 #                    autogenerated. (Since: 2.9)
1679 #
1680 # Returns: nothing on success.
1681 #
1682 # Since: 2.6
1683 #
1684 # Example:
1685 #
1686 # -> { "execute": "blockdev-mirror",
1687 #      "arguments": { "device": "ide-hd0",
1688 #                     "target": "target0",
1689 #                     "sync": "full" } }
1690 # <- { "return": {} }
1691 #
1692 ##
1693 { 'command': 'blockdev-mirror',
1694   'data': { '*job-id': 'str', 'device': 'str', 'target': 'str',
1695             '*replaces': 'str',
1696             'sync': 'MirrorSyncMode',
1697             '*speed': 'int', '*granularity': 'uint32',
1698             '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
1699             '*on-target-error': 'BlockdevOnError',
1700             '*filter-node-name': 'str' } }
1701
1702 ##
1703 # @block_set_io_throttle:
1704 #
1705 # Change I/O throttle limits for a block drive.
1706 #
1707 # Since QEMU 2.4, each device with I/O limits is member of a throttle
1708 # group.
1709 #
1710 # If two or more devices are members of the same group, the limits
1711 # will apply to the combined I/O of the whole group in a round-robin
1712 # fashion. Therefore, setting new I/O limits to a device will affect
1713 # the whole group.
1714 #
1715 # The name of the group can be specified using the 'group' parameter.
1716 # If the parameter is unset, it is assumed to be the current group of
1717 # that device. If it's not in any group yet, the name of the device
1718 # will be used as the name for its group.
1719 #
1720 # The 'group' parameter can also be used to move a device to a
1721 # different group. In this case the limits specified in the parameters
1722 # will be applied to the new group only.
1723 #
1724 # I/O limits can be disabled by setting all of them to 0. In this case
1725 # the device will be removed from its group and the rest of its
1726 # members will not be affected. The 'group' parameter is ignored.
1727 #
1728 # Returns: Nothing on success
1729 #          If @device is not a valid block device, DeviceNotFound
1730 #
1731 # Since: 1.1
1732 #
1733 # Example:
1734 #
1735 # -> { "execute": "block_set_io_throttle",
1736 #      "arguments": { "id": "ide0-1-0",
1737 #                     "bps": 1000000,
1738 #                     "bps_rd": 0,
1739 #                     "bps_wr": 0,
1740 #                     "iops": 0,
1741 #                     "iops_rd": 0,
1742 #                     "iops_wr": 0,
1743 #                     "bps_max": 8000000,
1744 #                     "bps_rd_max": 0,
1745 #                     "bps_wr_max": 0,
1746 #                     "iops_max": 0,
1747 #                     "iops_rd_max": 0,
1748 #                     "iops_wr_max": 0,
1749 #                     "bps_max_length": 60,
1750 #                     "iops_size": 0 } }
1751 # <- { "return": {} }
1752 ##
1753 { 'command': 'block_set_io_throttle', 'boxed': true,
1754   'data': 'BlockIOThrottle' }
1755
1756 ##
1757 # @BlockIOThrottle:
1758 #
1759 # A set of parameters describing block throttling.
1760 #
1761 # @device: Block device name (deprecated, use @id instead)
1762 #
1763 # @id: The name or QOM path of the guest device (since: 2.8)
1764 #
1765 # @bps: total throughput limit in bytes per second
1766 #
1767 # @bps_rd: read throughput limit in bytes per second
1768 #
1769 # @bps_wr: write throughput limit in bytes per second
1770 #
1771 # @iops: total I/O operations per second
1772 #
1773 # @iops_rd: read I/O operations per second
1774 #
1775 # @iops_wr: write I/O operations per second
1776 #
1777 # @bps_max: total throughput limit during bursts,
1778 #                     in bytes (Since 1.7)
1779 #
1780 # @bps_rd_max: read throughput limit during bursts,
1781 #                        in bytes (Since 1.7)
1782 #
1783 # @bps_wr_max: write throughput limit during bursts,
1784 #                        in bytes (Since 1.7)
1785 #
1786 # @iops_max: total I/O operations per second during bursts,
1787 #                      in bytes (Since 1.7)
1788 #
1789 # @iops_rd_max: read I/O operations per second during bursts,
1790 #                         in bytes (Since 1.7)
1791 #
1792 # @iops_wr_max: write I/O operations per second during bursts,
1793 #                         in bytes (Since 1.7)
1794 #
1795 # @bps_max_length: maximum length of the @bps_max burst
1796 #                            period, in seconds. It must only
1797 #                            be set if @bps_max is set as well.
1798 #                            Defaults to 1. (Since 2.6)
1799 #
1800 # @bps_rd_max_length: maximum length of the @bps_rd_max
1801 #                               burst period, in seconds. It must only
1802 #                               be set if @bps_rd_max is set as well.
1803 #                               Defaults to 1. (Since 2.6)
1804 #
1805 # @bps_wr_max_length: maximum length of the @bps_wr_max
1806 #                               burst period, in seconds. It must only
1807 #                               be set if @bps_wr_max is set as well.
1808 #                               Defaults to 1. (Since 2.6)
1809 #
1810 # @iops_max_length: maximum length of the @iops burst
1811 #                             period, in seconds. It must only
1812 #                             be set if @iops_max is set as well.
1813 #                             Defaults to 1. (Since 2.6)
1814 #
1815 # @iops_rd_max_length: maximum length of the @iops_rd_max
1816 #                                burst period, in seconds. It must only
1817 #                                be set if @iops_rd_max is set as well.
1818 #                                Defaults to 1. (Since 2.6)
1819 #
1820 # @iops_wr_max_length: maximum length of the @iops_wr_max
1821 #                                burst period, in seconds. It must only
1822 #                                be set if @iops_wr_max is set as well.
1823 #                                Defaults to 1. (Since 2.6)
1824 #
1825 # @iops_size: an I/O size in bytes (Since 1.7)
1826 #
1827 # @group: throttle group name (Since 2.4)
1828 #
1829 # Since: 1.1
1830 ##
1831 { 'struct': 'BlockIOThrottle',
1832   'data': { '*device': 'str', '*id': 'str', 'bps': 'int', 'bps_rd': 'int',
1833             'bps_wr': 'int', 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
1834             '*bps_max': 'int', '*bps_rd_max': 'int',
1835             '*bps_wr_max': 'int', '*iops_max': 'int',
1836             '*iops_rd_max': 'int', '*iops_wr_max': 'int',
1837             '*bps_max_length': 'int', '*bps_rd_max_length': 'int',
1838             '*bps_wr_max_length': 'int', '*iops_max_length': 'int',
1839             '*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int',
1840             '*iops_size': 'int', '*group': 'str' } }
1841
1842 ##
1843 # @block-stream:
1844 #
1845 # Copy data from a backing file into a block device.
1846 #
1847 # The block streaming operation is performed in the background until the entire
1848 # backing file has been copied.  This command returns immediately once streaming
1849 # has started.  The status of ongoing block streaming operations can be checked
1850 # with query-block-jobs.  The operation can be stopped before it has completed
1851 # using the block-job-cancel command.
1852 #
1853 # The node that receives the data is called the top image, can be located in
1854 # any part of the chain (but always above the base image; see below) and can be
1855 # specified using its device or node name. Earlier qemu versions only allowed
1856 # 'device' to name the top level node; presence of the 'base-node' parameter
1857 # during introspection can be used as a witness of the enhanced semantics
1858 # of 'device'.
1859 #
1860 # If a base file is specified then sectors are not copied from that base file and
1861 # its backing chain.  When streaming completes the image file will have the base
1862 # file as its backing file.  This can be used to stream a subset of the backing
1863 # file chain instead of flattening the entire image.
1864 #
1865 # On successful completion the image file is updated to drop the backing file
1866 # and the BLOCK_JOB_COMPLETED event is emitted.
1867 #
1868 # @job-id: identifier for the newly-created block job. If
1869 #          omitted, the device name will be used. (Since 2.7)
1870 #
1871 # @device: the device or node name of the top image
1872 #
1873 # @base:   the common backing file name.
1874 #                    It cannot be set if @base-node is also set.
1875 #
1876 # @base-node: the node name of the backing file.
1877 #                       It cannot be set if @base is also set. (Since 2.8)
1878 #
1879 # @backing-file: The backing file string to write into the top
1880 #                          image. This filename is not validated.
1881 #
1882 #                          If a pathname string is such that it cannot be
1883 #                          resolved by QEMU, that means that subsequent QMP or
1884 #                          HMP commands must use node-names for the image in
1885 #                          question, as filename lookup methods will fail.
1886 #
1887 #                          If not specified, QEMU will automatically determine
1888 #                          the backing file string to use, or error out if there
1889 #                          is no obvious choice.  Care should be taken when
1890 #                          specifying the string, to specify a valid filename or
1891 #                          protocol.
1892 #                          (Since 2.1)
1893 #
1894 # @speed:  the maximum speed, in bytes per second
1895 #
1896 # @on-error: the action to take on an error (default report).
1897 #            'stop' and 'enospc' can only be used if the block device
1898 #            supports io-status (see BlockInfo).  Since 1.3.
1899 #
1900 # Returns: Nothing on success. If @device does not exist, DeviceNotFound.
1901 #
1902 # Since: 1.1
1903 #
1904 # Example:
1905 #
1906 # -> { "execute": "block-stream",
1907 #      "arguments": { "device": "virtio0",
1908 #                     "base": "/tmp/master.qcow2" } }
1909 # <- { "return": {} }
1910 #
1911 ##
1912 { 'command': 'block-stream',
1913   'data': { '*job-id': 'str', 'device': 'str', '*base': 'str',
1914             '*base-node': 'str', '*backing-file': 'str', '*speed': 'int',
1915             '*on-error': 'BlockdevOnError' } }
1916
1917 ##
1918 # @block-job-set-speed:
1919 #
1920 # Set maximum speed for a background block operation.
1921 #
1922 # This command can only be issued when there is an active block job.
1923 #
1924 # Throttling can be disabled by setting the speed to 0.
1925 #
1926 # @device: The job identifier. This used to be a device name (hence
1927 #          the name of the parameter), but since QEMU 2.7 it can have
1928 #          other values.
1929 #
1930 # @speed:  the maximum speed, in bytes per second, or 0 for unlimited.
1931 #          Defaults to 0.
1932 #
1933 # Returns: Nothing on success
1934 #          If no background operation is active on this device, DeviceNotActive
1935 #
1936 # Since: 1.1
1937 ##
1938 { 'command': 'block-job-set-speed',
1939   'data': { 'device': 'str', 'speed': 'int' } }
1940
1941 ##
1942 # @block-job-cancel:
1943 #
1944 # Stop an active background block operation.
1945 #
1946 # This command returns immediately after marking the active background block
1947 # operation for cancellation.  It is an error to call this command if no
1948 # operation is in progress.
1949 #
1950 # The operation will cancel as soon as possible and then emit the
1951 # BLOCK_JOB_CANCELLED event.  Before that happens the job is still visible when
1952 # enumerated using query-block-jobs.
1953 #
1954 # For streaming, the image file retains its backing file unless the streaming
1955 # operation happens to complete just as it is being cancelled.  A new streaming
1956 # operation can be started at a later time to finish copying all data from the
1957 # backing file.
1958 #
1959 # @device: The job identifier. This used to be a device name (hence
1960 #          the name of the parameter), but since QEMU 2.7 it can have
1961 #          other values.
1962 #
1963 # @force: whether to allow cancellation of a paused job (default
1964 #         false).  Since 1.3.
1965 #
1966 # Returns: Nothing on success
1967 #          If no background operation is active on this device, DeviceNotActive
1968 #
1969 # Since: 1.1
1970 ##
1971 { 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' } }
1972
1973 ##
1974 # @block-job-pause:
1975 #
1976 # Pause an active background block operation.
1977 #
1978 # This command returns immediately after marking the active background block
1979 # operation for pausing.  It is an error to call this command if no
1980 # operation is in progress.  Pausing an already paused job has no cumulative
1981 # effect; a single block-job-resume command will resume the job.
1982 #
1983 # The operation will pause as soon as possible.  No event is emitted when
1984 # the operation is actually paused.  Cancelling a paused job automatically
1985 # resumes it.
1986 #
1987 # @device: The job identifier. This used to be a device name (hence
1988 #          the name of the parameter), but since QEMU 2.7 it can have
1989 #          other values.
1990 #
1991 # Returns: Nothing on success
1992 #          If no background operation is active on this device, DeviceNotActive
1993 #
1994 # Since: 1.3
1995 ##
1996 { 'command': 'block-job-pause', 'data': { 'device': 'str' } }
1997
1998 ##
1999 # @block-job-resume:
2000 #
2001 # Resume an active background block operation.
2002 #
2003 # This command returns immediately after resuming a paused background block
2004 # operation.  It is an error to call this command if no operation is in
2005 # progress.  Resuming an already running job is not an error.
2006 #
2007 # This command also clears the error status of the job.
2008 #
2009 # @device: The job identifier. This used to be a device name (hence
2010 #          the name of the parameter), but since QEMU 2.7 it can have
2011 #          other values.
2012 #
2013 # Returns: Nothing on success
2014 #          If no background operation is active on this device, DeviceNotActive
2015 #
2016 # Since: 1.3
2017 ##
2018 { 'command': 'block-job-resume', 'data': { 'device': 'str' } }
2019
2020 ##
2021 # @block-job-complete:
2022 #
2023 # Manually trigger completion of an active background block operation.  This
2024 # is supported for drive mirroring, where it also switches the device to
2025 # write to the target path only.  The ability to complete is signaled with
2026 # a BLOCK_JOB_READY event.
2027 #
2028 # This command completes an active background block operation synchronously.
2029 # The ordering of this command's return with the BLOCK_JOB_COMPLETED event
2030 # is not defined.  Note that if an I/O error occurs during the processing of
2031 # this command: 1) the command itself will fail; 2) the error will be processed
2032 # according to the rerror/werror arguments that were specified when starting
2033 # the operation.
2034 #
2035 # A cancelled or paused job cannot be completed.
2036 #
2037 # @device: The job identifier. This used to be a device name (hence
2038 #          the name of the parameter), but since QEMU 2.7 it can have
2039 #          other values.
2040 #
2041 # Returns: Nothing on success
2042 #          If no background operation is active on this device, DeviceNotActive
2043 #
2044 # Since: 1.3
2045 ##
2046 { 'command': 'block-job-complete', 'data': { 'device': 'str' } }
2047
2048 ##
2049 # @BlockdevDiscardOptions:
2050 #
2051 # Determines how to handle discard requests.
2052 #
2053 # @ignore:      Ignore the request
2054 # @unmap:       Forward as an unmap request
2055 #
2056 # Since: 2.9
2057 ##
2058 { 'enum': 'BlockdevDiscardOptions',
2059   'data': [ 'ignore', 'unmap' ] }
2060
2061 ##
2062 # @BlockdevDetectZeroesOptions:
2063 #
2064 # Describes the operation mode for the automatic conversion of plain
2065 # zero writes by the OS to driver specific optimized zero write commands.
2066 #
2067 # @off:      Disabled (default)
2068 # @on:       Enabled
2069 # @unmap:    Enabled and even try to unmap blocks if possible. This requires
2070 #            also that @BlockdevDiscardOptions is set to unmap for this device.
2071 #
2072 # Since: 2.1
2073 ##
2074 { 'enum': 'BlockdevDetectZeroesOptions',
2075   'data': [ 'off', 'on', 'unmap' ] }
2076
2077 ##
2078 # @BlockdevAioOptions:
2079 #
2080 # Selects the AIO backend to handle I/O requests
2081 #
2082 # @threads:     Use qemu's thread pool
2083 # @native:      Use native AIO backend (only Linux and Windows)
2084 #
2085 # Since: 2.9
2086 ##
2087 { 'enum': 'BlockdevAioOptions',
2088   'data': [ 'threads', 'native' ] }
2089
2090 ##
2091 # @BlockdevCacheOptions:
2092 #
2093 # Includes cache-related options for block devices
2094 #
2095 # @direct:      enables use of O_DIRECT (bypass the host page cache;
2096 #               default: false)
2097 # @no-flush:    ignore any flush requests for the device (default:
2098 #               false)
2099 #
2100 # Since: 2.9
2101 ##
2102 { 'struct': 'BlockdevCacheOptions',
2103   'data': { '*direct': 'bool',
2104             '*no-flush': 'bool' } }
2105
2106 ##
2107 # @BlockdevDriver:
2108 #
2109 # Drivers that are supported in block device operations.
2110 #
2111 # @vxhs: Since 2.10
2112 #
2113 # Since: 2.9
2114 ##
2115 { 'enum': 'BlockdevDriver',
2116   'data': [ 'blkdebug', 'blkverify', 'bochs', 'cloop',
2117             'dmg', 'file', 'ftp', 'ftps', 'gluster', 'host_cdrom',
2118             'host_device', 'http', 'https', 'iscsi', 'luks', 'nbd', 'nfs',
2119             'null-aio', 'null-co', 'parallels', 'qcow', 'qcow2', 'qed',
2120             'quorum', 'raw', 'rbd', 'replication', 'sheepdog', 'ssh',
2121             'vdi', 'vhdx', 'vmdk', 'vpc', 'vvfat', 'vxhs' ] }
2122
2123 ##
2124 # @BlockdevOptionsFile:
2125 #
2126 # Driver specific block device options for the file backend.
2127 #
2128 # @filename:    path to the image file
2129 # @aio:         AIO backend (default: threads) (since: 2.8)
2130 # @locking:     whether to enable file locking. If set to 'auto', only enable
2131 #               when Open File Descriptor (OFD) locking API is available
2132 #               (default: auto, since 2.10)
2133 #
2134 # Since: 2.9
2135 ##
2136 { 'struct': 'BlockdevOptionsFile',
2137   'data': { 'filename': 'str',
2138             '*locking': 'OnOffAuto',
2139             '*aio': 'BlockdevAioOptions' } }
2140
2141 ##
2142 # @BlockdevOptionsNull:
2143 #
2144 # Driver specific block device options for the null backend.
2145 #
2146 # @size:    size of the device in bytes.
2147 # @latency-ns: emulated latency (in nanoseconds) in processing
2148 #              requests. Default to zero which completes requests immediately.
2149 #              (Since 2.4)
2150 #
2151 # Since: 2.9
2152 ##
2153 { 'struct': 'BlockdevOptionsNull',
2154   'data': { '*size': 'int', '*latency-ns': 'uint64' } }
2155
2156 ##
2157 # @BlockdevOptionsVVFAT:
2158 #
2159 # Driver specific block device options for the vvfat protocol.
2160 #
2161 # @dir:         directory to be exported as FAT image
2162 # @fat-type:    FAT type: 12, 16 or 32
2163 # @floppy:      whether to export a floppy image (true) or
2164 #               partitioned hard disk (false; default)
2165 # @label:       set the volume label, limited to 11 bytes. FAT16 and
2166 #               FAT32 traditionally have some restrictions on labels, which are
2167 #               ignored by most operating systems. Defaults to "QEMU VVFAT".
2168 #               (since 2.4)
2169 # @rw:          whether to allow write operations (default: false)
2170 #
2171 # Since: 2.9
2172 ##
2173 { 'struct': 'BlockdevOptionsVVFAT',
2174   'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool',
2175             '*label': 'str', '*rw': 'bool' } }
2176
2177 ##
2178 # @BlockdevOptionsGenericFormat:
2179 #
2180 # Driver specific block device options for image format that have no option
2181 # besides their data source.
2182 #
2183 # @file:        reference to or definition of the data source block device
2184 #
2185 # Since: 2.9
2186 ##
2187 { 'struct': 'BlockdevOptionsGenericFormat',
2188   'data': { 'file': 'BlockdevRef' } }
2189
2190 ##
2191 # @BlockdevOptionsLUKS:
2192 #
2193 # Driver specific block device options for LUKS.
2194 #
2195 # @key-secret: the ID of a QCryptoSecret object providing
2196 #              the decryption key (since 2.6). Mandatory except when
2197 #              doing a metadata-only probe of the image.
2198 #
2199 # Since: 2.9
2200 ##
2201 { 'struct': 'BlockdevOptionsLUKS',
2202   'base': 'BlockdevOptionsGenericFormat',
2203   'data': { '*key-secret': 'str' } }
2204
2205
2206 ##
2207 # @BlockdevOptionsGenericCOWFormat:
2208 #
2209 # Driver specific block device options for image format that have no option
2210 # besides their data source and an optional backing file.
2211 #
2212 # @backing:     reference to or definition of the backing file block
2213 #               device (if missing, taken from the image file content). It is
2214 #               allowed to pass an empty string here in order to disable the
2215 #               default backing file.
2216 #
2217 # Since: 2.9
2218 ##
2219 { 'struct': 'BlockdevOptionsGenericCOWFormat',
2220   'base': 'BlockdevOptionsGenericFormat',
2221   'data': { '*backing': 'BlockdevRef' } }
2222
2223 ##
2224 # @Qcow2OverlapCheckMode:
2225 #
2226 # General overlap check modes.
2227 #
2228 # @none:        Do not perform any checks
2229 #
2230 # @constant:    Perform only checks which can be done in constant time and
2231 #               without reading anything from disk
2232 #
2233 # @cached:      Perform only checks which can be done without reading anything
2234 #               from disk
2235 #
2236 # @all:         Perform all available overlap checks
2237 #
2238 # Since: 2.9
2239 ##
2240 { 'enum': 'Qcow2OverlapCheckMode',
2241   'data': [ 'none', 'constant', 'cached', 'all' ] }
2242
2243 ##
2244 # @Qcow2OverlapCheckFlags:
2245 #
2246 # Structure of flags for each metadata structure. Setting a field to 'true'
2247 # makes qemu guard that structure against unintended overwriting. The default
2248 # value is chosen according to the template given.
2249 #
2250 # @template: Specifies a template mode which can be adjusted using the other
2251 #            flags, defaults to 'cached'
2252 #
2253 # Since: 2.9
2254 ##
2255 { 'struct': 'Qcow2OverlapCheckFlags',
2256   'data': { '*template':       'Qcow2OverlapCheckMode',
2257             '*main-header':    'bool',
2258             '*active-l1':      'bool',
2259             '*active-l2':      'bool',
2260             '*refcount-table': 'bool',
2261             '*refcount-block': 'bool',
2262             '*snapshot-table': 'bool',
2263             '*inactive-l1':    'bool',
2264             '*inactive-l2':    'bool' } }
2265
2266 ##
2267 # @Qcow2OverlapChecks:
2268 #
2269 # Specifies which metadata structures should be guarded against unintended
2270 # overwriting.
2271 #
2272 # @flags:   set of flags for separate specification of each metadata structure
2273 #           type
2274 #
2275 # @mode:    named mode which chooses a specific set of flags
2276 #
2277 # Since: 2.9
2278 ##
2279 { 'alternate': 'Qcow2OverlapChecks',
2280   'data': { 'flags': 'Qcow2OverlapCheckFlags',
2281             'mode':  'Qcow2OverlapCheckMode' } }
2282
2283 ##
2284 # @BlockdevOptionsQcow2:
2285 #
2286 # Driver specific block device options for qcow2.
2287 #
2288 # @lazy-refcounts:        whether to enable the lazy refcounts
2289 #                         feature (default is taken from the image file)
2290 #
2291 # @pass-discard-request:  whether discard requests to the qcow2
2292 #                         device should be forwarded to the data source
2293 #
2294 # @pass-discard-snapshot: whether discard requests for the data source
2295 #                         should be issued when a snapshot operation (e.g.
2296 #                         deleting a snapshot) frees clusters in the qcow2 file
2297 #
2298 # @pass-discard-other:    whether discard requests for the data source
2299 #                         should be issued on other occasions where a cluster
2300 #                         gets freed
2301 #
2302 # @overlap-check:         which overlap checks to perform for writes
2303 #                         to the image, defaults to 'cached' (since 2.2)
2304 #
2305 # @cache-size:            the maximum total size of the L2 table and
2306 #                         refcount block caches in bytes (since 2.2)
2307 #
2308 # @l2-cache-size:         the maximum size of the L2 table cache in
2309 #                         bytes (since 2.2)
2310 #
2311 # @refcount-cache-size:   the maximum size of the refcount block cache
2312 #                         in bytes (since 2.2)
2313 #
2314 # @cache-clean-interval:  clean unused entries in the L2 and refcount
2315 #                         caches. The interval is in seconds. The default value
2316 #                         is 0 and it disables this feature (since 2.5)
2317 #
2318 # Since: 2.9
2319 ##
2320 { 'struct': 'BlockdevOptionsQcow2',
2321   'base': 'BlockdevOptionsGenericCOWFormat',
2322   'data': { '*lazy-refcounts': 'bool',
2323             '*pass-discard-request': 'bool',
2324             '*pass-discard-snapshot': 'bool',
2325             '*pass-discard-other': 'bool',
2326             '*overlap-check': 'Qcow2OverlapChecks',
2327             '*cache-size': 'int',
2328             '*l2-cache-size': 'int',
2329             '*refcount-cache-size': 'int',
2330             '*cache-clean-interval': 'int' } }
2331
2332
2333 ##
2334 # @BlockdevOptionsSsh:
2335 #
2336 # @server:              host address
2337 #
2338 # @path:                path to the image on the host
2339 #
2340 # @user:                user as which to connect, defaults to current
2341 #                       local user name
2342 #
2343 # TODO: Expose the host_key_check option in QMP
2344 #
2345 # Since: 2.9
2346 ##
2347 { 'struct': 'BlockdevOptionsSsh',
2348   'data': { 'server': 'InetSocketAddress',
2349             'path': 'str',
2350             '*user': 'str' } }
2351
2352
2353 ##
2354 # @BlkdebugEvent:
2355 #
2356 # Trigger events supported by blkdebug.
2357 #
2358 # Since: 2.9
2359 ##
2360 { 'enum': 'BlkdebugEvent', 'prefix': 'BLKDBG',
2361   'data': [ 'l1_update', 'l1_grow_alloc_table', 'l1_grow_write_table',
2362             'l1_grow_activate_table', 'l2_load', 'l2_update',
2363             'l2_update_compressed', 'l2_alloc_cow_read', 'l2_alloc_write',
2364             'read_aio', 'read_backing_aio', 'read_compressed', 'write_aio',
2365             'write_compressed', 'vmstate_load', 'vmstate_save', 'cow_read',
2366             'cow_write', 'reftable_load', 'reftable_grow', 'reftable_update',
2367             'refblock_load', 'refblock_update', 'refblock_update_part',
2368             'refblock_alloc', 'refblock_alloc_hookup', 'refblock_alloc_write',
2369             'refblock_alloc_write_blocks', 'refblock_alloc_write_table',
2370             'refblock_alloc_switch_table', 'cluster_alloc',
2371             'cluster_alloc_bytes', 'cluster_free', 'flush_to_os',
2372             'flush_to_disk', 'pwritev_rmw_head', 'pwritev_rmw_after_head',
2373             'pwritev_rmw_tail', 'pwritev_rmw_after_tail', 'pwritev',
2374             'pwritev_zero', 'pwritev_done', 'empty_image_prepare' ] }
2375
2376 ##
2377 # @BlkdebugInjectErrorOptions:
2378 #
2379 # Describes a single error injection for blkdebug.
2380 #
2381 # @event:       trigger event
2382 #
2383 # @state:       the state identifier blkdebug needs to be in to
2384 #               actually trigger the event; defaults to "any"
2385 #
2386 # @errno:       error identifier (errno) to be returned; defaults to
2387 #               EIO
2388 #
2389 # @sector:      specifies the sector index which has to be affected
2390 #               in order to actually trigger the event; defaults to "any
2391 #               sector"
2392 #
2393 # @once:        disables further events after this one has been
2394 #               triggered; defaults to false
2395 #
2396 # @immediately: fail immediately; defaults to false
2397 #
2398 # Since: 2.9
2399 ##
2400 { 'struct': 'BlkdebugInjectErrorOptions',
2401   'data': { 'event': 'BlkdebugEvent',
2402             '*state': 'int',
2403             '*errno': 'int',
2404             '*sector': 'int',
2405             '*once': 'bool',
2406             '*immediately': 'bool' } }
2407
2408 ##
2409 # @BlkdebugSetStateOptions:
2410 #
2411 # Describes a single state-change event for blkdebug.
2412 #
2413 # @event:       trigger event
2414 #
2415 # @state:       the current state identifier blkdebug needs to be in;
2416 #               defaults to "any"
2417 #
2418 # @new_state:   the state identifier blkdebug is supposed to assume if
2419 #               this event is triggered
2420 #
2421 # Since: 2.9
2422 ##
2423 { 'struct': 'BlkdebugSetStateOptions',
2424   'data': { 'event': 'BlkdebugEvent',
2425             '*state': 'int',
2426             'new_state': 'int' } }
2427
2428 ##
2429 # @BlockdevOptionsBlkdebug:
2430 #
2431 # Driver specific block device options for blkdebug.
2432 #
2433 # @image:           underlying raw block device (or image file)
2434 #
2435 # @config:          filename of the configuration file
2436 #
2437 # @align:           required alignment for requests in bytes, must be
2438 #                   positive power of 2, or 0 for default
2439 #
2440 # @max-transfer:    maximum size for I/O transfers in bytes, must be
2441 #                   positive multiple of @align and of the underlying
2442 #                   file's request alignment (but need not be a power of
2443 #                   2), or 0 for default (since 2.10)
2444 #
2445 # @opt-write-zero:  preferred alignment for write zero requests in bytes,
2446 #                   must be positive multiple of @align and of the
2447 #                   underlying file's request alignment (but need not be a
2448 #                   power of 2), or 0 for default (since 2.10)
2449 #
2450 # @max-write-zero:  maximum size for write zero requests in bytes, must be
2451 #                   positive multiple of @align, of @opt-write-zero, and of
2452 #                   the underlying file's request alignment (but need not
2453 #                   be a power of 2), or 0 for default (since 2.10)
2454 #
2455 # @opt-discard:     preferred alignment for discard requests in bytes, must
2456 #                   be positive multiple of @align and of the underlying
2457 #                   file's request alignment (but need not be a power of
2458 #                   2), or 0 for default (since 2.10)
2459 #
2460 # @max-discard:     maximum size for discard requests in bytes, must be
2461 #                   positive multiple of @align, of @opt-discard, and of
2462 #                   the underlying file's request alignment (but need not
2463 #                   be a power of 2), or 0 for default (since 2.10)
2464 #
2465 # @inject-error:    array of error injection descriptions
2466 #
2467 # @set-state:       array of state-change descriptions
2468 #
2469 # Since: 2.9
2470 ##
2471 { 'struct': 'BlockdevOptionsBlkdebug',
2472   'data': { 'image': 'BlockdevRef',
2473             '*config': 'str',
2474             '*align': 'int', '*max-transfer': 'int32',
2475             '*opt-write-zero': 'int32', '*max-write-zero': 'int32',
2476             '*opt-discard': 'int32', '*max-discard': 'int32',
2477             '*inject-error': ['BlkdebugInjectErrorOptions'],
2478             '*set-state': ['BlkdebugSetStateOptions'] } }
2479
2480 ##
2481 # @BlockdevOptionsBlkverify:
2482 #
2483 # Driver specific block device options for blkverify.
2484 #
2485 # @test:    block device to be tested
2486 #
2487 # @raw:     raw image used for verification
2488 #
2489 # Since: 2.9
2490 ##
2491 { 'struct': 'BlockdevOptionsBlkverify',
2492   'data': { 'test': 'BlockdevRef',
2493             'raw': 'BlockdevRef' } }
2494
2495 ##
2496 # @QuorumReadPattern:
2497 #
2498 # An enumeration of quorum read patterns.
2499 #
2500 # @quorum: read all the children and do a quorum vote on reads
2501 #
2502 # @fifo: read only from the first child that has not failed
2503 #
2504 # Since: 2.9
2505 ##
2506 { 'enum': 'QuorumReadPattern', 'data': [ 'quorum', 'fifo' ] }
2507
2508 ##
2509 # @BlockdevOptionsQuorum:
2510 #
2511 # Driver specific block device options for Quorum
2512 #
2513 # @blkverify:      true if the driver must print content mismatch
2514 #                  set to false by default
2515 #
2516 # @children:       the children block devices to use
2517 #
2518 # @vote-threshold: the vote limit under which a read will fail
2519 #
2520 # @rewrite-corrupted: rewrite corrupted data when quorum is reached
2521 #                     (Since 2.1)
2522 #
2523 # @read-pattern: choose read pattern and set to quorum by default
2524 #                (Since 2.2)
2525 #
2526 # Since: 2.9
2527 ##
2528 { 'struct': 'BlockdevOptionsQuorum',
2529   'data': { '*blkverify': 'bool',
2530             'children': [ 'BlockdevRef' ],
2531             'vote-threshold': 'int',
2532             '*rewrite-corrupted': 'bool',
2533             '*read-pattern': 'QuorumReadPattern' } }
2534
2535 ##
2536 # @BlockdevOptionsGluster:
2537 #
2538 # Driver specific block device options for Gluster
2539 #
2540 # @volume:      name of gluster volume where VM image resides
2541 #
2542 # @path:        absolute path to image file in gluster volume
2543 #
2544 # @server:      gluster servers description
2545 #
2546 # @debug:       libgfapi log level (default '4' which is Error)
2547 #               (Since 2.8)
2548 #
2549 # @logfile:     libgfapi log file (default /dev/stderr) (Since 2.8)
2550 #
2551 # Since: 2.9
2552 ##
2553 { 'struct': 'BlockdevOptionsGluster',
2554   'data': { 'volume': 'str',
2555             'path': 'str',
2556             'server': ['SocketAddress'],
2557             '*debug': 'int',
2558             '*logfile': 'str' } }
2559
2560 ##
2561 # @IscsiTransport:
2562 #
2563 # An enumeration of libiscsi transport types
2564 #
2565 # Since: 2.9
2566 ##
2567 { 'enum': 'IscsiTransport',
2568   'data': [ 'tcp', 'iser' ] }
2569
2570 ##
2571 # @IscsiHeaderDigest:
2572 #
2573 # An enumeration of header digests supported by libiscsi
2574 #
2575 # Since: 2.9
2576 ##
2577 { 'enum': 'IscsiHeaderDigest',
2578   'prefix': 'QAPI_ISCSI_HEADER_DIGEST',
2579   'data': [ 'crc32c', 'none', 'crc32c-none', 'none-crc32c' ] }
2580
2581 ##
2582 # @BlockdevOptionsIscsi:
2583 #
2584 # @transport:       The iscsi transport type
2585 #
2586 # @portal:          The address of the iscsi portal
2587 #
2588 # @target:          The target iqn name
2589 #
2590 # @lun:             LUN to connect to. Defaults to 0.
2591 #
2592 # @user:            User name to log in with. If omitted, no CHAP
2593 #                   authentication is performed.
2594 #
2595 # @password-secret: The ID of a QCryptoSecret object providing
2596 #                   the password for the login. This option is required if
2597 #                   @user is specified.
2598 #
2599 # @initiator-name:  The iqn name we want to identify to the target
2600 #                   as. If this option is not specified, an initiator name is
2601 #                   generated automatically.
2602 #
2603 # @header-digest:   The desired header digest. Defaults to
2604 #                   none-crc32c.
2605 #
2606 # @timeout:         Timeout in seconds after which a request will
2607 #                   timeout. 0 means no timeout and is the default.
2608 #
2609 # Driver specific block device options for iscsi
2610 #
2611 # Since: 2.9
2612 ##
2613 { 'struct': 'BlockdevOptionsIscsi',
2614   'data': { 'transport': 'IscsiTransport',
2615             'portal': 'str',
2616             'target': 'str',
2617             '*lun': 'int',
2618             '*user': 'str',
2619             '*password-secret': 'str',
2620             '*initiator-name': 'str',
2621             '*header-digest': 'IscsiHeaderDigest',
2622             '*timeout': 'int' } }
2623
2624
2625 ##
2626 # @BlockdevOptionsRbd:
2627 #
2628 # @pool:               Ceph pool name.
2629 #
2630 # @image:              Image name in the Ceph pool.
2631 #
2632 # @conf:               path to Ceph configuration file.  Values
2633 #                      in the configuration file will be overridden by
2634 #                      options specified via QAPI.
2635 #
2636 # @snapshot:           Ceph snapshot name.
2637 #
2638 # @user:               Ceph id name.
2639 #
2640 # @server:             Monitor host address and port.  This maps
2641 #                      to the "mon_host" Ceph option.
2642 #
2643 # Since: 2.9
2644 ##
2645 { 'struct': 'BlockdevOptionsRbd',
2646   'data': { 'pool': 'str',
2647             'image': 'str',
2648             '*conf': 'str',
2649             '*snapshot': 'str',
2650             '*user': 'str',
2651             '*server': ['InetSocketAddressBase'] } }
2652
2653 ##
2654 # @BlockdevOptionsSheepdog:
2655 #
2656 # Driver specific block device options for sheepdog
2657 #
2658 # @vdi:         Virtual disk image name
2659 # @server:      The Sheepdog server to connect to
2660 # @snap-id:     Snapshot ID
2661 # @tag:         Snapshot tag name
2662 #
2663 # Only one of @snap-id and @tag may be present.
2664 #
2665 # Since: 2.9
2666 ##
2667 { 'struct': 'BlockdevOptionsSheepdog',
2668   'data': { 'server': 'SocketAddress',
2669             'vdi': 'str',
2670             '*snap-id': 'uint32',
2671             '*tag': 'str' } }
2672
2673 ##
2674 # @ReplicationMode:
2675 #
2676 # An enumeration of replication modes.
2677 #
2678 # @primary: Primary mode, the vm's state will be sent to secondary QEMU.
2679 #
2680 # @secondary: Secondary mode, receive the vm's state from primary QEMU.
2681 #
2682 # Since: 2.9
2683 ##
2684 { 'enum' : 'ReplicationMode', 'data' : [ 'primary', 'secondary' ] }
2685
2686 ##
2687 # @BlockdevOptionsReplication:
2688 #
2689 # Driver specific block device options for replication
2690 #
2691 # @mode: the replication mode
2692 #
2693 # @top-id: In secondary mode, node name or device ID of the root
2694 #          node who owns the replication node chain. Must not be given in
2695 #          primary mode.
2696 #
2697 # Since: 2.9
2698 ##
2699 { 'struct': 'BlockdevOptionsReplication',
2700   'base': 'BlockdevOptionsGenericFormat',
2701   'data': { 'mode': 'ReplicationMode',
2702             '*top-id': 'str' } }
2703
2704 ##
2705 # @NFSTransport:
2706 #
2707 # An enumeration of NFS transport types
2708 #
2709 # @inet:        TCP transport
2710 #
2711 # Since: 2.9
2712 ##
2713 { 'enum': 'NFSTransport',
2714   'data': [ 'inet' ] }
2715
2716 ##
2717 # @NFSServer:
2718 #
2719 # Captures the address of the socket
2720 #
2721 # @type:        transport type used for NFS (only TCP supported)
2722 #
2723 # @host:        host address for NFS server
2724 #
2725 # Since: 2.9
2726 ##
2727 { 'struct': 'NFSServer',
2728   'data': { 'type': 'NFSTransport',
2729             'host': 'str' } }
2730
2731 ##
2732 # @BlockdevOptionsNfs:
2733 #
2734 # Driver specific block device option for NFS
2735 #
2736 # @server:                  host address
2737 #
2738 # @path:                    path of the image on the host
2739 #
2740 # @user:                    UID value to use when talking to the
2741 #                           server (defaults to 65534 on Windows and getuid()
2742 #                           on unix)
2743 #
2744 # @group:                   GID value to use when talking to the
2745 #                           server (defaults to 65534 on Windows and getgid()
2746 #                           in unix)
2747 #
2748 # @tcp-syn-count:           number of SYNs during the session
2749 #                           establishment (defaults to libnfs default)
2750 #
2751 # @readahead-size:          set the readahead size in bytes (defaults
2752 #                           to libnfs default)
2753 #
2754 # @page-cache-size:         set the pagecache size in bytes (defaults
2755 #                           to libnfs default)
2756 #
2757 # @debug:                   set the NFS debug level (max 2) (defaults
2758 #                           to libnfs default)
2759 #
2760 # Since: 2.9
2761 ##
2762 { 'struct': 'BlockdevOptionsNfs',
2763   'data': { 'server': 'NFSServer',
2764             'path': 'str',
2765             '*user': 'int',
2766             '*group': 'int',
2767             '*tcp-syn-count': 'int',
2768             '*readahead-size': 'int',
2769             '*page-cache-size': 'int',
2770             '*debug': 'int' } }
2771
2772 ##
2773 # @BlockdevOptionsCurlBase:
2774 #
2775 # Driver specific block device options shared by all protocols supported by the
2776 # curl backend.
2777 #
2778 # @url:                     URL of the image file
2779 #
2780 # @readahead:               Size of the read-ahead cache; must be a multiple of
2781 #                           512 (defaults to 256 kB)
2782 #
2783 # @timeout:                 Timeout for connections, in seconds (defaults to 5)
2784 #
2785 # @username:                Username for authentication (defaults to none)
2786 #
2787 # @password-secret:         ID of a QCryptoSecret object providing a password
2788 #                           for authentication (defaults to no password)
2789 #
2790 # @proxy-username:          Username for proxy authentication (defaults to none)
2791 #
2792 # @proxy-password-secret:   ID of a QCryptoSecret object providing a password
2793 #                           for proxy authentication (defaults to no password)
2794 #
2795 # Since: 2.9
2796 ##
2797 { 'struct': 'BlockdevOptionsCurlBase',
2798   'data': { 'url': 'str',
2799             '*readahead': 'int',
2800             '*timeout': 'int',
2801             '*username': 'str',
2802             '*password-secret': 'str',
2803             '*proxy-username': 'str',
2804             '*proxy-password-secret': 'str' } }
2805
2806 ##
2807 # @BlockdevOptionsCurlHttp:
2808 #
2809 # Driver specific block device options for HTTP connections over the curl
2810 # backend.  URLs must start with "http://".
2811 #
2812 # @cookie:      List of cookies to set; format is
2813 #               "name1=content1; name2=content2;" as explained by
2814 #               CURLOPT_COOKIE(3). Defaults to no cookies.
2815 #
2816 # Since: 2.9
2817 ##
2818 { 'struct': 'BlockdevOptionsCurlHttp',
2819   'base': 'BlockdevOptionsCurlBase',
2820   'data': { '*cookie': 'str' } }
2821
2822 ##
2823 # @BlockdevOptionsCurlHttps:
2824 #
2825 # Driver specific block device options for HTTPS connections over the curl
2826 # backend.  URLs must start with "https://".
2827 #
2828 # @cookie:      List of cookies to set; format is
2829 #               "name1=content1; name2=content2;" as explained by
2830 #               CURLOPT_COOKIE(3). Defaults to no cookies.
2831 #
2832 # @sslverify:   Whether to verify the SSL certificate's validity (defaults to
2833 #               true)
2834 #
2835 # Since: 2.9
2836 ##
2837 { 'struct': 'BlockdevOptionsCurlHttps',
2838   'base': 'BlockdevOptionsCurlBase',
2839   'data': { '*cookie': 'str',
2840             '*sslverify': 'bool' } }
2841
2842 ##
2843 # @BlockdevOptionsCurlFtp:
2844 #
2845 # Driver specific block device options for FTP connections over the curl
2846 # backend.  URLs must start with "ftp://".
2847 #
2848 # Since: 2.9
2849 ##
2850 { 'struct': 'BlockdevOptionsCurlFtp',
2851   'base': 'BlockdevOptionsCurlBase',
2852   'data': { } }
2853
2854 ##
2855 # @BlockdevOptionsCurlFtps:
2856 #
2857 # Driver specific block device options for FTPS connections over the curl
2858 # backend.  URLs must start with "ftps://".
2859 #
2860 # @sslverify:   Whether to verify the SSL certificate's validity (defaults to
2861 #               true)
2862 #
2863 # Since: 2.9
2864 ##
2865 { 'struct': 'BlockdevOptionsCurlFtps',
2866   'base': 'BlockdevOptionsCurlBase',
2867   'data': { '*sslverify': 'bool' } }
2868
2869 ##
2870 # @BlockdevOptionsNbd:
2871 #
2872 # Driver specific block device options for NBD.
2873 #
2874 # @server:      NBD server address
2875 #
2876 # @export:      export name
2877 #
2878 # @tls-creds:   TLS credentials ID
2879 #
2880 # Since: 2.9
2881 ##
2882 { 'struct': 'BlockdevOptionsNbd',
2883   'data': { 'server': 'SocketAddress',
2884             '*export': 'str',
2885             '*tls-creds': 'str' } }
2886
2887 ##
2888 # @BlockdevOptionsRaw:
2889 #
2890 # Driver specific block device options for the raw driver.
2891 #
2892 # @offset:      position where the block device starts
2893 # @size:        the assumed size of the device
2894 #
2895 # Since: 2.9
2896 ##
2897 { 'struct': 'BlockdevOptionsRaw',
2898   'base': 'BlockdevOptionsGenericFormat',
2899   'data': { '*offset': 'int', '*size': 'int' } }
2900
2901 ##
2902 # @BlockdevOptionsVxHS:
2903 #
2904 # Driver specific block device options for VxHS
2905 #
2906 # @vdisk-id:    UUID of VxHS volume
2907 # @server:      vxhs server IP, port
2908 # @tls-creds:   TLS credentials ID
2909 #
2910 # Since: 2.10
2911 ##
2912 { 'struct': 'BlockdevOptionsVxHS',
2913   'data': { 'vdisk-id': 'str',
2914             'server': 'InetSocketAddressBase',
2915             '*tls-creds': 'str' } }
2916
2917 ##
2918 # @BlockdevOptions:
2919 #
2920 # Options for creating a block device.  Many options are available for all
2921 # block devices, independent of the block driver:
2922 #
2923 # @driver:        block driver name
2924 # @node-name:     the node name of the new node (Since 2.0).
2925 #                 This option is required on the top level of blockdev-add.
2926 # @discard:       discard-related options (default: ignore)
2927 # @cache:         cache-related options
2928 # @read-only:     whether the block device should be read-only
2929 #                 (default: false)
2930 # @detect-zeroes: detect and optimize zero writes (Since 2.1)
2931 #                 (default: off)
2932 # @force-share:   force share all permission on added nodes.
2933 #                 Requires read-only=true. (Since 2.10)
2934 #
2935 # Remaining options are determined by the block driver.
2936 #
2937 # Since: 2.9
2938 ##
2939 { 'union': 'BlockdevOptions',
2940   'base': { 'driver': 'BlockdevDriver',
2941             '*node-name': 'str',
2942             '*discard': 'BlockdevDiscardOptions',
2943             '*cache': 'BlockdevCacheOptions',
2944             '*read-only': 'bool',
2945             '*force-share': 'bool',
2946             '*detect-zeroes': 'BlockdevDetectZeroesOptions' },
2947   'discriminator': 'driver',
2948   'data': {
2949       'blkdebug':   'BlockdevOptionsBlkdebug',
2950       'blkverify':  'BlockdevOptionsBlkverify',
2951       'bochs':      'BlockdevOptionsGenericFormat',
2952       'cloop':      'BlockdevOptionsGenericFormat',
2953       'dmg':        'BlockdevOptionsGenericFormat',
2954       'file':       'BlockdevOptionsFile',
2955       'ftp':        'BlockdevOptionsCurlFtp',
2956       'ftps':       'BlockdevOptionsCurlFtps',
2957       'gluster':    'BlockdevOptionsGluster',
2958       'host_cdrom': 'BlockdevOptionsFile',
2959       'host_device':'BlockdevOptionsFile',
2960       'http':       'BlockdevOptionsCurlHttp',
2961       'https':      'BlockdevOptionsCurlHttps',
2962       'iscsi':      'BlockdevOptionsIscsi',
2963       'luks':       'BlockdevOptionsLUKS',
2964       'nbd':        'BlockdevOptionsNbd',
2965       'nfs':        'BlockdevOptionsNfs',
2966       'null-aio':   'BlockdevOptionsNull',
2967       'null-co':    'BlockdevOptionsNull',
2968       'parallels':  'BlockdevOptionsGenericFormat',
2969       'qcow2':      'BlockdevOptionsQcow2',
2970       'qcow':       'BlockdevOptionsGenericCOWFormat',
2971       'qed':        'BlockdevOptionsGenericCOWFormat',
2972       'quorum':     'BlockdevOptionsQuorum',
2973       'raw':        'BlockdevOptionsRaw',
2974       'rbd':        'BlockdevOptionsRbd',
2975       'replication':'BlockdevOptionsReplication',
2976       'sheepdog':   'BlockdevOptionsSheepdog',
2977       'ssh':        'BlockdevOptionsSsh',
2978       'vdi':        'BlockdevOptionsGenericFormat',
2979       'vhdx':       'BlockdevOptionsGenericFormat',
2980       'vmdk':       'BlockdevOptionsGenericCOWFormat',
2981       'vpc':        'BlockdevOptionsGenericFormat',
2982       'vvfat':      'BlockdevOptionsVVFAT',
2983       'vxhs':       'BlockdevOptionsVxHS'
2984   } }
2985
2986 ##
2987 # @BlockdevRef:
2988 #
2989 # Reference to a block device.
2990 #
2991 # @definition:      defines a new block device inline
2992 # @reference:       references the ID of an existing block device. An
2993 #                   empty string means that no block device should be
2994 #                   referenced.
2995 #
2996 # Since: 2.9
2997 ##
2998 { 'alternate': 'BlockdevRef',
2999   'data': { 'definition': 'BlockdevOptions',
3000             'reference': 'str' } }
3001
3002 ##
3003 # @blockdev-add:
3004 #
3005 # Creates a new block device. If the @id option is given at the top level, a
3006 # BlockBackend will be created; otherwise, @node-name is mandatory at the top
3007 # level and no BlockBackend will be created.
3008 #
3009 # Since: 2.9
3010 #
3011 # Example:
3012 #
3013 # 1.
3014 # -> { "execute": "blockdev-add",
3015 #      "arguments": {
3016 #           "driver": "qcow2",
3017 #           "node-name": "test1",
3018 #           "file": {
3019 #               "driver": "file",
3020 #               "filename": "test.qcow2"
3021 #            }
3022 #       }
3023 #     }
3024 # <- { "return": {} }
3025 #
3026 # 2.
3027 # -> { "execute": "blockdev-add",
3028 #      "arguments": {
3029 #           "driver": "qcow2",
3030 #           "node-name": "node0",
3031 #           "discard": "unmap",
3032 #           "cache": {
3033 #              "direct": true
3034 #            },
3035 #            "file": {
3036 #              "driver": "file",
3037 #              "filename": "/tmp/test.qcow2"
3038 #            },
3039 #            "backing": {
3040 #               "driver": "raw",
3041 #               "file": {
3042 #                  "driver": "file",
3043 #                  "filename": "/dev/fdset/4"
3044 #                }
3045 #            }
3046 #        }
3047 #      }
3048 #
3049 # <- { "return": {} }
3050 #
3051 ##
3052 { 'command': 'blockdev-add', 'data': 'BlockdevOptions', 'boxed': true }
3053
3054 ##
3055 # @blockdev-del:
3056 #
3057 # Deletes a block device that has been added using blockdev-add.
3058 # The command will fail if the node is attached to a device or is
3059 # otherwise being used.
3060 #
3061 # @node-name: Name of the graph node to delete.
3062 #
3063 # Since: 2.9
3064 #
3065 # Example:
3066 #
3067 # -> { "execute": "blockdev-add",
3068 #      "arguments": {
3069 #           "driver": "qcow2",
3070 #           "node-name": "node0",
3071 #           "file": {
3072 #               "driver": "file",
3073 #               "filename": "test.qcow2"
3074 #           }
3075 #      }
3076 #    }
3077 # <- { "return": {} }
3078 #
3079 # -> { "execute": "blockdev-del",
3080 #      "arguments": { "node-name": "node0" }
3081 #    }
3082 # <- { "return": {} }
3083 #
3084 ##
3085 { 'command': 'blockdev-del', 'data': { 'node-name': 'str' } }
3086
3087 ##
3088 # @blockdev-open-tray:
3089 #
3090 # Opens a block device's tray. If there is a block driver state tree inserted as
3091 # a medium, it will become inaccessible to the guest (but it will remain
3092 # associated to the block device, so closing the tray will make it accessible
3093 # again).
3094 #
3095 # If the tray was already open before, this will be a no-op.
3096 #
3097 # Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in
3098 # which no such event will be generated, these include:
3099 # - if the guest has locked the tray, @force is false and the guest does not
3100 #   respond to the eject request
3101 # - if the BlockBackend denoted by @device does not have a guest device attached
3102 #   to it
3103 # - if the guest device does not have an actual tray
3104 #
3105 # @device: Block device name (deprecated, use @id instead)
3106 #
3107 # @id:     The name or QOM path of the guest device (since: 2.8)
3108 #
3109 # @force:  if false (the default), an eject request will be sent to
3110 #          the guest if it has locked the tray (and the tray will not be opened
3111 #          immediately); if true, the tray will be opened regardless of whether
3112 #          it is locked
3113 #
3114 # Since: 2.5
3115 #
3116 # Example:
3117 #
3118 # -> { "execute": "blockdev-open-tray",
3119 #      "arguments": { "id": "ide0-1-0" } }
3120 #
3121 # <- { "timestamp": { "seconds": 1418751016,
3122 #                     "microseconds": 716996 },
3123 #      "event": "DEVICE_TRAY_MOVED",
3124 #      "data": { "device": "ide1-cd0",
3125 #                "id": "ide0-1-0",
3126 #                "tray-open": true } }
3127 #
3128 # <- { "return": {} }
3129 #
3130 ##
3131 { 'command': 'blockdev-open-tray',
3132   'data': { '*device': 'str',
3133             '*id': 'str',
3134             '*force': 'bool' } }
3135
3136 ##
3137 # @blockdev-close-tray:
3138 #
3139 # Closes a block device's tray. If there is a block driver state tree associated
3140 # with the block device (which is currently ejected), that tree will be loaded
3141 # as the medium.
3142 #
3143 # If the tray was already closed before, this will be a no-op.
3144 #
3145 # @device:  Block device name (deprecated, use @id instead)
3146 #
3147 # @id:      The name or QOM path of the guest device (since: 2.8)
3148 #
3149 # Since: 2.5
3150 #
3151 # Example:
3152 #
3153 # -> { "execute": "blockdev-close-tray",
3154 #      "arguments": { "id": "ide0-1-0" } }
3155 #
3156 # <- { "timestamp": { "seconds": 1418751345,
3157 #                     "microseconds": 272147 },
3158 #      "event": "DEVICE_TRAY_MOVED",
3159 #      "data": { "device": "ide1-cd0",
3160 #                "id": "ide0-1-0",
3161 #                "tray-open": false } }
3162 #
3163 # <- { "return": {} }
3164 #
3165 ##
3166 { 'command': 'blockdev-close-tray',
3167   'data': { '*device': 'str',
3168             '*id': 'str' } }
3169
3170 ##
3171 # @x-blockdev-remove-medium:
3172 #
3173 # Removes a medium (a block driver state tree) from a block device. That block
3174 # device's tray must currently be open (unless there is no attached guest
3175 # device).
3176 #
3177 # If the tray is open and there is no medium inserted, this will be a no-op.
3178 #
3179 # @device: Block device name (deprecated, use @id instead)
3180 #
3181 # @id:     The name or QOM path of the guest device (since: 2.8)
3182 #
3183 # Note: This command is still a work in progress and is considered experimental.
3184 # Stay away from it unless you want to help with its development.
3185 #
3186 # Since: 2.5
3187 #
3188 # Example:
3189 #
3190 # -> { "execute": "x-blockdev-remove-medium",
3191 #      "arguments": { "id": "ide0-1-0" } }
3192 #
3193 # <- { "error": { "class": "GenericError",
3194 #                 "desc": "Tray of device 'ide0-1-0' is not open" } }
3195 #
3196 # -> { "execute": "blockdev-open-tray",
3197 #      "arguments": { "id": "ide0-1-0" } }
3198 #
3199 # <- { "timestamp": { "seconds": 1418751627,
3200 #                     "microseconds": 549958 },
3201 #      "event": "DEVICE_TRAY_MOVED",
3202 #      "data": { "device": "ide1-cd0",
3203 #                "id": "ide0-1-0",
3204 #                "tray-open": true } }
3205 #
3206 # <- { "return": {} }
3207 #
3208 # -> { "execute": "x-blockdev-remove-medium",
3209 #      "arguments": { "device": "ide0-1-0" } }
3210 #
3211 # <- { "return": {} }
3212 #
3213 ##
3214 { 'command': 'x-blockdev-remove-medium',
3215   'data': { '*device': 'str',
3216             '*id': 'str' } }
3217
3218 ##
3219 # @x-blockdev-insert-medium:
3220 #
3221 # Inserts a medium (a block driver state tree) into a block device. That block
3222 # device's tray must currently be open (unless there is no attached guest
3223 # device) and there must be no medium inserted already.
3224 #
3225 # @device:    Block device name (deprecated, use @id instead)
3226 #
3227 # @id:        The name or QOM path of the guest device (since: 2.8)
3228 #
3229 # @node-name: name of a node in the block driver state graph
3230 #
3231 # Note: This command is still a work in progress and is considered experimental.
3232 # Stay away from it unless you want to help with its development.
3233 #
3234 # Since: 2.5
3235 #
3236 # Example:
3237 #
3238 # -> { "execute": "blockdev-add",
3239 #      "arguments": {
3240 #          "options": { "node-name": "node0",
3241 #                       "driver": "raw",
3242 #                       "file": { "driver": "file",
3243 #                                 "filename": "fedora.iso" } } } }
3244 # <- { "return": {} }
3245 #
3246 # -> { "execute": "x-blockdev-insert-medium",
3247 #      "arguments": { "id": "ide0-1-0",
3248 #                     "node-name": "node0" } }
3249 #
3250 # <- { "return": {} }
3251 #
3252 ##
3253 { 'command': 'x-blockdev-insert-medium',
3254   'data': { '*device': 'str',
3255             '*id': 'str',
3256             'node-name': 'str'} }
3257
3258
3259 ##
3260 # @BlockdevChangeReadOnlyMode:
3261 #
3262 # Specifies the new read-only mode of a block device subject to the
3263 # @blockdev-change-medium command.
3264 #
3265 # @retain:      Retains the current read-only mode
3266 #
3267 # @read-only:   Makes the device read-only
3268 #
3269 # @read-write:  Makes the device writable
3270 #
3271 # Since: 2.3
3272 #
3273 ##
3274 { 'enum': 'BlockdevChangeReadOnlyMode',
3275   'data': ['retain', 'read-only', 'read-write'] }
3276
3277
3278 ##
3279 # @blockdev-change-medium:
3280 #
3281 # Changes the medium inserted into a block device by ejecting the current medium
3282 # and loading a new image file which is inserted as the new medium (this command
3283 # combines blockdev-open-tray, x-blockdev-remove-medium,
3284 # x-blockdev-insert-medium and blockdev-close-tray).
3285 #
3286 # @device:          Block device name (deprecated, use @id instead)
3287 #
3288 # @id:              The name or QOM path of the guest device
3289 #                   (since: 2.8)
3290 #
3291 # @filename:        filename of the new image to be loaded
3292 #
3293 # @format:          format to open the new image with (defaults to
3294 #                   the probed format)
3295 #
3296 # @read-only-mode:  change the read-only mode of the device; defaults
3297 #                   to 'retain'
3298 #
3299 # Since: 2.5
3300 #
3301 # Examples:
3302 #
3303 # 1. Change a removable medium
3304 #
3305 # -> { "execute": "blockdev-change-medium",
3306 #      "arguments": { "id": "ide0-1-0",
3307 #                     "filename": "/srv/images/Fedora-12-x86_64-DVD.iso",
3308 #                     "format": "raw" } }
3309 # <- { "return": {} }
3310 #
3311 # 2. Load a read-only medium into a writable drive
3312 #
3313 # -> { "execute": "blockdev-change-medium",
3314 #      "arguments": { "id": "floppyA",
3315 #                     "filename": "/srv/images/ro.img",
3316 #                     "format": "raw",
3317 #                     "read-only-mode": "retain" } }
3318 #
3319 # <- { "error":
3320 #      { "class": "GenericError",
3321 #        "desc": "Could not open '/srv/images/ro.img': Permission denied" } }
3322 #
3323 # -> { "execute": "blockdev-change-medium",
3324 #      "arguments": { "id": "floppyA",
3325 #                     "filename": "/srv/images/ro.img",
3326 #                     "format": "raw",
3327 #                     "read-only-mode": "read-only" } }
3328 #
3329 # <- { "return": {} }
3330 #
3331 ##
3332 { 'command': 'blockdev-change-medium',
3333   'data': { '*device': 'str',
3334             '*id': 'str',
3335             'filename': 'str',
3336             '*format': 'str',
3337             '*read-only-mode': 'BlockdevChangeReadOnlyMode' } }
3338
3339
3340 ##
3341 # @BlockErrorAction:
3342 #
3343 # An enumeration of action that has been taken when a DISK I/O occurs
3344 #
3345 # @ignore: error has been ignored
3346 #
3347 # @report: error has been reported to the device
3348 #
3349 # @stop: error caused VM to be stopped
3350 #
3351 # Since: 2.1
3352 ##
3353 { 'enum': 'BlockErrorAction',
3354   'data': [ 'ignore', 'report', 'stop' ] }
3355
3356
3357 ##
3358 # @BLOCK_IMAGE_CORRUPTED:
3359 #
3360 # Emitted when a disk image is being marked corrupt. The image can be
3361 # identified by its device or node name. The 'device' field is always
3362 # present for compatibility reasons, but it can be empty ("") if the
3363 # image does not have a device name associated.
3364 #
3365 # @device: device name. This is always present for compatibility
3366 #          reasons, but it can be empty ("") if the image does not
3367 #          have a device name associated.
3368 #
3369 # @node-name: node name (Since: 2.4)
3370 #
3371 # @msg: informative message for human consumption, such as the kind of
3372 #       corruption being detected. It should not be parsed by machine as it is
3373 #       not guaranteed to be stable
3374 #
3375 # @offset: if the corruption resulted from an image access, this is
3376 #          the host's access offset into the image
3377 #
3378 # @size: if the corruption resulted from an image access, this is
3379 #        the access size
3380 #
3381 # @fatal: if set, the image is marked corrupt and therefore unusable after this
3382 #        event and must be repaired (Since 2.2; before, every
3383 #        BLOCK_IMAGE_CORRUPTED event was fatal)
3384 #
3385 # Note: If action is "stop", a STOP event will eventually follow the
3386 #       BLOCK_IO_ERROR event.
3387 #
3388 # Example:
3389 #
3390 # <- { "event": "BLOCK_IMAGE_CORRUPTED",
3391 #      "data": { "device": "ide0-hd0", "node-name": "node0",
3392 #                "msg": "Prevented active L1 table overwrite", "offset": 196608,
3393 #                "size": 65536 },
3394 #      "timestamp": { "seconds": 1378126126, "microseconds": 966463 } }
3395 #
3396 # Since: 1.7
3397 ##
3398 { 'event': 'BLOCK_IMAGE_CORRUPTED',
3399   'data': { 'device'     : 'str',
3400             '*node-name' : 'str',
3401             'msg'        : 'str',
3402             '*offset'    : 'int',
3403             '*size'      : 'int',
3404             'fatal'      : 'bool' } }
3405
3406 ##
3407 # @BLOCK_IO_ERROR:
3408 #
3409 # Emitted when a disk I/O error occurs
3410 #
3411 # @device: device name. This is always present for compatibility
3412 #          reasons, but it can be empty ("") if the image does not
3413 #          have a device name associated.
3414 #
3415 # @node-name: node name. Note that errors may be reported for the root node
3416 #             that is directly attached to a guest device rather than for the
3417 #             node where the error occurred. (Since: 2.8)
3418 #
3419 # @operation: I/O operation
3420 #
3421 # @action: action that has been taken
3422 #
3423 # @nospace: true if I/O error was caused due to a no-space
3424 #           condition. This key is only present if query-block's
3425 #           io-status is present, please see query-block documentation
3426 #           for more information (since: 2.2)
3427 #
3428 # @reason: human readable string describing the error cause.
3429 #          (This field is a debugging aid for humans, it should not
3430 #           be parsed by applications) (since: 2.2)
3431 #
3432 # Note: If action is "stop", a STOP event will eventually follow the
3433 # BLOCK_IO_ERROR event
3434 #
3435 # Since: 0.13.0
3436 #
3437 # Example:
3438 #
3439 # <- { "event": "BLOCK_IO_ERROR",
3440 #      "data": { "device": "ide0-hd1",
3441 #                "node-name": "#block212",
3442 #                "operation": "write",
3443 #                "action": "stop" },
3444 #      "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
3445 #
3446 ##
3447 { 'event': 'BLOCK_IO_ERROR',
3448   'data': { 'device': 'str', 'node-name': 'str', 'operation': 'IoOperationType',
3449             'action': 'BlockErrorAction', '*nospace': 'bool',
3450             'reason': 'str' } }
3451
3452 ##
3453 # @BLOCK_JOB_COMPLETED:
3454 #
3455 # Emitted when a block job has completed
3456 #
3457 # @type: job type
3458 #
3459 # @device: The job identifier. Originally the device name but other
3460 #          values are allowed since QEMU 2.7
3461 #
3462 # @len: maximum progress value
3463 #
3464 # @offset: current progress value. On success this is equal to len.
3465 #          On failure this is less than len
3466 #
3467 # @speed: rate limit, bytes per second
3468 #
3469 # @error: error message. Only present on failure. This field
3470 #         contains a human-readable error message. There are no semantics
3471 #         other than that streaming has failed and clients should not try to
3472 #         interpret the error string
3473 #
3474 # Since: 1.1
3475 #
3476 # Example:
3477 #
3478 # <- { "event": "BLOCK_JOB_COMPLETED",
3479 #      "data": { "type": "stream", "device": "virtio-disk0",
3480 #                "len": 10737418240, "offset": 10737418240,
3481 #                "speed": 0 },
3482 #      "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
3483 #
3484 ##
3485 { 'event': 'BLOCK_JOB_COMPLETED',
3486   'data': { 'type'  : 'BlockJobType',
3487             'device': 'str',
3488             'len'   : 'int',
3489             'offset': 'int',
3490             'speed' : 'int',
3491             '*error': 'str' } }
3492
3493 ##
3494 # @BLOCK_JOB_CANCELLED:
3495 #
3496 # Emitted when a block job has been cancelled
3497 #
3498 # @type: job type
3499 #
3500 # @device: The job identifier. Originally the device name but other
3501 #          values are allowed since QEMU 2.7
3502 #
3503 # @len: maximum progress value
3504 #
3505 # @offset: current progress value. On success this is equal to len.
3506 #          On failure this is less than len
3507 #
3508 # @speed: rate limit, bytes per second
3509 #
3510 # Since: 1.1
3511 #
3512 # Example:
3513 #
3514 # <- { "event": "BLOCK_JOB_CANCELLED",
3515 #      "data": { "type": "stream", "device": "virtio-disk0",
3516 #                "len": 10737418240, "offset": 134217728,
3517 #                "speed": 0 },
3518 #      "timestamp": { "seconds": 1267061043, "microseconds": 959568 } }
3519 #
3520 ##
3521 { 'event': 'BLOCK_JOB_CANCELLED',
3522   'data': { 'type'  : 'BlockJobType',
3523             'device': 'str',
3524             'len'   : 'int',
3525             'offset': 'int',
3526             'speed' : 'int' } }
3527
3528 ##
3529 # @BLOCK_JOB_ERROR:
3530 #
3531 # Emitted when a block job encounters an error
3532 #
3533 # @device: The job identifier. Originally the device name but other
3534 #          values are allowed since QEMU 2.7
3535 #
3536 # @operation: I/O operation
3537 #
3538 # @action: action that has been taken
3539 #
3540 # Since: 1.3
3541 #
3542 # Example:
3543 #
3544 # <- { "event": "BLOCK_JOB_ERROR",
3545 #      "data": { "device": "ide0-hd1",
3546 #                "operation": "write",
3547 #                "action": "stop" },
3548 #      "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
3549 #
3550 ##
3551 { 'event': 'BLOCK_JOB_ERROR',
3552   'data': { 'device'   : 'str',
3553             'operation': 'IoOperationType',
3554             'action'   : 'BlockErrorAction' } }
3555
3556 ##
3557 # @BLOCK_JOB_READY:
3558 #
3559 # Emitted when a block job is ready to complete
3560 #
3561 # @type: job type
3562 #
3563 # @device: The job identifier. Originally the device name but other
3564 #          values are allowed since QEMU 2.7
3565 #
3566 # @len: maximum progress value
3567 #
3568 # @offset: current progress value. On success this is equal to len.
3569 #          On failure this is less than len
3570 #
3571 # @speed: rate limit, bytes per second
3572 #
3573 # Note: The "ready to complete" status is always reset by a @BLOCK_JOB_ERROR
3574 # event
3575 #
3576 # Since: 1.3
3577 #
3578 # Example:
3579 #
3580 # <- { "event": "BLOCK_JOB_READY",
3581 #      "data": { "device": "drive0", "type": "mirror", "speed": 0,
3582 #                "len": 2097152, "offset": 2097152 }
3583 #      "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
3584 #
3585 ##
3586 { 'event': 'BLOCK_JOB_READY',
3587   'data': { 'type'  : 'BlockJobType',
3588             'device': 'str',
3589             'len'   : 'int',
3590             'offset': 'int',
3591             'speed' : 'int' } }
3592
3593 ##
3594 # @PreallocMode:
3595 #
3596 # Preallocation mode of QEMU image file
3597 #
3598 # @off: no preallocation
3599 # @metadata: preallocate only for metadata
3600 # @falloc: like @full preallocation but allocate disk space by
3601 #          posix_fallocate() rather than writing zeros.
3602 # @full: preallocate all data by writing zeros to device to ensure disk
3603 #        space is really available. @full preallocation also sets up
3604 #        metadata correctly.
3605 #
3606 # Since: 2.2
3607 ##
3608 { 'enum': 'PreallocMode',
3609   'data': [ 'off', 'metadata', 'falloc', 'full' ] }
3610
3611 ##
3612 # @BLOCK_WRITE_THRESHOLD:
3613 #
3614 # Emitted when writes on block device reaches or exceeds the
3615 # configured write threshold. For thin-provisioned devices, this
3616 # means the device should be extended to avoid pausing for
3617 # disk exhaustion.
3618 # The event is one shot. Once triggered, it needs to be
3619 # re-registered with another block-set-threshold command.
3620 #
3621 # @node-name: graph node name on which the threshold was exceeded.
3622 #
3623 # @amount-exceeded: amount of data which exceeded the threshold, in bytes.
3624 #
3625 # @write-threshold: last configured threshold, in bytes.
3626 #
3627 # Since: 2.3
3628 ##
3629 { 'event': 'BLOCK_WRITE_THRESHOLD',
3630   'data': { 'node-name': 'str',
3631             'amount-exceeded': 'uint64',
3632             'write-threshold': 'uint64' } }
3633
3634 ##
3635 # @block-set-write-threshold:
3636 #
3637 # Change the write threshold for a block drive. An event will be
3638 # delivered if a write to this block drive crosses the configured
3639 # threshold.  The threshold is an offset, thus must be
3640 # non-negative. Default is no write threshold. Setting the threshold
3641 # to zero disables it.
3642 #
3643 # This is useful to transparently resize thin-provisioned drives without
3644 # the guest OS noticing.
3645 #
3646 # @node-name: graph node name on which the threshold must be set.
3647 #
3648 # @write-threshold: configured threshold for the block device, bytes.
3649 #                   Use 0 to disable the threshold.
3650 #
3651 # Since: 2.3
3652 #
3653 # Example:
3654 #
3655 # -> { "execute": "block-set-write-threshold",
3656 #      "arguments": { "node-name": "mydev",
3657 #                     "write-threshold": 17179869184 } }
3658 # <- { "return": {} }
3659 #
3660 ##
3661 { 'command': 'block-set-write-threshold',
3662   'data': { 'node-name': 'str', 'write-threshold': 'uint64' } }
3663
3664 ##
3665 # @x-blockdev-change:
3666 #
3667 # Dynamically reconfigure the block driver state graph. It can be used
3668 # to add, remove, insert or replace a graph node. Currently only the
3669 # Quorum driver implements this feature to add or remove its child. This
3670 # is useful to fix a broken quorum child.
3671 #
3672 # If @node is specified, it will be inserted under @parent. @child
3673 # may not be specified in this case. If both @parent and @child are
3674 # specified but @node is not, @child will be detached from @parent.
3675 #
3676 # @parent: the id or name of the parent node.
3677 #
3678 # @child: the name of a child under the given parent node.
3679 #
3680 # @node: the name of the node that will be added.
3681 #
3682 # Note: this command is experimental, and its API is not stable. It
3683 # does not support all kinds of operations, all kinds of children, nor
3684 # all block drivers.
3685 #
3686 # Warning: The data in a new quorum child MUST be consistent with that of
3687 # the rest of the array.
3688 #
3689 # Since: 2.7
3690 #
3691 # Example:
3692 #
3693 # 1. Add a new node to a quorum
3694 # -> { "execute": "blockdev-add",
3695 #      "arguments": {
3696 #          "options": { "driver": "raw",
3697 #                       "node-name": "new_node",
3698 #                        "file": { "driver": "file",
3699 #                                  "filename": "test.raw" } } } }
3700 # <- { "return": {} }
3701 # -> { "execute": "x-blockdev-change",
3702 #      "arguments": { "parent": "disk1",
3703 #                     "node": "new_node" } }
3704 # <- { "return": {} }
3705 #
3706 # 2. Delete a quorum's node
3707 # -> { "execute": "x-blockdev-change",
3708 #      "arguments": { "parent": "disk1",
3709 #                     "child": "children.1" } }
3710 # <- { "return": {} }
3711 #
3712 ##
3713 { 'command': 'x-blockdev-change',
3714   'data' : { 'parent': 'str',
3715              '*child': 'str',
3716              '*node': 'str' } }