]>
Commit | Line | Data |
---|---|---|
5db15096 BC |
1 | # -*- Mode: Python -*- |
2 | # | |
3 | # QAPI block core definitions (vm unrelated) | |
4 | ||
5 | # QAPI common definitions | |
6 | { 'include': 'common.json' } | |
1ad166b6 BC |
7 | |
8 | ## | |
9 | # @SnapshotInfo | |
10 | # | |
11 | # @id: unique snapshot id | |
12 | # | |
13 | # @name: user chosen name | |
14 | # | |
15 | # @vm-state-size: size of the VM state | |
16 | # | |
17 | # @date-sec: UTC date of the snapshot in seconds | |
18 | # | |
19 | # @date-nsec: fractional part in nano seconds to be used with date-sec | |
20 | # | |
21 | # @vm-clock-sec: VM clock relative to boot in seconds | |
22 | # | |
23 | # @vm-clock-nsec: fractional part in nano seconds to be used with vm-clock-sec | |
24 | # | |
25 | # Since: 1.3 | |
26 | # | |
27 | ## | |
28 | ||
895a2a80 | 29 | { 'struct': 'SnapshotInfo', |
1ad166b6 BC |
30 | 'data': { 'id': 'str', 'name': 'str', 'vm-state-size': 'int', |
31 | 'date-sec': 'int', 'date-nsec': 'int', | |
32 | 'vm-clock-sec': 'int', 'vm-clock-nsec': 'int' } } | |
33 | ||
34 | ## | |
35 | # @ImageInfoSpecificQCow2: | |
36 | # | |
37 | # @compat: compatibility level | |
38 | # | |
39 | # @lazy-refcounts: #optional on or off; only valid for compat >= 1.1 | |
40 | # | |
9009b196 HR |
41 | # @corrupt: #optional true if the image has been marked corrupt; only valid for |
42 | # compat >= 1.1 (since 2.2) | |
43 | # | |
0709c5a1 HR |
44 | # @refcount-bits: width of a refcount entry in bits (since 2.3) |
45 | # | |
1ad166b6 BC |
46 | # Since: 1.7 |
47 | ## | |
895a2a80 | 48 | { 'struct': 'ImageInfoSpecificQCow2', |
1ad166b6 BC |
49 | 'data': { |
50 | 'compat': 'str', | |
9009b196 | 51 | '*lazy-refcounts': 'bool', |
0709c5a1 HR |
52 | '*corrupt': 'bool', |
53 | 'refcount-bits': 'int' | |
1ad166b6 BC |
54 | } } |
55 | ||
56 | ## | |
57 | # @ImageInfoSpecificVmdk: | |
58 | # | |
59 | # @create-type: The create type of VMDK image | |
60 | # | |
61 | # @cid: Content id of image | |
62 | # | |
63 | # @parent-cid: Parent VMDK image's cid | |
64 | # | |
65 | # @extents: List of extent files | |
66 | # | |
67 | # Since: 1.7 | |
68 | ## | |
895a2a80 | 69 | { 'struct': 'ImageInfoSpecificVmdk', |
1ad166b6 BC |
70 | 'data': { |
71 | 'create-type': 'str', | |
72 | 'cid': 'int', | |
73 | 'parent-cid': 'int', | |
74 | 'extents': ['ImageInfo'] | |
75 | } } | |
76 | ||
77 | ## | |
78 | # @ImageInfoSpecific: | |
79 | # | |
80 | # A discriminated record of image format specific information structures. | |
81 | # | |
82 | # Since: 1.7 | |
83 | ## | |
84 | ||
85 | { 'union': 'ImageInfoSpecific', | |
86 | 'data': { | |
87 | 'qcow2': 'ImageInfoSpecificQCow2', | |
88 | 'vmdk': 'ImageInfoSpecificVmdk' | |
89 | } } | |
90 | ||
91 | ## | |
92 | # @ImageInfo: | |
93 | # | |
94 | # Information about a QEMU image file | |
95 | # | |
96 | # @filename: name of the image file | |
97 | # | |
98 | # @format: format of the image file | |
99 | # | |
100 | # @virtual-size: maximum capacity in bytes of the image | |
101 | # | |
102 | # @actual-size: #optional actual size on disk in bytes of the image | |
103 | # | |
104 | # @dirty-flag: #optional true if image is not cleanly closed | |
105 | # | |
106 | # @cluster-size: #optional size of a cluster in bytes | |
107 | # | |
108 | # @encrypted: #optional true if the image is encrypted | |
109 | # | |
110 | # @compressed: #optional true if the image is compressed (Since 1.7) | |
111 | # | |
112 | # @backing-filename: #optional name of the backing file | |
113 | # | |
114 | # @full-backing-filename: #optional full path of the backing file | |
115 | # | |
116 | # @backing-filename-format: #optional the format of the backing file | |
117 | # | |
118 | # @snapshots: #optional list of VM snapshots | |
119 | # | |
120 | # @backing-image: #optional info of the backing image (since 1.6) | |
121 | # | |
122 | # @format-specific: #optional structure supplying additional format-specific | |
123 | # information (since 1.7) | |
124 | # | |
125 | # Since: 1.3 | |
126 | # | |
127 | ## | |
128 | ||
895a2a80 | 129 | { 'struct': 'ImageInfo', |
1ad166b6 BC |
130 | 'data': {'filename': 'str', 'format': 'str', '*dirty-flag': 'bool', |
131 | '*actual-size': 'int', 'virtual-size': 'int', | |
132 | '*cluster-size': 'int', '*encrypted': 'bool', '*compressed': 'bool', | |
133 | '*backing-filename': 'str', '*full-backing-filename': 'str', | |
134 | '*backing-filename-format': 'str', '*snapshots': ['SnapshotInfo'], | |
135 | '*backing-image': 'ImageInfo', | |
24bf10da | 136 | '*format-specific': 'ImageInfoSpecific' } } |
1ad166b6 BC |
137 | |
138 | ## | |
139 | # @ImageCheck: | |
140 | # | |
141 | # Information about a QEMU image file check | |
142 | # | |
143 | # @filename: name of the image file checked | |
144 | # | |
145 | # @format: format of the image file checked | |
146 | # | |
147 | # @check-errors: number of unexpected errors occurred during check | |
148 | # | |
149 | # @image-end-offset: #optional offset (in bytes) where the image ends, this | |
150 | # field is present if the driver for the image format | |
151 | # supports it | |
152 | # | |
153 | # @corruptions: #optional number of corruptions found during the check if any | |
154 | # | |
155 | # @leaks: #optional number of leaks found during the check if any | |
156 | # | |
157 | # @corruptions-fixed: #optional number of corruptions fixed during the check | |
158 | # if any | |
159 | # | |
160 | # @leaks-fixed: #optional number of leaks fixed during the check if any | |
161 | # | |
162 | # @total-clusters: #optional total number of clusters, this field is present | |
163 | # if the driver for the image format supports it | |
164 | # | |
165 | # @allocated-clusters: #optional total number of allocated clusters, this | |
166 | # field is present if the driver for the image format | |
167 | # supports it | |
168 | # | |
169 | # @fragmented-clusters: #optional total number of fragmented clusters, this | |
170 | # field is present if the driver for the image format | |
171 | # supports it | |
172 | # | |
173 | # @compressed-clusters: #optional total number of compressed clusters, this | |
174 | # field is present if the driver for the image format | |
175 | # supports it | |
176 | # | |
177 | # Since: 1.4 | |
178 | # | |
179 | ## | |
180 | ||
895a2a80 | 181 | { 'struct': 'ImageCheck', |
1ad166b6 BC |
182 | 'data': {'filename': 'str', 'format': 'str', 'check-errors': 'int', |
183 | '*image-end-offset': 'int', '*corruptions': 'int', '*leaks': 'int', | |
184 | '*corruptions-fixed': 'int', '*leaks-fixed': 'int', | |
185 | '*total-clusters': 'int', '*allocated-clusters': 'int', | |
186 | '*fragmented-clusters': 'int', '*compressed-clusters': 'int' } } | |
187 | ||
16b0d555 FZ |
188 | ## |
189 | # @MapEntry: | |
190 | # | |
191 | # Mapping information from a virtual block range to a host file range | |
192 | # | |
193 | # @start: the start byte of the mapped virtual range | |
194 | # | |
195 | # @length: the number of bytes of the mapped virtual range | |
196 | # | |
197 | # @data: whether the mapped range has data | |
198 | # | |
199 | # @zero: whether the virtual blocks are zeroed | |
200 | # | |
201 | # @depth: the depth of the mapping | |
202 | # | |
203 | # @offset: #optional the offset in file that the virtual sectors are mapped to | |
204 | # | |
205 | # @filename: #optional filename that is referred to by @offset | |
206 | # | |
207 | # Since: 2.6 | |
208 | # | |
209 | ## | |
210 | { 'struct': 'MapEntry', | |
211 | 'data': {'start': 'int', 'length': 'int', 'data': 'bool', | |
212 | 'zero': 'bool', 'depth': 'int', '*offset': 'int', | |
213 | '*filename': 'str' } } | |
214 | ||
9e193c5a KW |
215 | ## |
216 | # @BlockdevCacheInfo | |
217 | # | |
218 | # Cache mode information for a block device | |
219 | # | |
220 | # @writeback: true if writeback mode is enabled | |
221 | # @direct: true if the host page cache is bypassed (O_DIRECT) | |
222 | # @no-flush: true if flush requests are ignored for the device | |
223 | # | |
224 | # Since: 2.3 | |
225 | ## | |
895a2a80 | 226 | { 'struct': 'BlockdevCacheInfo', |
9e193c5a KW |
227 | 'data': { 'writeback': 'bool', |
228 | 'direct': 'bool', | |
229 | 'no-flush': 'bool' } } | |
230 | ||
1ad166b6 BC |
231 | ## |
232 | # @BlockDeviceInfo: | |
233 | # | |
234 | # Information about the backing device for a block device. | |
235 | # | |
236 | # @file: the filename of the backing device | |
237 | # | |
238 | # @node-name: #optional the name of the block driver node (Since 2.0) | |
239 | # | |
240 | # @ro: true if the backing device was open read-only | |
241 | # | |
242 | # @drv: the name of the block format used to open the backing device. As of | |
243 | # 0.14.0 this can be: 'blkdebug', 'bochs', 'cloop', 'cow', 'dmg', | |
244 | # 'file', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device', | |
f709623b | 245 | # 'http', 'https', 'nbd', 'parallels', 'qcow', |
1ad166b6 | 246 | # 'qcow2', 'raw', 'tftp', 'vdi', 'vmdk', 'vpc', 'vvfat' |
550830f9 | 247 | # 2.2: 'archipelago' added, 'cow' dropped |
92a539d2 | 248 | # 2.3: 'host_floppy' deprecated |
f709623b | 249 | # 2.5: 'host_floppy' dropped |
1ad166b6 BC |
250 | # |
251 | # @backing_file: #optional the name of the backing file (for copy-on-write) | |
252 | # | |
253 | # @backing_file_depth: number of files in the backing file chain (since: 1.2) | |
254 | # | |
255 | # @encrypted: true if the backing device is encrypted | |
256 | # | |
257 | # @encryption_key_missing: true if the backing device is encrypted but an | |
258 | # valid encryption key is missing | |
259 | # | |
260 | # @detect_zeroes: detect and optimize zero writes (Since 2.1) | |
261 | # | |
262 | # @bps: total throughput limit in bytes per second is specified | |
263 | # | |
264 | # @bps_rd: read throughput limit in bytes per second is specified | |
265 | # | |
266 | # @bps_wr: write throughput limit in bytes per second is specified | |
267 | # | |
268 | # @iops: total I/O operations per second is specified | |
269 | # | |
270 | # @iops_rd: read I/O operations per second is specified | |
271 | # | |
272 | # @iops_wr: write I/O operations per second is specified | |
273 | # | |
274 | # @image: the info of image used (since: 1.6) | |
275 | # | |
276 | # @bps_max: #optional total max in bytes (Since 1.7) | |
277 | # | |
278 | # @bps_rd_max: #optional read max in bytes (Since 1.7) | |
279 | # | |
280 | # @bps_wr_max: #optional write max in bytes (Since 1.7) | |
281 | # | |
282 | # @iops_max: #optional total I/O operations max (Since 1.7) | |
283 | # | |
284 | # @iops_rd_max: #optional read I/O operations max (Since 1.7) | |
285 | # | |
286 | # @iops_wr_max: #optional write I/O operations max (Since 1.7) | |
287 | # | |
288 | # @iops_size: #optional an I/O size in bytes (Since 1.7) | |
289 | # | |
b8fe1694 AG |
290 | # @group: #optional throttle group name (Since 2.4) |
291 | # | |
9e193c5a KW |
292 | # @cache: the cache mode used for the block device (since: 2.3) |
293 | # | |
e2462113 FR |
294 | # @write_threshold: configured write threshold for the device. |
295 | # 0 if disabled. (Since 2.3) | |
296 | # | |
1ad166b6 BC |
297 | # Since: 0.14.0 |
298 | # | |
299 | ## | |
895a2a80 | 300 | { 'struct': 'BlockDeviceInfo', |
1ad166b6 BC |
301 | 'data': { 'file': 'str', '*node-name': 'str', 'ro': 'bool', 'drv': 'str', |
302 | '*backing_file': 'str', 'backing_file_depth': 'int', | |
303 | 'encrypted': 'bool', 'encryption_key_missing': 'bool', | |
304 | 'detect_zeroes': 'BlockdevDetectZeroesOptions', | |
305 | 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int', | |
306 | 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int', | |
307 | 'image': 'ImageInfo', | |
308 | '*bps_max': 'int', '*bps_rd_max': 'int', | |
309 | '*bps_wr_max': 'int', '*iops_max': 'int', | |
310 | '*iops_rd_max': 'int', '*iops_wr_max': 'int', | |
b8fe1694 | 311 | '*iops_size': 'int', '*group': 'str', 'cache': 'BlockdevCacheInfo', |
e2462113 | 312 | 'write_threshold': 'int' } } |
1ad166b6 BC |
313 | |
314 | ## | |
315 | # @BlockDeviceIoStatus: | |
316 | # | |
317 | # An enumeration of block device I/O status. | |
318 | # | |
319 | # @ok: The last I/O operation has succeeded | |
320 | # | |
321 | # @failed: The last I/O operation has failed | |
322 | # | |
323 | # @nospace: The last I/O operation has failed due to a no-space condition | |
324 | # | |
325 | # Since: 1.0 | |
326 | ## | |
327 | { 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] } | |
328 | ||
329 | ## | |
330 | # @BlockDeviceMapEntry: | |
331 | # | |
332 | # Entry in the metadata map of the device (returned by "qemu-img map") | |
333 | # | |
334 | # @start: Offset in the image of the first byte described by this entry | |
335 | # (in bytes) | |
336 | # | |
337 | # @length: Length of the range described by this entry (in bytes) | |
338 | # | |
339 | # @depth: Number of layers (0 = top image, 1 = top image's backing file, etc.) | |
340 | # before reaching one for which the range is allocated. The value is | |
341 | # in the range 0 to the depth of the image chain - 1. | |
342 | # | |
343 | # @zero: the sectors in this range read as zeros | |
344 | # | |
345 | # @data: reading the image will actually read data from a file (in particular, | |
346 | # if @offset is present this means that the sectors are not simply | |
347 | # preallocated, but contain actual data in raw format) | |
348 | # | |
349 | # @offset: if present, the image file stores the data for this range in | |
350 | # raw format at the given offset. | |
351 | # | |
352 | # Since 1.7 | |
353 | ## | |
895a2a80 | 354 | { 'struct': 'BlockDeviceMapEntry', |
1ad166b6 BC |
355 | 'data': { 'start': 'int', 'length': 'int', 'depth': 'int', 'zero': 'bool', |
356 | 'data': 'bool', '*offset': 'int' } } | |
357 | ||
9abe3bdc JS |
358 | ## |
359 | # @DirtyBitmapStatus: | |
360 | # | |
361 | # An enumeration of possible states that a dirty bitmap can report to the user. | |
362 | # | |
363 | # @frozen: The bitmap is currently in-use by a backup operation or block job, | |
364 | # and is immutable. | |
365 | # | |
366 | # @disabled: The bitmap is currently in-use by an internal operation and is | |
367 | # read-only. It can still be deleted. | |
368 | # | |
369 | # @active: The bitmap is actively monitoring for new writes, and can be cleared, | |
370 | # deleted, or used for backup operations. | |
371 | # | |
372 | # Since: 2.4 | |
373 | ## | |
374 | { 'enum': 'DirtyBitmapStatus', | |
375 | 'data': ['active', 'disabled', 'frozen'] } | |
376 | ||
1ad166b6 BC |
377 | ## |
378 | # @BlockDirtyInfo: | |
379 | # | |
380 | # Block dirty bitmap information. | |
381 | # | |
0db6e54a FZ |
382 | # @name: #optional the name of the dirty bitmap (Since 2.4) |
383 | # | |
1ad166b6 BC |
384 | # @count: number of dirty bytes according to the dirty bitmap |
385 | # | |
386 | # @granularity: granularity of the dirty bitmap in bytes (since 1.4) | |
387 | # | |
9abe3bdc | 388 | # @status: current status of the dirty bitmap (since 2.4) |
a113534f | 389 | # |
1ad166b6 BC |
390 | # Since: 1.3 |
391 | ## | |
895a2a80 | 392 | { 'struct': 'BlockDirtyInfo', |
a113534f | 393 | 'data': {'*name': 'str', 'count': 'int', 'granularity': 'uint32', |
9abe3bdc | 394 | 'status': 'DirtyBitmapStatus'} } |
1ad166b6 BC |
395 | |
396 | ## | |
397 | # @BlockInfo: | |
398 | # | |
399 | # Block device information. This structure describes a virtual device and | |
400 | # the backing device associated with it. | |
401 | # | |
402 | # @device: The device name associated with the virtual device. | |
403 | # | |
404 | # @type: This field is returned only for compatibility reasons, it should | |
405 | # not be used (always returns 'unknown') | |
406 | # | |
407 | # @removable: True if the device supports removable media. | |
408 | # | |
409 | # @locked: True if the guest has locked this device from having its media | |
410 | # removed | |
411 | # | |
327032ce HR |
412 | # @tray_open: #optional True if the device's tray is open |
413 | # (only present if it has a tray) | |
1ad166b6 BC |
414 | # |
415 | # @dirty-bitmaps: #optional dirty bitmaps information (only present if the | |
416 | # driver has one or more dirty bitmaps) (Since 2.0) | |
417 | # | |
418 | # @io-status: #optional @BlockDeviceIoStatus. Only present if the device | |
419 | # supports it and the VM is configured to stop on errors | |
c7c2ff0c | 420 | # (supported device models: virtio-blk, ide, scsi-disk) |
1ad166b6 BC |
421 | # |
422 | # @inserted: #optional @BlockDeviceInfo describing the device if media is | |
423 | # present | |
424 | # | |
425 | # Since: 0.14.0 | |
426 | ## | |
895a2a80 | 427 | { 'struct': 'BlockInfo', |
1ad166b6 BC |
428 | 'data': {'device': 'str', 'type': 'str', 'removable': 'bool', |
429 | 'locked': 'bool', '*inserted': 'BlockDeviceInfo', | |
430 | '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus', | |
431 | '*dirty-bitmaps': ['BlockDirtyInfo'] } } | |
432 | ||
433 | ## | |
434 | # @query-block: | |
435 | # | |
436 | # Get a list of BlockInfo for all virtual block devices. | |
437 | # | |
438 | # Returns: a list of @BlockInfo describing each virtual block device | |
439 | # | |
440 | # Since: 0.14.0 | |
441 | ## | |
442 | { 'command': 'query-block', 'returns': ['BlockInfo'] } | |
443 | ||
979e9b03 AG |
444 | |
445 | ## | |
446 | # @BlockDeviceTimedStats: | |
447 | # | |
448 | # Statistics of a block device during a given interval of time. | |
449 | # | |
450 | # @interval_length: Interval used for calculating the statistics, | |
451 | # in seconds. | |
452 | # | |
453 | # @min_rd_latency_ns: Minimum latency of read operations in the | |
454 | # defined interval, in nanoseconds. | |
455 | # | |
456 | # @min_wr_latency_ns: Minimum latency of write operations in the | |
457 | # defined interval, in nanoseconds. | |
458 | # | |
459 | # @min_flush_latency_ns: Minimum latency of flush operations in the | |
460 | # defined interval, in nanoseconds. | |
461 | # | |
462 | # @max_rd_latency_ns: Maximum latency of read operations in the | |
463 | # defined interval, in nanoseconds. | |
464 | # | |
465 | # @max_wr_latency_ns: Maximum latency of write operations in the | |
466 | # defined interval, in nanoseconds. | |
467 | # | |
468 | # @max_flush_latency_ns: Maximum latency of flush operations in the | |
469 | # defined interval, in nanoseconds. | |
470 | # | |
471 | # @avg_rd_latency_ns: Average latency of read operations in the | |
472 | # defined interval, in nanoseconds. | |
473 | # | |
474 | # @avg_wr_latency_ns: Average latency of write operations in the | |
475 | # defined interval, in nanoseconds. | |
476 | # | |
477 | # @avg_flush_latency_ns: Average latency of flush operations in the | |
478 | # defined interval, in nanoseconds. | |
479 | # | |
96e4deda AG |
480 | # @avg_rd_queue_depth: Average number of pending read operations |
481 | # in the defined interval. | |
482 | # | |
483 | # @avg_wr_queue_depth: Average number of pending write operations | |
484 | # in the defined interval. | |
485 | # | |
979e9b03 AG |
486 | # Since: 2.5 |
487 | ## | |
488 | ||
489 | { 'struct': 'BlockDeviceTimedStats', | |
490 | 'data': { 'interval_length': 'int', 'min_rd_latency_ns': 'int', | |
491 | 'max_rd_latency_ns': 'int', 'avg_rd_latency_ns': 'int', | |
492 | 'min_wr_latency_ns': 'int', 'max_wr_latency_ns': 'int', | |
493 | 'avg_wr_latency_ns': 'int', 'min_flush_latency_ns': 'int', | |
96e4deda AG |
494 | 'max_flush_latency_ns': 'int', 'avg_flush_latency_ns': 'int', |
495 | 'avg_rd_queue_depth': 'number', 'avg_wr_queue_depth': 'number' } } | |
979e9b03 | 496 | |
1ad166b6 BC |
497 | ## |
498 | # @BlockDeviceStats: | |
499 | # | |
500 | # Statistics of a virtual block device or a block backing device. | |
501 | # | |
502 | # @rd_bytes: The number of bytes read by the device. | |
503 | # | |
504 | # @wr_bytes: The number of bytes written by the device. | |
505 | # | |
506 | # @rd_operations: The number of read operations performed by the device. | |
507 | # | |
508 | # @wr_operations: The number of write operations performed by the device. | |
509 | # | |
510 | # @flush_operations: The number of cache flush operations performed by the | |
511 | # device (since 0.15.0) | |
512 | # | |
513 | # @flush_total_time_ns: Total time spend on cache flushes in nano-seconds | |
514 | # (since 0.15.0). | |
515 | # | |
516 | # @wr_total_time_ns: Total time spend on writes in nano-seconds (since 0.15.0). | |
517 | # | |
518 | # @rd_total_time_ns: Total_time_spend on reads in nano-seconds (since 0.15.0). | |
519 | # | |
520 | # @wr_highest_offset: The offset after the greatest byte written to the | |
521 | # device. The intended use of this information is for | |
522 | # growable sparse files (like qcow2) that are used on top | |
523 | # of a physical device. | |
524 | # | |
f4564d53 PL |
525 | # @rd_merged: Number of read requests that have been merged into another |
526 | # request (Since 2.3). | |
527 | # | |
528 | # @wr_merged: Number of write requests that have been merged into another | |
529 | # request (Since 2.3). | |
530 | # | |
cb38fffb AG |
531 | # @idle_time_ns: #optional Time since the last I/O operation, in |
532 | # nanoseconds. If the field is absent it means that | |
533 | # there haven't been any operations yet (Since 2.5). | |
534 | # | |
7ee12daf AG |
535 | # @failed_rd_operations: The number of failed read operations |
536 | # performed by the device (Since 2.5) | |
537 | # | |
538 | # @failed_wr_operations: The number of failed write operations | |
539 | # performed by the device (Since 2.5) | |
540 | # | |
541 | # @failed_flush_operations: The number of failed flush operations | |
542 | # performed by the device (Since 2.5) | |
543 | # | |
544 | # @invalid_rd_operations: The number of invalid read operations | |
545 | # performed by the device (Since 2.5) | |
546 | # | |
547 | # @invalid_wr_operations: The number of invalid write operations | |
548 | # performed by the device (Since 2.5) | |
549 | # | |
550 | # @invalid_flush_operations: The number of invalid flush operations | |
551 | # performed by the device (Since 2.5) | |
552 | # | |
362e9299 AG |
553 | # @account_invalid: Whether invalid operations are included in the |
554 | # last access statistics (Since 2.5) | |
555 | # | |
556 | # @account_failed: Whether failed operations are included in the | |
557 | # latency and last access statistics (Since 2.5) | |
558 | # | |
979e9b03 AG |
559 | # @timed_stats: Statistics specific to the set of previously defined |
560 | # intervals of time (Since 2.5) | |
561 | # | |
1ad166b6 BC |
562 | # Since: 0.14.0 |
563 | ## | |
895a2a80 | 564 | { 'struct': 'BlockDeviceStats', |
1ad166b6 BC |
565 | 'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'rd_operations': 'int', |
566 | 'wr_operations': 'int', 'flush_operations': 'int', | |
567 | 'flush_total_time_ns': 'int', 'wr_total_time_ns': 'int', | |
f4564d53 | 568 | 'rd_total_time_ns': 'int', 'wr_highest_offset': 'int', |
7ee12daf AG |
569 | 'rd_merged': 'int', 'wr_merged': 'int', '*idle_time_ns': 'int', |
570 | 'failed_rd_operations': 'int', 'failed_wr_operations': 'int', | |
571 | 'failed_flush_operations': 'int', 'invalid_rd_operations': 'int', | |
362e9299 | 572 | 'invalid_wr_operations': 'int', 'invalid_flush_operations': 'int', |
979e9b03 AG |
573 | 'account_invalid': 'bool', 'account_failed': 'bool', |
574 | 'timed_stats': ['BlockDeviceTimedStats'] } } | |
1ad166b6 BC |
575 | |
576 | ## | |
577 | # @BlockStats: | |
578 | # | |
579 | # Statistics of a virtual block device or a block backing device. | |
580 | # | |
581 | # @device: #optional If the stats are for a virtual block device, the name | |
582 | # corresponding to the virtual block device. | |
583 | # | |
a06e4355 | 584 | # @node-name: #optional The node name of the device. (Since 2.3) |
4875a779 | 585 | # |
1ad166b6 BC |
586 | # @stats: A @BlockDeviceStats for the device. |
587 | # | |
588 | # @parent: #optional This describes the file block device if it has one. | |
589 | # | |
590 | # @backing: #optional This describes the backing block device if it has one. | |
591 | # (Since 2.0) | |
592 | # | |
593 | # Since: 0.14.0 | |
594 | ## | |
895a2a80 | 595 | { 'struct': 'BlockStats', |
4875a779 FZ |
596 | 'data': {'*device': 'str', '*node-name': 'str', |
597 | 'stats': 'BlockDeviceStats', | |
1ad166b6 BC |
598 | '*parent': 'BlockStats', |
599 | '*backing': 'BlockStats'} } | |
600 | ||
601 | ## | |
602 | # @query-blockstats: | |
603 | # | |
604 | # Query the @BlockStats for all virtual block devices. | |
605 | # | |
f71eaa74 FZ |
606 | # @query-nodes: #optional If true, the command will query all the block nodes |
607 | # that have a node name, in a list which will include "parent" | |
608 | # information, but not "backing". | |
609 | # If false or omitted, the behavior is as before - query all the | |
610 | # device backends, recursively including their "parent" and | |
611 | # "backing". (Since 2.3) | |
612 | # | |
1ad166b6 BC |
613 | # Returns: A list of @BlockStats for each virtual block devices. |
614 | # | |
615 | # Since: 0.14.0 | |
616 | ## | |
f71eaa74 FZ |
617 | { 'command': 'query-blockstats', |
618 | 'data': { '*query-nodes': 'bool' }, | |
619 | 'returns': ['BlockStats'] } | |
1ad166b6 BC |
620 | |
621 | ## | |
622 | # @BlockdevOnError: | |
623 | # | |
624 | # An enumeration of possible behaviors for errors on I/O operations. | |
625 | # The exact meaning depends on whether the I/O was initiated by a guest | |
626 | # or by a block job | |
627 | # | |
628 | # @report: for guest operations, report the error to the guest; | |
629 | # for jobs, cancel the job | |
630 | # | |
631 | # @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR | |
632 | # or BLOCK_JOB_ERROR) | |
633 | # | |
634 | # @enospc: same as @stop on ENOSPC, same as @report otherwise. | |
635 | # | |
636 | # @stop: for guest operations, stop the virtual machine; | |
637 | # for jobs, pause the job | |
638 | # | |
639 | # Since: 1.3 | |
640 | ## | |
641 | { 'enum': 'BlockdevOnError', | |
642 | 'data': ['report', 'ignore', 'enospc', 'stop'] } | |
643 | ||
644 | ## | |
645 | # @MirrorSyncMode: | |
646 | # | |
647 | # An enumeration of possible behaviors for the initial synchronization | |
648 | # phase of storage mirroring. | |
649 | # | |
650 | # @top: copies data in the topmost image to the destination | |
651 | # | |
652 | # @full: copies data from all images to the destination | |
653 | # | |
654 | # @none: only copy data written from now on | |
655 | # | |
4b80ab2b | 656 | # @incremental: only copy data described by the dirty bitmap. Since: 2.4 |
d58d8453 | 657 | # |
1ad166b6 BC |
658 | # Since: 1.3 |
659 | ## | |
660 | { 'enum': 'MirrorSyncMode', | |
4b80ab2b | 661 | 'data': ['top', 'full', 'none', 'incremental'] } |
1ad166b6 BC |
662 | |
663 | ## | |
664 | # @BlockJobType: | |
665 | # | |
666 | # Type of a block job. | |
667 | # | |
668 | # @commit: block commit job type, see "block-commit" | |
669 | # | |
670 | # @stream: block stream job type, see "block-stream" | |
671 | # | |
672 | # @mirror: drive mirror job type, see "drive-mirror" | |
673 | # | |
674 | # @backup: drive backup job type, see "drive-backup" | |
675 | # | |
676 | # Since: 1.7 | |
677 | ## | |
678 | { 'enum': 'BlockJobType', | |
679 | 'data': ['commit', 'stream', 'mirror', 'backup'] } | |
680 | ||
681 | ## | |
682 | # @BlockJobInfo: | |
683 | # | |
684 | # Information about a long-running block device operation. | |
685 | # | |
686 | # @type: the job type ('stream' for image streaming) | |
687 | # | |
688 | # @device: the block device name | |
689 | # | |
690 | # @len: the maximum progress value | |
691 | # | |
692 | # @busy: false if the job is known to be in a quiescent state, with | |
693 | # no pending I/O. Since 1.3. | |
694 | # | |
695 | # @paused: whether the job is paused or, if @busy is true, will | |
696 | # pause itself as soon as possible. Since 1.3. | |
697 | # | |
698 | # @offset: the current progress value | |
699 | # | |
700 | # @speed: the rate limit, bytes per second | |
701 | # | |
702 | # @io-status: the status of the job (since 1.3) | |
703 | # | |
ef6dbf1e HR |
704 | # @ready: true if the job may be completed (since 2.2) |
705 | # | |
1ad166b6 BC |
706 | # Since: 1.1 |
707 | ## | |
895a2a80 | 708 | { 'struct': 'BlockJobInfo', |
1ad166b6 BC |
709 | 'data': {'type': 'str', 'device': 'str', 'len': 'int', |
710 | 'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int', | |
ef6dbf1e | 711 | 'io-status': 'BlockDeviceIoStatus', 'ready': 'bool'} } |
1ad166b6 BC |
712 | |
713 | ## | |
714 | # @query-block-jobs: | |
715 | # | |
716 | # Return information about long-running block device operations. | |
717 | # | |
718 | # Returns: a list of @BlockJobInfo for each active block job | |
719 | # | |
720 | # Since: 1.1 | |
721 | ## | |
722 | { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'] } | |
723 | ||
724 | ## | |
725 | # @block_passwd: | |
726 | # | |
727 | # This command sets the password of a block device that has not been open | |
728 | # with a password and requires one. | |
729 | # | |
730 | # The two cases where this can happen are a block device is created through | |
731 | # QEMU's initial command line or a block device is changed through the legacy | |
732 | # @change interface. | |
733 | # | |
734 | # In the event that the block device is created through the initial command | |
735 | # line, the VM will start in the stopped state regardless of whether '-S' is | |
736 | # used. The intention is for a management tool to query the block devices to | |
737 | # determine which ones are encrypted, set the passwords with this command, and | |
738 | # then start the guest with the @cont command. | |
739 | # | |
740 | # Either @device or @node-name must be set but not both. | |
741 | # | |
742 | # @device: #optional the name of the block backend device to set the password on | |
743 | # | |
744 | # @node-name: #optional graph node name to set the password on (Since 2.0) | |
745 | # | |
746 | # @password: the password to use for the device | |
747 | # | |
748 | # Returns: nothing on success | |
749 | # If @device is not a valid block device, DeviceNotFound | |
750 | # If @device is not encrypted, DeviceNotEncrypted | |
751 | # | |
752 | # Notes: Not all block formats support encryption and some that do are not | |
753 | # able to validate that a password is correct. Disk corruption may | |
754 | # occur if an invalid password is specified. | |
755 | # | |
756 | # Since: 0.14.0 | |
757 | ## | |
758 | { 'command': 'block_passwd', 'data': {'*device': 'str', | |
759 | '*node-name': 'str', 'password': 'str'} } | |
760 | ||
761 | ## | |
762 | # @block_resize | |
763 | # | |
764 | # Resize a block image while a guest is running. | |
765 | # | |
766 | # Either @device or @node-name must be set but not both. | |
767 | # | |
768 | # @device: #optional the name of the device to get the image resized | |
769 | # | |
770 | # @node-name: #optional graph node name to get the image resized (Since 2.0) | |
771 | # | |
772 | # @size: new image size in bytes | |
773 | # | |
774 | # Returns: nothing on success | |
775 | # If @device is not a valid block device, DeviceNotFound | |
776 | # | |
777 | # Since: 0.14.0 | |
778 | ## | |
779 | { 'command': 'block_resize', 'data': { '*device': 'str', | |
780 | '*node-name': 'str', | |
781 | 'size': 'int' }} | |
782 | ||
783 | ## | |
784 | # @NewImageMode | |
785 | # | |
786 | # An enumeration that tells QEMU how to set the backing file path in | |
787 | # a new image file. | |
788 | # | |
789 | # @existing: QEMU should look for an existing image file. | |
790 | # | |
791 | # @absolute-paths: QEMU should create a new image with absolute paths | |
792 | # for the backing file. If there is no backing file available, the new | |
793 | # image will not be backed either. | |
794 | # | |
795 | # Since: 1.1 | |
796 | ## | |
797 | { 'enum': 'NewImageMode', | |
798 | 'data': [ 'existing', 'absolute-paths' ] } | |
799 | ||
800 | ## | |
a911e6ae | 801 | # @BlockdevSnapshotSync |
1ad166b6 BC |
802 | # |
803 | # Either @device or @node-name must be set but not both. | |
804 | # | |
805 | # @device: #optional the name of the device to generate the snapshot from. | |
806 | # | |
807 | # @node-name: #optional graph node name to generate the snapshot from (Since 2.0) | |
808 | # | |
809 | # @snapshot-file: the target of the new image. A new file will be created. | |
810 | # | |
811 | # @snapshot-node-name: #optional the graph node name of the new image (Since 2.0) | |
812 | # | |
813 | # @format: #optional the format of the snapshot image, default is 'qcow2'. | |
814 | # | |
815 | # @mode: #optional whether and how QEMU should create a new image, default is | |
816 | # 'absolute-paths'. | |
817 | ## | |
a911e6ae | 818 | { 'struct': 'BlockdevSnapshotSync', |
1ad166b6 BC |
819 | 'data': { '*device': 'str', '*node-name': 'str', |
820 | 'snapshot-file': 'str', '*snapshot-node-name': 'str', | |
821 | '*format': 'str', '*mode': 'NewImageMode' } } | |
822 | ||
43de7e2d AG |
823 | ## |
824 | # @BlockdevSnapshot | |
825 | # | |
826 | # @node: device or node name that will have a snapshot created. | |
827 | # | |
828 | # @overlay: reference to the existing block device that will become | |
829 | # the overlay of @node, as part of creating the snapshot. | |
830 | # It must not have a current backing file (this can be | |
831 | # achieved by passing "backing": "" to blockdev-add). | |
832 | # | |
833 | # Since 2.5 | |
834 | ## | |
835 | { 'struct': 'BlockdevSnapshot', | |
836 | 'data': { 'node': 'str', 'overlay': 'str' } } | |
837 | ||
1ad166b6 BC |
838 | ## |
839 | # @DriveBackup | |
840 | # | |
841 | # @device: the name of the device which should be copied. | |
842 | # | |
843 | # @target: the target of the new image. If the file exists, or if it | |
844 | # is a device, the existing file/device will be used as the new | |
845 | # destination. If it does not exist, a new file will be created. | |
846 | # | |
847 | # @format: #optional the format of the new destination, default is to | |
848 | # probe if @mode is 'existing', else the format of the source | |
849 | # | |
850 | # @sync: what parts of the disk image should be copied to the destination | |
d58d8453 JS |
851 | # (all the disk, only the sectors allocated in the topmost image, from a |
852 | # dirty bitmap, or only new I/O). | |
1ad166b6 BC |
853 | # |
854 | # @mode: #optional whether and how QEMU should create a new image, default is | |
855 | # 'absolute-paths'. | |
856 | # | |
857 | # @speed: #optional the maximum speed, in bytes per second | |
858 | # | |
4b80ab2b JS |
859 | # @bitmap: #optional the name of dirty bitmap if sync is "incremental". |
860 | # Must be present if sync is "incremental", must NOT be present | |
d58d8453 JS |
861 | # otherwise. (Since 2.4) |
862 | # | |
1ad166b6 BC |
863 | # @on-source-error: #optional the action to take on an error on the source, |
864 | # default 'report'. 'stop' and 'enospc' can only be used | |
865 | # if the block device supports io-status (see BlockInfo). | |
866 | # | |
867 | # @on-target-error: #optional the action to take on an error on the target, | |
868 | # default 'report' (no limitations, since this applies to | |
869 | # a different block device than @device). | |
870 | # | |
871 | # Note that @on-source-error and @on-target-error only affect background I/O. | |
872 | # If an error occurs during a guest write request, the device's rerror/werror | |
873 | # actions will be used. | |
874 | # | |
875 | # Since: 1.6 | |
876 | ## | |
895a2a80 | 877 | { 'struct': 'DriveBackup', |
1ad166b6 BC |
878 | 'data': { 'device': 'str', 'target': 'str', '*format': 'str', |
879 | 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode', | |
d58d8453 | 880 | '*speed': 'int', '*bitmap': 'str', |
1ad166b6 BC |
881 | '*on-source-error': 'BlockdevOnError', |
882 | '*on-target-error': 'BlockdevOnError' } } | |
883 | ||
c29c1dd3 FZ |
884 | ## |
885 | # @BlockdevBackup | |
886 | # | |
887 | # @device: the name of the device which should be copied. | |
888 | # | |
889 | # @target: the name of the backup target device. | |
890 | # | |
891 | # @sync: what parts of the disk image should be copied to the destination | |
892 | # (all the disk, only the sectors allocated in the topmost image, or | |
893 | # only new I/O). | |
894 | # | |
895 | # @speed: #optional the maximum speed, in bytes per second. The default is 0, | |
896 | # for unlimited. | |
897 | # | |
898 | # @on-source-error: #optional the action to take on an error on the source, | |
899 | # default 'report'. 'stop' and 'enospc' can only be used | |
900 | # if the block device supports io-status (see BlockInfo). | |
901 | # | |
902 | # @on-target-error: #optional the action to take on an error on the target, | |
903 | # default 'report' (no limitations, since this applies to | |
904 | # a different block device than @device). | |
905 | # | |
906 | # Note that @on-source-error and @on-target-error only affect background I/O. | |
907 | # If an error occurs during a guest write request, the device's rerror/werror | |
908 | # actions will be used. | |
909 | # | |
910 | # Since: 2.3 | |
911 | ## | |
895a2a80 | 912 | { 'struct': 'BlockdevBackup', |
c29c1dd3 FZ |
913 | 'data': { 'device': 'str', 'target': 'str', |
914 | 'sync': 'MirrorSyncMode', | |
915 | '*speed': 'int', | |
916 | '*on-source-error': 'BlockdevOnError', | |
917 | '*on-target-error': 'BlockdevOnError' } } | |
918 | ||
1ad166b6 BC |
919 | ## |
920 | # @blockdev-snapshot-sync | |
921 | # | |
922 | # Generates a synchronous snapshot of a block device. | |
923 | # | |
a911e6ae | 924 | # For the arguments, see the documentation of BlockdevSnapshotSync. |
1ad166b6 BC |
925 | # |
926 | # Returns: nothing on success | |
927 | # If @device is not a valid block device, DeviceNotFound | |
928 | # | |
929 | # Since 0.14.0 | |
930 | ## | |
931 | { 'command': 'blockdev-snapshot-sync', | |
a911e6ae | 932 | 'data': 'BlockdevSnapshotSync' } |
1ad166b6 | 933 | |
43de7e2d AG |
934 | |
935 | ## | |
936 | # @blockdev-snapshot | |
937 | # | |
938 | # Generates a snapshot of a block device. | |
939 | # | |
940 | # For the arguments, see the documentation of BlockdevSnapshot. | |
941 | # | |
942 | # Since 2.5 | |
943 | ## | |
944 | { 'command': 'blockdev-snapshot', | |
945 | 'data': 'BlockdevSnapshot' } | |
946 | ||
fa40e656 JC |
947 | ## |
948 | # @change-backing-file | |
949 | # | |
950 | # Change the backing file in the image file metadata. This does not | |
951 | # cause QEMU to reopen the image file to reparse the backing filename | |
952 | # (it may, however, perform a reopen to change permissions from | |
953 | # r/o -> r/w -> r/o, if needed). The new backing file string is written | |
954 | # into the image file metadata, and the QEMU internal strings are | |
955 | # updated. | |
956 | # | |
957 | # @image-node-name: The name of the block driver state node of the | |
958 | # image to modify. | |
959 | # | |
960 | # @device: The name of the device that owns image-node-name. | |
961 | # | |
962 | # @backing-file: The string to write as the backing file. This | |
963 | # string is not validated, so care should be taken | |
964 | # when specifying the string or the image chain may | |
965 | # not be able to be reopened again. | |
966 | # | |
967 | # Since: 2.1 | |
968 | ## | |
969 | { 'command': 'change-backing-file', | |
970 | 'data': { 'device': 'str', 'image-node-name': 'str', | |
971 | 'backing-file': 'str' } } | |
972 | ||
1ad166b6 BC |
973 | ## |
974 | # @block-commit | |
975 | # | |
976 | # Live commit of data from overlay image nodes into backing nodes - i.e., | |
977 | # writes data between 'top' and 'base' into 'base'. | |
978 | # | |
979 | # @device: the name of the device | |
980 | # | |
981 | # @base: #optional The file name of the backing image to write data into. | |
982 | # If not specified, this is the deepest backing image | |
983 | # | |
7676e2c5 JC |
984 | # @top: #optional The file name of the backing image within the image chain, |
985 | # which contains the topmost data to be committed down. If | |
986 | # not specified, this is the active layer. | |
1ad166b6 | 987 | # |
54e26900 JC |
988 | # @backing-file: #optional The backing file string to write into the overlay |
989 | # image of 'top'. If 'top' is the active layer, | |
990 | # specifying a backing file string is an error. This | |
991 | # filename is not validated. | |
992 | # | |
993 | # If a pathname string is such that it cannot be | |
994 | # resolved by QEMU, that means that subsequent QMP or | |
995 | # HMP commands must use node-names for the image in | |
996 | # question, as filename lookup methods will fail. | |
997 | # | |
998 | # If not specified, QEMU will automatically determine | |
999 | # the backing file string to use, or error out if | |
1000 | # there is no obvious choice. Care should be taken | |
1001 | # when specifying the string, to specify a valid | |
1002 | # filename or protocol. | |
1003 | # (Since 2.1) | |
1004 | # | |
1ad166b6 BC |
1005 | # If top == base, that is an error. |
1006 | # If top == active, the job will not be completed by itself, | |
1007 | # user needs to complete the job with the block-job-complete | |
1008 | # command after getting the ready event. (Since 2.0) | |
1009 | # | |
1010 | # If the base image is smaller than top, then the base image | |
1011 | # will be resized to be the same size as top. If top is | |
1012 | # smaller than the base image, the base will not be | |
1013 | # truncated. If you want the base image size to match the | |
1014 | # size of the smaller top, you can safely truncate it | |
1015 | # yourself once the commit operation successfully completes. | |
1016 | # | |
1ad166b6 BC |
1017 | # @speed: #optional the maximum speed, in bytes per second |
1018 | # | |
1019 | # Returns: Nothing on success | |
1020 | # If commit or stream is already active on this device, DeviceInUse | |
1021 | # If @device does not exist, DeviceNotFound | |
1022 | # If image commit is not supported by this device, NotSupported | |
1023 | # If @base or @top is invalid, a generic error is returned | |
1024 | # If @speed is invalid, InvalidParameter | |
1025 | # | |
1026 | # Since: 1.3 | |
1027 | # | |
1028 | ## | |
1029 | { 'command': 'block-commit', | |
7676e2c5 | 1030 | 'data': { 'device': 'str', '*base': 'str', '*top': 'str', |
54e26900 | 1031 | '*backing-file': 'str', '*speed': 'int' } } |
1ad166b6 BC |
1032 | |
1033 | ## | |
1034 | # @drive-backup | |
1035 | # | |
1036 | # Start a point-in-time copy of a block device to a new destination. The | |
1037 | # status of ongoing drive-backup operations can be checked with | |
1038 | # query-block-jobs where the BlockJobInfo.type field has the value 'backup'. | |
1039 | # The operation can be stopped before it has completed using the | |
1040 | # block-job-cancel command. | |
1041 | # | |
1042 | # For the arguments, see the documentation of DriveBackup. | |
1043 | # | |
1044 | # Returns: nothing on success | |
1045 | # If @device is not a valid block device, DeviceNotFound | |
1046 | # | |
1047 | # Since 1.6 | |
1048 | ## | |
1049 | { 'command': 'drive-backup', 'data': 'DriveBackup' } | |
1050 | ||
c29c1dd3 FZ |
1051 | ## |
1052 | # @blockdev-backup | |
1053 | # | |
1054 | # Start a point-in-time copy of a block device to a new destination. The | |
1055 | # status of ongoing blockdev-backup operations can be checked with | |
1056 | # query-block-jobs where the BlockJobInfo.type field has the value 'backup'. | |
1057 | # The operation can be stopped before it has completed using the | |
1058 | # block-job-cancel command. | |
1059 | # | |
1060 | # For the arguments, see the documentation of BlockdevBackup. | |
1061 | # | |
c29c1dd3 FZ |
1062 | # Since 2.3 |
1063 | ## | |
1064 | { 'command': 'blockdev-backup', 'data': 'BlockdevBackup' } | |
1065 | ||
1066 | ||
1ad166b6 BC |
1067 | ## |
1068 | # @query-named-block-nodes | |
1069 | # | |
1070 | # Get the named block driver list | |
1071 | # | |
1072 | # Returns: the list of BlockDeviceInfo | |
1073 | # | |
1074 | # Since 2.0 | |
1075 | ## | |
1076 | { 'command': 'query-named-block-nodes', 'returns': [ 'BlockDeviceInfo' ] } | |
1077 | ||
1078 | ## | |
1079 | # @drive-mirror | |
1080 | # | |
1081 | # Start mirroring a block device's writes to a new destination. | |
1082 | # | |
1083 | # @device: the name of the device whose writes should be mirrored. | |
1084 | # | |
1085 | # @target: the target of the new image. If the file exists, or if it | |
1086 | # is a device, the existing file/device will be used as the new | |
1087 | # destination. If it does not exist, a new file will be created. | |
1088 | # | |
1089 | # @format: #optional the format of the new destination, default is to | |
1090 | # probe if @mode is 'existing', else the format of the source | |
1091 | # | |
4c828dc6 BC |
1092 | # @node-name: #optional the new block driver state node name in the graph |
1093 | # (Since 2.1) | |
1094 | # | |
09158f00 BC |
1095 | # @replaces: #optional with sync=full graph node name to be replaced by the new |
1096 | # image when a whole image copy is done. This can be used to repair | |
1097 | # broken Quorum files. (Since 2.1) | |
1098 | # | |
1ad166b6 BC |
1099 | # @mode: #optional whether and how QEMU should create a new image, default is |
1100 | # 'absolute-paths'. | |
1101 | # | |
1102 | # @speed: #optional the maximum speed, in bytes per second | |
1103 | # | |
1104 | # @sync: what parts of the disk image should be copied to the destination | |
1105 | # (all the disk, only the sectors allocated in the topmost image, or | |
1106 | # only new I/O). | |
1107 | # | |
1108 | # @granularity: #optional granularity of the dirty bitmap, default is 64K | |
1109 | # if the image format doesn't have clusters, 4K if the clusters | |
1110 | # are smaller than that, else the cluster size. Must be a | |
1111 | # power of 2 between 512 and 64M (since 1.4). | |
1112 | # | |
1113 | # @buf-size: #optional maximum amount of data in flight from source to | |
1114 | # target (since 1.4). | |
1115 | # | |
1116 | # @on-source-error: #optional the action to take on an error on the source, | |
1117 | # default 'report'. 'stop' and 'enospc' can only be used | |
1118 | # if the block device supports io-status (see BlockInfo). | |
1119 | # | |
1120 | # @on-target-error: #optional the action to take on an error on the target, | |
1121 | # default 'report' (no limitations, since this applies to | |
1122 | # a different block device than @device). | |
0fc9f8ea FZ |
1123 | # @unmap: #optional Whether to try to unmap target sectors where source has |
1124 | # only zero. If true, and target unallocated sectors will read as zero, | |
1125 | # target image sectors will be unmapped; otherwise, zeroes will be | |
1126 | # written. Both will result in identical contents. | |
1127 | # Default is true. (Since 2.4) | |
1ad166b6 BC |
1128 | # |
1129 | # Returns: nothing on success | |
1130 | # If @device is not a valid block device, DeviceNotFound | |
1131 | # | |
1132 | # Since 1.3 | |
1133 | ## | |
1134 | { 'command': 'drive-mirror', | |
1135 | 'data': { 'device': 'str', 'target': 'str', '*format': 'str', | |
09158f00 | 1136 | '*node-name': 'str', '*replaces': 'str', |
1ad166b6 BC |
1137 | 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode', |
1138 | '*speed': 'int', '*granularity': 'uint32', | |
1139 | '*buf-size': 'int', '*on-source-error': 'BlockdevOnError', | |
0fc9f8ea FZ |
1140 | '*on-target-error': 'BlockdevOnError', |
1141 | '*unmap': 'bool' } } | |
1ad166b6 | 1142 | |
341ebc2f JS |
1143 | ## |
1144 | # @BlockDirtyBitmap | |
1145 | # | |
1146 | # @node: name of device/node which the bitmap is tracking | |
1147 | # | |
1148 | # @name: name of the dirty bitmap | |
1149 | # | |
1150 | # Since 2.4 | |
1151 | ## | |
895a2a80 | 1152 | { 'struct': 'BlockDirtyBitmap', |
341ebc2f JS |
1153 | 'data': { 'node': 'str', 'name': 'str' } } |
1154 | ||
1155 | ## | |
1156 | # @BlockDirtyBitmapAdd | |
1157 | # | |
1158 | # @node: name of device/node which the bitmap is tracking | |
1159 | # | |
1160 | # @name: name of the dirty bitmap | |
1161 | # | |
1162 | # @granularity: #optional the bitmap granularity, default is 64k for | |
1163 | # block-dirty-bitmap-add | |
1164 | # | |
1165 | # Since 2.4 | |
1166 | ## | |
895a2a80 | 1167 | { 'struct': 'BlockDirtyBitmapAdd', |
341ebc2f JS |
1168 | 'data': { 'node': 'str', 'name': 'str', '*granularity': 'uint32' } } |
1169 | ||
1170 | ## | |
1171 | # @block-dirty-bitmap-add | |
1172 | # | |
1173 | # Create a dirty bitmap with a name on the node | |
1174 | # | |
1175 | # Returns: nothing on success | |
1176 | # If @node is not a valid block device or node, DeviceNotFound | |
1177 | # If @name is already taken, GenericError with an explanation | |
1178 | # | |
1179 | # Since 2.4 | |
1180 | ## | |
1181 | { 'command': 'block-dirty-bitmap-add', | |
1182 | 'data': 'BlockDirtyBitmapAdd' } | |
1183 | ||
1184 | ## | |
1185 | # @block-dirty-bitmap-remove | |
1186 | # | |
1187 | # Remove a dirty bitmap on the node | |
1188 | # | |
1189 | # Returns: nothing on success | |
1190 | # If @node is not a valid block device or node, DeviceNotFound | |
1191 | # If @name is not found, GenericError with an explanation | |
9bd2b08f | 1192 | # if @name is frozen by an operation, GenericError |
341ebc2f JS |
1193 | # |
1194 | # Since 2.4 | |
1195 | ## | |
1196 | { 'command': 'block-dirty-bitmap-remove', | |
1197 | 'data': 'BlockDirtyBitmap' } | |
1198 | ||
e74e6b78 JS |
1199 | ## |
1200 | # @block-dirty-bitmap-clear | |
1201 | # | |
1202 | # Clear (reset) a dirty bitmap on the device | |
1203 | # | |
1204 | # Returns: nothing on success | |
1205 | # If @node is not a valid block device, DeviceNotFound | |
1206 | # If @name is not found, GenericError with an explanation | |
1207 | # | |
1208 | # Since 2.4 | |
1209 | ## | |
1210 | { 'command': 'block-dirty-bitmap-clear', | |
1211 | 'data': 'BlockDirtyBitmap' } | |
1212 | ||
df92562e FZ |
1213 | ## |
1214 | # @blockdev-mirror | |
1215 | # | |
1216 | # Start mirroring a block device's writes to a new destination. | |
1217 | # | |
1218 | # @device: the name of the device whose writes should be mirrored. | |
1219 | # | |
1220 | # @target: the id or node-name of the block device to mirror to. This mustn't be | |
1221 | # attached to guest. | |
1222 | # | |
1223 | # @replaces: #optional with sync=full graph node name to be replaced by the new | |
1224 | # image when a whole image copy is done. This can be used to repair | |
1225 | # broken Quorum files. | |
1226 | # | |
1227 | # @speed: #optional the maximum speed, in bytes per second | |
1228 | # | |
1229 | # @sync: what parts of the disk image should be copied to the destination | |
1230 | # (all the disk, only the sectors allocated in the topmost image, or | |
1231 | # only new I/O). | |
1232 | # | |
1233 | # @granularity: #optional granularity of the dirty bitmap, default is 64K | |
1234 | # if the image format doesn't have clusters, 4K if the clusters | |
1235 | # are smaller than that, else the cluster size. Must be a | |
1236 | # power of 2 between 512 and 64M | |
1237 | # | |
1238 | # @buf-size: #optional maximum amount of data in flight from source to | |
1239 | # target | |
1240 | # | |
1241 | # @on-source-error: #optional the action to take on an error on the source, | |
1242 | # default 'report'. 'stop' and 'enospc' can only be used | |
1243 | # if the block device supports io-status (see BlockInfo). | |
1244 | # | |
1245 | # @on-target-error: #optional the action to take on an error on the target, | |
1246 | # default 'report' (no limitations, since this applies to | |
1247 | # a different block device than @device). | |
1248 | # | |
1249 | # Returns: nothing on success. | |
1250 | # | |
1251 | # Since 2.6 | |
1252 | ## | |
1253 | { 'command': 'blockdev-mirror', | |
1254 | 'data': { 'device': 'str', 'target': 'str', | |
1255 | '*replaces': 'str', | |
1256 | 'sync': 'MirrorSyncMode', | |
1257 | '*speed': 'int', '*granularity': 'uint32', | |
1258 | '*buf-size': 'int', '*on-source-error': 'BlockdevOnError', | |
1259 | '*on-target-error': 'BlockdevOnError' } } | |
1260 | ||
1ad166b6 BC |
1261 | ## |
1262 | # @block_set_io_throttle: | |
1263 | # | |
1264 | # Change I/O throttle limits for a block drive. | |
1265 | # | |
76f4afb4 AG |
1266 | # Since QEMU 2.4, each device with I/O limits is member of a throttle |
1267 | # group. | |
1268 | # | |
1269 | # If two or more devices are members of the same group, the limits | |
1270 | # will apply to the combined I/O of the whole group in a round-robin | |
1271 | # fashion. Therefore, setting new I/O limits to a device will affect | |
1272 | # the whole group. | |
1273 | # | |
1274 | # The name of the group can be specified using the 'group' parameter. | |
1275 | # If the parameter is unset, it is assumed to be the current group of | |
1276 | # that device. If it's not in any group yet, the name of the device | |
1277 | # will be used as the name for its group. | |
1278 | # | |
1279 | # The 'group' parameter can also be used to move a device to a | |
1280 | # different group. In this case the limits specified in the parameters | |
1281 | # will be applied to the new group only. | |
1282 | # | |
1283 | # I/O limits can be disabled by setting all of them to 0. In this case | |
1284 | # the device will be removed from its group and the rest of its | |
6b932c0a | 1285 | # members will not be affected. The 'group' parameter is ignored. |
76f4afb4 | 1286 | # |
1ad166b6 BC |
1287 | # @device: The name of the device |
1288 | # | |
1289 | # @bps: total throughput limit in bytes per second | |
1290 | # | |
1291 | # @bps_rd: read throughput limit in bytes per second | |
1292 | # | |
1293 | # @bps_wr: write throughput limit in bytes per second | |
1294 | # | |
1295 | # @iops: total I/O operations per second | |
1296 | # | |
1297 | # @ops_rd: read I/O operations per second | |
1298 | # | |
1299 | # @iops_wr: write I/O operations per second | |
1300 | # | |
dce13204 AG |
1301 | # @bps_max: #optional total throughput limit during bursts, |
1302 | # in bytes (Since 1.7) | |
1ad166b6 | 1303 | # |
dce13204 AG |
1304 | # @bps_rd_max: #optional read throughput limit during bursts, |
1305 | # in bytes (Since 1.7) | |
1ad166b6 | 1306 | # |
dce13204 AG |
1307 | # @bps_wr_max: #optional write throughput limit during bursts, |
1308 | # in bytes (Since 1.7) | |
1ad166b6 | 1309 | # |
dce13204 AG |
1310 | # @iops_max: #optional total I/O operations per second during bursts, |
1311 | # in bytes (Since 1.7) | |
1ad166b6 | 1312 | # |
dce13204 AG |
1313 | # @iops_rd_max: #optional read I/O operations per second during bursts, |
1314 | # in bytes (Since 1.7) | |
1ad166b6 | 1315 | # |
dce13204 AG |
1316 | # @iops_wr_max: #optional write I/O operations per second during bursts, |
1317 | # in bytes (Since 1.7) | |
1318 | # | |
1319 | # @bps_max_length: #optional maximum length of the @bps_max burst | |
1320 | # period, in seconds. It must only | |
1321 | # be set if @bps_max is set as well. | |
1322 | # Defaults to 1. (Since 2.6) | |
1323 | # | |
1324 | # @bps_rd_max_length: #optional maximum length of the @bps_rd_max | |
1325 | # burst period, in seconds. It must only | |
1326 | # be set if @bps_rd_max is set as well. | |
1327 | # Defaults to 1. (Since 2.6) | |
1328 | # | |
1329 | # @bps_wr_max_length: #optional maximum length of the @bps_wr_max | |
1330 | # burst period, in seconds. It must only | |
1331 | # be set if @bps_wr_max is set as well. | |
1332 | # Defaults to 1. (Since 2.6) | |
1333 | # | |
1334 | # @iops_max_length: #optional maximum length of the @iops burst | |
1335 | # period, in seconds. It must only | |
1336 | # be set if @iops_max is set as well. | |
1337 | # Defaults to 1. (Since 2.6) | |
1338 | # | |
1339 | # @iops_rd_max_length: #optional maximum length of the @iops_rd_max | |
1340 | # burst period, in seconds. It must only | |
1341 | # be set if @iops_rd_max is set as well. | |
1342 | # Defaults to 1. (Since 2.6) | |
1343 | # | |
1344 | # @iops_wr_max_length: #optional maximum length of the @iops_wr_max | |
1345 | # burst period, in seconds. It must only | |
1346 | # be set if @iops_wr_max is set as well. | |
1347 | # Defaults to 1. (Since 2.6) | |
1ad166b6 BC |
1348 | # |
1349 | # @iops_size: #optional an I/O size in bytes (Since 1.7) | |
1350 | # | |
76f4afb4 AG |
1351 | # @group: #optional throttle group name (Since 2.4) |
1352 | # | |
1ad166b6 BC |
1353 | # Returns: Nothing on success |
1354 | # If @device is not a valid block device, DeviceNotFound | |
1355 | # | |
1356 | # Since: 1.1 | |
1357 | ## | |
1358 | { 'command': 'block_set_io_throttle', | |
1359 | 'data': { 'device': 'str', 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int', | |
1360 | 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int', | |
1361 | '*bps_max': 'int', '*bps_rd_max': 'int', | |
1362 | '*bps_wr_max': 'int', '*iops_max': 'int', | |
1363 | '*iops_rd_max': 'int', '*iops_wr_max': 'int', | |
dce13204 AG |
1364 | '*bps_max_length': 'int', '*bps_rd_max_length': 'int', |
1365 | '*bps_wr_max_length': 'int', '*iops_max_length': 'int', | |
1366 | '*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int', | |
76f4afb4 | 1367 | '*iops_size': 'int', '*group': 'str' } } |
1ad166b6 BC |
1368 | |
1369 | ## | |
1370 | # @block-stream: | |
1371 | # | |
1372 | # Copy data from a backing file into a block device. | |
1373 | # | |
1374 | # The block streaming operation is performed in the background until the entire | |
1375 | # backing file has been copied. This command returns immediately once streaming | |
1376 | # has started. The status of ongoing block streaming operations can be checked | |
1377 | # with query-block-jobs. The operation can be stopped before it has completed | |
1378 | # using the block-job-cancel command. | |
1379 | # | |
1380 | # If a base file is specified then sectors are not copied from that base file and | |
1381 | # its backing chain. When streaming completes the image file will have the base | |
1382 | # file as its backing file. This can be used to stream a subset of the backing | |
1383 | # file chain instead of flattening the entire image. | |
1384 | # | |
1385 | # On successful completion the image file is updated to drop the backing file | |
1386 | # and the BLOCK_JOB_COMPLETED event is emitted. | |
1387 | # | |
1388 | # @device: the device name | |
1389 | # | |
1390 | # @base: #optional the common backing file name | |
1391 | # | |
13d8cc51 JC |
1392 | # @backing-file: #optional The backing file string to write into the active |
1393 | # layer. This filename is not validated. | |
1394 | # | |
1395 | # If a pathname string is such that it cannot be | |
1396 | # resolved by QEMU, that means that subsequent QMP or | |
1397 | # HMP commands must use node-names for the image in | |
1398 | # question, as filename lookup methods will fail. | |
1399 | # | |
1400 | # If not specified, QEMU will automatically determine | |
1401 | # the backing file string to use, or error out if there | |
1402 | # is no obvious choice. Care should be taken when | |
1403 | # specifying the string, to specify a valid filename or | |
1404 | # protocol. | |
1405 | # (Since 2.1) | |
1406 | # | |
1ad166b6 BC |
1407 | # @speed: #optional the maximum speed, in bytes per second |
1408 | # | |
1409 | # @on-error: #optional the action to take on an error (default report). | |
1410 | # 'stop' and 'enospc' can only be used if the block device | |
1411 | # supports io-status (see BlockInfo). Since 1.3. | |
1412 | # | |
1413 | # Returns: Nothing on success | |
1414 | # If @device does not exist, DeviceNotFound | |
1415 | # | |
1416 | # Since: 1.1 | |
1417 | ## | |
1418 | { 'command': 'block-stream', | |
13d8cc51 JC |
1419 | 'data': { 'device': 'str', '*base': 'str', '*backing-file': 'str', |
1420 | '*speed': 'int', '*on-error': 'BlockdevOnError' } } | |
1ad166b6 BC |
1421 | |
1422 | ## | |
1423 | # @block-job-set-speed: | |
1424 | # | |
1425 | # Set maximum speed for a background block operation. | |
1426 | # | |
1427 | # This command can only be issued when there is an active block job. | |
1428 | # | |
1429 | # Throttling can be disabled by setting the speed to 0. | |
1430 | # | |
1431 | # @device: the device name | |
1432 | # | |
1433 | # @speed: the maximum speed, in bytes per second, or 0 for unlimited. | |
1434 | # Defaults to 0. | |
1435 | # | |
1436 | # Returns: Nothing on success | |
1437 | # If no background operation is active on this device, DeviceNotActive | |
1438 | # | |
1439 | # Since: 1.1 | |
1440 | ## | |
1441 | { 'command': 'block-job-set-speed', | |
1442 | 'data': { 'device': 'str', 'speed': 'int' } } | |
1443 | ||
1444 | ## | |
1445 | # @block-job-cancel: | |
1446 | # | |
1447 | # Stop an active background block operation. | |
1448 | # | |
1449 | # This command returns immediately after marking the active background block | |
1450 | # operation for cancellation. It is an error to call this command if no | |
1451 | # operation is in progress. | |
1452 | # | |
1453 | # The operation will cancel as soon as possible and then emit the | |
1454 | # BLOCK_JOB_CANCELLED event. Before that happens the job is still visible when | |
1455 | # enumerated using query-block-jobs. | |
1456 | # | |
1457 | # For streaming, the image file retains its backing file unless the streaming | |
1458 | # operation happens to complete just as it is being cancelled. A new streaming | |
1459 | # operation can be started at a later time to finish copying all data from the | |
1460 | # backing file. | |
1461 | # | |
1462 | # @device: the device name | |
1463 | # | |
1464 | # @force: #optional whether to allow cancellation of a paused job (default | |
1465 | # false). Since 1.3. | |
1466 | # | |
1467 | # Returns: Nothing on success | |
1468 | # If no background operation is active on this device, DeviceNotActive | |
1469 | # | |
1470 | # Since: 1.1 | |
1471 | ## | |
1472 | { 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' } } | |
1473 | ||
1474 | ## | |
1475 | # @block-job-pause: | |
1476 | # | |
1477 | # Pause an active background block operation. | |
1478 | # | |
1479 | # This command returns immediately after marking the active background block | |
1480 | # operation for pausing. It is an error to call this command if no | |
1481 | # operation is in progress. Pausing an already paused job has no cumulative | |
1482 | # effect; a single block-job-resume command will resume the job. | |
1483 | # | |
1484 | # The operation will pause as soon as possible. No event is emitted when | |
1485 | # the operation is actually paused. Cancelling a paused job automatically | |
1486 | # resumes it. | |
1487 | # | |
1488 | # @device: the device name | |
1489 | # | |
1490 | # Returns: Nothing on success | |
1491 | # If no background operation is active on this device, DeviceNotActive | |
1492 | # | |
1493 | # Since: 1.3 | |
1494 | ## | |
1495 | { 'command': 'block-job-pause', 'data': { 'device': 'str' } } | |
1496 | ||
1497 | ## | |
1498 | # @block-job-resume: | |
1499 | # | |
1500 | # Resume an active background block operation. | |
1501 | # | |
1502 | # This command returns immediately after resuming a paused background block | |
1503 | # operation. It is an error to call this command if no operation is in | |
1504 | # progress. Resuming an already running job is not an error. | |
1505 | # | |
1506 | # This command also clears the error status of the job. | |
1507 | # | |
1508 | # @device: the device name | |
1509 | # | |
1510 | # Returns: Nothing on success | |
1511 | # If no background operation is active on this device, DeviceNotActive | |
1512 | # | |
1513 | # Since: 1.3 | |
1514 | ## | |
1515 | { 'command': 'block-job-resume', 'data': { 'device': 'str' } } | |
1516 | ||
1517 | ## | |
1518 | # @block-job-complete: | |
1519 | # | |
1520 | # Manually trigger completion of an active background block operation. This | |
1521 | # is supported for drive mirroring, where it also switches the device to | |
1522 | # write to the target path only. The ability to complete is signaled with | |
1523 | # a BLOCK_JOB_READY event. | |
1524 | # | |
1525 | # This command completes an active background block operation synchronously. | |
1526 | # The ordering of this command's return with the BLOCK_JOB_COMPLETED event | |
1527 | # is not defined. Note that if an I/O error occurs during the processing of | |
1528 | # this command: 1) the command itself will fail; 2) the error will be processed | |
1529 | # according to the rerror/werror arguments that were specified when starting | |
1530 | # the operation. | |
1531 | # | |
1532 | # A cancelled or paused job cannot be completed. | |
1533 | # | |
1534 | # @device: the device name | |
1535 | # | |
1536 | # Returns: Nothing on success | |
1537 | # If no background operation is active on this device, DeviceNotActive | |
1538 | # | |
1539 | # Since: 1.3 | |
1540 | ## | |
1541 | { 'command': 'block-job-complete', 'data': { 'device': 'str' } } | |
1542 | ||
1543 | ## | |
1544 | # @BlockdevDiscardOptions | |
1545 | # | |
1546 | # Determines how to handle discard requests. | |
1547 | # | |
1548 | # @ignore: Ignore the request | |
1549 | # @unmap: Forward as an unmap request | |
1550 | # | |
1551 | # Since: 1.7 | |
1552 | ## | |
1553 | { 'enum': 'BlockdevDiscardOptions', | |
1554 | 'data': [ 'ignore', 'unmap' ] } | |
1555 | ||
1556 | ## | |
1557 | # @BlockdevDetectZeroesOptions | |
1558 | # | |
1559 | # Describes the operation mode for the automatic conversion of plain | |
1560 | # zero writes by the OS to driver specific optimized zero write commands. | |
1561 | # | |
1562 | # @off: Disabled (default) | |
1563 | # @on: Enabled | |
1564 | # @unmap: Enabled and even try to unmap blocks if possible. This requires | |
1565 | # also that @BlockdevDiscardOptions is set to unmap for this device. | |
1566 | # | |
1567 | # Since: 2.1 | |
1568 | ## | |
1569 | { 'enum': 'BlockdevDetectZeroesOptions', | |
1570 | 'data': [ 'off', 'on', 'unmap' ] } | |
1571 | ||
1572 | ## | |
1573 | # @BlockdevAioOptions | |
1574 | # | |
1575 | # Selects the AIO backend to handle I/O requests | |
1576 | # | |
1577 | # @threads: Use qemu's thread pool | |
1578 | # @native: Use native AIO backend (only Linux and Windows) | |
1579 | # | |
1580 | # Since: 1.7 | |
1581 | ## | |
1582 | { 'enum': 'BlockdevAioOptions', | |
1583 | 'data': [ 'threads', 'native' ] } | |
1584 | ||
1585 | ## | |
1586 | # @BlockdevCacheOptions | |
1587 | # | |
1588 | # Includes cache-related options for block devices | |
1589 | # | |
1590 | # @writeback: #optional enables writeback mode for any caches (default: true) | |
1591 | # @direct: #optional enables use of O_DIRECT (bypass the host page cache; | |
1592 | # default: false) | |
1593 | # @no-flush: #optional ignore any flush requests for the device (default: | |
1594 | # false) | |
1595 | # | |
1596 | # Since: 1.7 | |
1597 | ## | |
895a2a80 | 1598 | { 'struct': 'BlockdevCacheOptions', |
1ad166b6 BC |
1599 | 'data': { '*writeback': 'bool', |
1600 | '*direct': 'bool', | |
1601 | '*no-flush': 'bool' } } | |
1602 | ||
1603 | ## | |
1604 | # @BlockdevDriver | |
1605 | # | |
1606 | # Drivers that are supported in block device operations. | |
1607 | # | |
f709623b | 1608 | # @host_device, @host_cdrom: Since 2.1 |
1ad166b6 BC |
1609 | # |
1610 | # Since: 2.0 | |
1611 | ## | |
1612 | { 'enum': 'BlockdevDriver', | |
550830f9 | 1613 | 'data': [ 'archipelago', 'blkdebug', 'blkverify', 'bochs', 'cloop', |
e8712cea | 1614 | 'dmg', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device', |
f709623b | 1615 | 'http', 'https', 'null-aio', 'null-co', 'parallels', |
e8712cea FZ |
1616 | 'qcow', 'qcow2', 'qed', 'quorum', 'raw', 'tftp', 'vdi', 'vhdx', |
1617 | 'vmdk', 'vpc', 'vvfat' ] } | |
1ad166b6 BC |
1618 | |
1619 | ## | |
1620 | # @BlockdevOptionsBase | |
1621 | # | |
1622 | # Options that are available for all block devices, independent of the block | |
1623 | # driver. | |
1624 | # | |
1625 | # @driver: block driver name | |
1626 | # @id: #optional id by which the new block device can be referred to. | |
be4b67bc HR |
1627 | # This option is only allowed on the top level of blockdev-add. |
1628 | # A BlockBackend will be created by blockdev-add if and only if | |
1629 | # this option is given. | |
1630 | # @node-name: #optional the name of a block driver state node (Since 2.0). | |
1631 | # This option is required on the top level of blockdev-add if | |
1632 | # the @id option is not given there. | |
1ad166b6 BC |
1633 | # @discard: #optional discard-related options (default: ignore) |
1634 | # @cache: #optional cache-related options | |
1635 | # @aio: #optional AIO backend (default: threads) | |
1636 | # @rerror: #optional how to handle read errors on the device | |
1637 | # (default: report) | |
1638 | # @werror: #optional how to handle write errors on the device | |
1639 | # (default: enospc) | |
1640 | # @read-only: #optional whether the block device should be read-only | |
1641 | # (default: false) | |
362e9299 AG |
1642 | # @stats-account-invalid: #optional whether to include invalid |
1643 | # operations when computing last access statistics | |
1644 | # (default: true) (Since 2.5) | |
1645 | # @stats-account-failed: #optional whether to include failed | |
1646 | # operations when computing latency and last | |
1647 | # access statistics (default: true) (Since 2.5) | |
40119eff AG |
1648 | # @stats-intervals: #optional list of intervals for collecting I/O |
1649 | # statistics, in seconds (default: none) (Since 2.5) | |
1ad166b6 BC |
1650 | # @detect-zeroes: #optional detect and optimize zero writes (Since 2.1) |
1651 | # (default: off) | |
1652 | # | |
1653 | # Since: 1.7 | |
1654 | ## | |
895a2a80 | 1655 | { 'struct': 'BlockdevOptionsBase', |
1ad166b6 BC |
1656 | 'data': { 'driver': 'BlockdevDriver', |
1657 | '*id': 'str', | |
1658 | '*node-name': 'str', | |
1659 | '*discard': 'BlockdevDiscardOptions', | |
1660 | '*cache': 'BlockdevCacheOptions', | |
1661 | '*aio': 'BlockdevAioOptions', | |
1662 | '*rerror': 'BlockdevOnError', | |
1663 | '*werror': 'BlockdevOnError', | |
1664 | '*read-only': 'bool', | |
362e9299 AG |
1665 | '*stats-account-invalid': 'bool', |
1666 | '*stats-account-failed': 'bool', | |
40119eff | 1667 | '*stats-intervals': ['int'], |
1ad166b6 BC |
1668 | '*detect-zeroes': 'BlockdevDetectZeroesOptions' } } |
1669 | ||
1670 | ## | |
1671 | # @BlockdevOptionsFile | |
1672 | # | |
1673 | # Driver specific block device options for the file backend and similar | |
1674 | # protocols. | |
1675 | # | |
1676 | # @filename: path to the image file | |
1677 | # | |
1678 | # Since: 1.7 | |
1679 | ## | |
895a2a80 | 1680 | { 'struct': 'BlockdevOptionsFile', |
1ad166b6 BC |
1681 | 'data': { 'filename': 'str' } } |
1682 | ||
e819ab22 FZ |
1683 | ## |
1684 | # @BlockdevOptionsNull | |
1685 | # | |
1686 | # Driver specific block device options for the null backend. | |
1687 | # | |
1688 | # @size: #optional size of the device in bytes. | |
e5e51dd3 FZ |
1689 | # @latency-ns: #optional emulated latency (in nanoseconds) in processing |
1690 | # requests. Default to zero which completes requests immediately. | |
1691 | # (Since 2.4) | |
e819ab22 FZ |
1692 | # |
1693 | # Since: 2.2 | |
1694 | ## | |
895a2a80 | 1695 | { 'struct': 'BlockdevOptionsNull', |
e5e51dd3 | 1696 | 'data': { '*size': 'int', '*latency-ns': 'uint64' } } |
e819ab22 | 1697 | |
1ad166b6 BC |
1698 | ## |
1699 | # @BlockdevOptionsVVFAT | |
1700 | # | |
1701 | # Driver specific block device options for the vvfat protocol. | |
1702 | # | |
1703 | # @dir: directory to be exported as FAT image | |
1704 | # @fat-type: #optional FAT type: 12, 16 or 32 | |
1705 | # @floppy: #optional whether to export a floppy image (true) or | |
1706 | # partitioned hard disk (false; default) | |
d5941dda WB |
1707 | # @label: #optional set the volume label, limited to 11 bytes. FAT16 and |
1708 | # FAT32 traditionally have some restrictions on labels, which are | |
1709 | # ignored by most operating systems. Defaults to "QEMU VVFAT". | |
1710 | # (since 2.4) | |
1ad166b6 BC |
1711 | # @rw: #optional whether to allow write operations (default: false) |
1712 | # | |
1713 | # Since: 1.7 | |
1714 | ## | |
895a2a80 | 1715 | { 'struct': 'BlockdevOptionsVVFAT', |
1ad166b6 | 1716 | 'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool', |
d5941dda | 1717 | '*label': 'str', '*rw': 'bool' } } |
1ad166b6 BC |
1718 | |
1719 | ## | |
1720 | # @BlockdevOptionsGenericFormat | |
1721 | # | |
1722 | # Driver specific block device options for image format that have no option | |
1723 | # besides their data source. | |
1724 | # | |
1725 | # @file: reference to or definition of the data source block device | |
1726 | # | |
1727 | # Since: 1.7 | |
1728 | ## | |
895a2a80 | 1729 | { 'struct': 'BlockdevOptionsGenericFormat', |
1ad166b6 BC |
1730 | 'data': { 'file': 'BlockdevRef' } } |
1731 | ||
1732 | ## | |
1733 | # @BlockdevOptionsGenericCOWFormat | |
1734 | # | |
1735 | # Driver specific block device options for image format that have no option | |
1736 | # besides their data source and an optional backing file. | |
1737 | # | |
1738 | # @backing: #optional reference to or definition of the backing file block | |
1739 | # device (if missing, taken from the image file content). It is | |
1740 | # allowed to pass an empty string here in order to disable the | |
1741 | # default backing file. | |
1742 | # | |
1743 | # Since: 1.7 | |
1744 | ## | |
895a2a80 | 1745 | { 'struct': 'BlockdevOptionsGenericCOWFormat', |
1ad166b6 BC |
1746 | 'base': 'BlockdevOptionsGenericFormat', |
1747 | 'data': { '*backing': 'BlockdevRef' } } | |
1748 | ||
f6585811 HR |
1749 | ## |
1750 | # @Qcow2OverlapCheckMode | |
1751 | # | |
1752 | # General overlap check modes. | |
1753 | # | |
1754 | # @none: Do not perform any checks | |
1755 | # | |
1756 | # @constant: Perform only checks which can be done in constant time and | |
1757 | # without reading anything from disk | |
1758 | # | |
1759 | # @cached: Perform only checks which can be done without reading anything | |
1760 | # from disk | |
1761 | # | |
1762 | # @all: Perform all available overlap checks | |
1763 | # | |
1764 | # Since: 2.2 | |
1765 | ## | |
1766 | { 'enum': 'Qcow2OverlapCheckMode', | |
1767 | 'data': [ 'none', 'constant', 'cached', 'all' ] } | |
1768 | ||
1769 | ## | |
1770 | # @Qcow2OverlapCheckFlags | |
1771 | # | |
1772 | # Structure of flags for each metadata structure. Setting a field to 'true' | |
1773 | # makes qemu guard that structure against unintended overwriting. The default | |
1774 | # value is chosen according to the template given. | |
1775 | # | |
1776 | # @template: Specifies a template mode which can be adjusted using the other | |
1777 | # flags, defaults to 'cached' | |
1778 | # | |
1779 | # Since: 2.2 | |
1780 | ## | |
895a2a80 | 1781 | { 'struct': 'Qcow2OverlapCheckFlags', |
f6585811 HR |
1782 | 'data': { '*template': 'Qcow2OverlapCheckMode', |
1783 | '*main-header': 'bool', | |
1784 | '*active-l1': 'bool', | |
1785 | '*active-l2': 'bool', | |
1786 | '*refcount-table': 'bool', | |
1787 | '*refcount-block': 'bool', | |
1788 | '*snapshot-table': 'bool', | |
1789 | '*inactive-l1': 'bool', | |
1790 | '*inactive-l2': 'bool' } } | |
1791 | ||
1792 | ## | |
1793 | # @Qcow2OverlapChecks | |
1794 | # | |
1795 | # Specifies which metadata structures should be guarded against unintended | |
1796 | # overwriting. | |
1797 | # | |
1798 | # @flags: set of flags for separate specification of each metadata structure | |
1799 | # type | |
1800 | # | |
1801 | # @mode: named mode which chooses a specific set of flags | |
1802 | # | |
1803 | # Since: 2.2 | |
1804 | ## | |
ab916fad | 1805 | { 'alternate': 'Qcow2OverlapChecks', |
f6585811 HR |
1806 | 'data': { 'flags': 'Qcow2OverlapCheckFlags', |
1807 | 'mode': 'Qcow2OverlapCheckMode' } } | |
1808 | ||
1ad166b6 BC |
1809 | ## |
1810 | # @BlockdevOptionsQcow2 | |
1811 | # | |
1812 | # Driver specific block device options for qcow2. | |
1813 | # | |
1814 | # @lazy-refcounts: #optional whether to enable the lazy refcounts | |
1815 | # feature (default is taken from the image file) | |
1816 | # | |
1817 | # @pass-discard-request: #optional whether discard requests to the qcow2 | |
1818 | # device should be forwarded to the data source | |
1819 | # | |
1820 | # @pass-discard-snapshot: #optional whether discard requests for the data source | |
1821 | # should be issued when a snapshot operation (e.g. | |
1822 | # deleting a snapshot) frees clusters in the qcow2 file | |
1823 | # | |
1824 | # @pass-discard-other: #optional whether discard requests for the data source | |
1825 | # should be issued on other occasions where a cluster | |
1826 | # gets freed | |
1827 | # | |
f6585811 HR |
1828 | # @overlap-check: #optional which overlap checks to perform for writes |
1829 | # to the image, defaults to 'cached' (since 2.2) | |
1830 | # | |
1831 | # @cache-size: #optional the maximum total size of the L2 table and | |
1832 | # refcount block caches in bytes (since 2.2) | |
1833 | # | |
1834 | # @l2-cache-size: #optional the maximum size of the L2 table cache in | |
1835 | # bytes (since 2.2) | |
1836 | # | |
1837 | # @refcount-cache-size: #optional the maximum size of the refcount block cache | |
1838 | # in bytes (since 2.2) | |
1839 | # | |
279621c0 AG |
1840 | # @cache-clean-interval: #optional clean unused entries in the L2 and refcount |
1841 | # caches. The interval is in seconds. The default value | |
1842 | # is 0 and it disables this feature (since 2.5) | |
1843 | # | |
1ad166b6 BC |
1844 | # Since: 1.7 |
1845 | ## | |
895a2a80 | 1846 | { 'struct': 'BlockdevOptionsQcow2', |
1ad166b6 BC |
1847 | 'base': 'BlockdevOptionsGenericCOWFormat', |
1848 | 'data': { '*lazy-refcounts': 'bool', | |
1849 | '*pass-discard-request': 'bool', | |
1850 | '*pass-discard-snapshot': 'bool', | |
f6585811 HR |
1851 | '*pass-discard-other': 'bool', |
1852 | '*overlap-check': 'Qcow2OverlapChecks', | |
1853 | '*cache-size': 'int', | |
1854 | '*l2-cache-size': 'int', | |
279621c0 AG |
1855 | '*refcount-cache-size': 'int', |
1856 | '*cache-clean-interval': 'int' } } | |
1ad166b6 | 1857 | |
b1de5f43 CN |
1858 | |
1859 | ## | |
1860 | # @BlockdevOptionsArchipelago | |
1861 | # | |
1862 | # Driver specific block device options for Archipelago. | |
1863 | # | |
1864 | # @volume: Name of the Archipelago volume image | |
1865 | # | |
1866 | # @mport: #optional The port number on which mapperd is | |
1867 | # listening. This is optional | |
1868 | # and if not specified, QEMU will make Archipelago | |
1869 | # use the default port (1001). | |
1870 | # | |
1871 | # @vport: #optional The port number on which vlmcd is | |
1872 | # listening. This is optional | |
1873 | # and if not specified, QEMU will make Archipelago | |
1874 | # use the default port (501). | |
1875 | # | |
1876 | # @segment: #optional The name of the shared memory segment | |
1877 | # Archipelago stack is using. This is optional | |
1878 | # and if not specified, QEMU will make Archipelago | |
1879 | # use the default value, 'archipelago'. | |
1880 | # Since: 2.2 | |
1881 | ## | |
895a2a80 | 1882 | { 'struct': 'BlockdevOptionsArchipelago', |
b1de5f43 CN |
1883 | 'data': { 'volume': 'str', |
1884 | '*mport': 'int', | |
1885 | '*vport': 'int', | |
1886 | '*segment': 'str' } } | |
1887 | ||
1888 | ||
1ad166b6 BC |
1889 | ## |
1890 | # @BlkdebugEvent | |
1891 | # | |
1892 | # Trigger events supported by blkdebug. | |
a31939e6 EB |
1893 | # |
1894 | # Since: 2.0 | |
1ad166b6 | 1895 | ## |
a31939e6 | 1896 | { 'enum': 'BlkdebugEvent', 'prefix': 'BLKDBG', |
5be5b776 EB |
1897 | 'data': [ 'l1_update', 'l1_grow_alloc_table', 'l1_grow_write_table', |
1898 | 'l1_grow_activate_table', 'l2_load', 'l2_update', | |
1899 | 'l2_update_compressed', 'l2_alloc_cow_read', 'l2_alloc_write', | |
1ad166b6 BC |
1900 | 'read_aio', 'read_backing_aio', 'read_compressed', 'write_aio', |
1901 | 'write_compressed', 'vmstate_load', 'vmstate_save', 'cow_read', | |
1902 | 'cow_write', 'reftable_load', 'reftable_grow', 'reftable_update', | |
1903 | 'refblock_load', 'refblock_update', 'refblock_update_part', | |
5be5b776 EB |
1904 | 'refblock_alloc', 'refblock_alloc_hookup', 'refblock_alloc_write', |
1905 | 'refblock_alloc_write_blocks', 'refblock_alloc_write_table', | |
1906 | 'refblock_alloc_switch_table', 'cluster_alloc', | |
1ad166b6 | 1907 | 'cluster_alloc_bytes', 'cluster_free', 'flush_to_os', |
5be5b776 EB |
1908 | 'flush_to_disk', 'pwritev_rmw_head', 'pwritev_rmw_after_head', |
1909 | 'pwritev_rmw_tail', 'pwritev_rmw_after_tail', 'pwritev', | |
d21de4d9 | 1910 | 'pwritev_zero', 'pwritev_done', 'empty_image_prepare' ] } |
1ad166b6 BC |
1911 | |
1912 | ## | |
1913 | # @BlkdebugInjectErrorOptions | |
1914 | # | |
1915 | # Describes a single error injection for blkdebug. | |
1916 | # | |
1917 | # @event: trigger event | |
1918 | # | |
1919 | # @state: #optional the state identifier blkdebug needs to be in to | |
1920 | # actually trigger the event; defaults to "any" | |
1921 | # | |
1922 | # @errno: #optional error identifier (errno) to be returned; defaults to | |
1923 | # EIO | |
1924 | # | |
1925 | # @sector: #optional specifies the sector index which has to be affected | |
1926 | # in order to actually trigger the event; defaults to "any | |
1927 | # sector" | |
1928 | # | |
1929 | # @once: #optional disables further events after this one has been | |
1930 | # triggered; defaults to false | |
1931 | # | |
1932 | # @immediately: #optional fail immediately; defaults to false | |
1933 | # | |
1934 | # Since: 2.0 | |
1935 | ## | |
895a2a80 | 1936 | { 'struct': 'BlkdebugInjectErrorOptions', |
1ad166b6 BC |
1937 | 'data': { 'event': 'BlkdebugEvent', |
1938 | '*state': 'int', | |
1939 | '*errno': 'int', | |
1940 | '*sector': 'int', | |
1941 | '*once': 'bool', | |
1942 | '*immediately': 'bool' } } | |
1943 | ||
1944 | ## | |
1945 | # @BlkdebugSetStateOptions | |
1946 | # | |
1947 | # Describes a single state-change event for blkdebug. | |
1948 | # | |
1949 | # @event: trigger event | |
1950 | # | |
1951 | # @state: #optional the current state identifier blkdebug needs to be in; | |
1952 | # defaults to "any" | |
1953 | # | |
1954 | # @new_state: the state identifier blkdebug is supposed to assume if | |
1955 | # this event is triggered | |
1956 | # | |
1957 | # Since: 2.0 | |
1958 | ## | |
895a2a80 | 1959 | { 'struct': 'BlkdebugSetStateOptions', |
1ad166b6 BC |
1960 | 'data': { 'event': 'BlkdebugEvent', |
1961 | '*state': 'int', | |
1962 | 'new_state': 'int' } } | |
1963 | ||
1964 | ## | |
1965 | # @BlockdevOptionsBlkdebug | |
1966 | # | |
1967 | # Driver specific block device options for blkdebug. | |
1968 | # | |
1969 | # @image: underlying raw block device (or image file) | |
1970 | # | |
1971 | # @config: #optional filename of the configuration file | |
1972 | # | |
1973 | # @align: #optional required alignment for requests in bytes | |
1974 | # | |
1975 | # @inject-error: #optional array of error injection descriptions | |
1976 | # | |
1977 | # @set-state: #optional array of state-change descriptions | |
1978 | # | |
1979 | # Since: 2.0 | |
1980 | ## | |
895a2a80 | 1981 | { 'struct': 'BlockdevOptionsBlkdebug', |
1ad166b6 BC |
1982 | 'data': { 'image': 'BlockdevRef', |
1983 | '*config': 'str', | |
1984 | '*align': 'int', | |
1985 | '*inject-error': ['BlkdebugInjectErrorOptions'], | |
1986 | '*set-state': ['BlkdebugSetStateOptions'] } } | |
1987 | ||
1988 | ## | |
1989 | # @BlockdevOptionsBlkverify | |
1990 | # | |
1991 | # Driver specific block device options for blkverify. | |
1992 | # | |
1993 | # @test: block device to be tested | |
1994 | # | |
1995 | # @raw: raw image used for verification | |
1996 | # | |
1997 | # Since: 2.0 | |
1998 | ## | |
895a2a80 | 1999 | { 'struct': 'BlockdevOptionsBlkverify', |
1ad166b6 BC |
2000 | 'data': { 'test': 'BlockdevRef', |
2001 | 'raw': 'BlockdevRef' } } | |
2002 | ||
62c6031f LY |
2003 | ## |
2004 | # @QuorumReadPattern | |
2005 | # | |
2006 | # An enumeration of quorum read patterns. | |
2007 | # | |
2008 | # @quorum: read all the children and do a quorum vote on reads | |
2009 | # | |
2010 | # @fifo: read only from the first child that has not failed | |
2011 | # | |
2012 | # Since: 2.2 | |
2013 | ## | |
2014 | { 'enum': 'QuorumReadPattern', 'data': [ 'quorum', 'fifo' ] } | |
2015 | ||
1ad166b6 BC |
2016 | ## |
2017 | # @BlockdevOptionsQuorum | |
2018 | # | |
2019 | # Driver specific block device options for Quorum | |
2020 | # | |
2021 | # @blkverify: #optional true if the driver must print content mismatch | |
2022 | # set to false by default | |
2023 | # | |
2024 | # @children: the children block devices to use | |
2025 | # | |
2026 | # @vote-threshold: the vote limit under which a read will fail | |
2027 | # | |
cf29a570 BC |
2028 | # @rewrite-corrupted: #optional rewrite corrupted data when quorum is reached |
2029 | # (Since 2.1) | |
2030 | # | |
62c6031f LY |
2031 | # @read-pattern: #optional choose read pattern and set to quorum by default |
2032 | # (Since 2.2) | |
2033 | # | |
1ad166b6 BC |
2034 | # Since: 2.0 |
2035 | ## | |
895a2a80 | 2036 | { 'struct': 'BlockdevOptionsQuorum', |
1ad166b6 BC |
2037 | 'data': { '*blkverify': 'bool', |
2038 | 'children': [ 'BlockdevRef' ], | |
62c6031f LY |
2039 | 'vote-threshold': 'int', |
2040 | '*rewrite-corrupted': 'bool', | |
2041 | '*read-pattern': 'QuorumReadPattern' } } | |
1ad166b6 BC |
2042 | |
2043 | ## | |
2044 | # @BlockdevOptions | |
2045 | # | |
2046 | # Options for creating a block device. | |
2047 | # | |
2048 | # Since: 1.7 | |
2049 | ## | |
2050 | { 'union': 'BlockdevOptions', | |
2051 | 'base': 'BlockdevOptionsBase', | |
2052 | 'discriminator': 'driver', | |
2053 | 'data': { | |
b1de5f43 | 2054 | 'archipelago':'BlockdevOptionsArchipelago', |
db866be9 FZ |
2055 | 'blkdebug': 'BlockdevOptionsBlkdebug', |
2056 | 'blkverify': 'BlockdevOptionsBlkverify', | |
2057 | 'bochs': 'BlockdevOptionsGenericFormat', | |
2058 | 'cloop': 'BlockdevOptionsGenericFormat', | |
db866be9 | 2059 | 'dmg': 'BlockdevOptionsGenericFormat', |
1ad166b6 | 2060 | 'file': 'BlockdevOptionsFile', |
db866be9 FZ |
2061 | 'ftp': 'BlockdevOptionsFile', |
2062 | 'ftps': 'BlockdevOptionsFile', | |
2063 | # TODO gluster: Wait for structured options | |
1ad166b6 | 2064 | 'host_cdrom': 'BlockdevOptionsFile', |
db866be9 | 2065 | 'host_device':'BlockdevOptionsFile', |
1ad166b6 BC |
2066 | 'http': 'BlockdevOptionsFile', |
2067 | 'https': 'BlockdevOptionsFile', | |
1ad166b6 BC |
2068 | # TODO iscsi: Wait for structured options |
2069 | # TODO nbd: Should take InetSocketAddress for 'host'? | |
2070 | # TODO nfs: Wait for structured options | |
db866be9 FZ |
2071 | 'null-aio': 'BlockdevOptionsNull', |
2072 | 'null-co': 'BlockdevOptionsNull', | |
1ad166b6 | 2073 | 'parallels': 'BlockdevOptionsGenericFormat', |
1ad166b6 | 2074 | 'qcow2': 'BlockdevOptionsQcow2', |
db866be9 | 2075 | 'qcow': 'BlockdevOptionsGenericCOWFormat', |
1ad166b6 | 2076 | 'qed': 'BlockdevOptionsGenericCOWFormat', |
db866be9 | 2077 | 'quorum': 'BlockdevOptionsQuorum', |
1ad166b6 | 2078 | 'raw': 'BlockdevOptionsGenericFormat', |
db866be9 FZ |
2079 | # TODO rbd: Wait for structured options |
2080 | # TODO sheepdog: Wait for structured options | |
2081 | # TODO ssh: Should take InetSocketAddress for 'host'? | |
2082 | 'tftp': 'BlockdevOptionsFile', | |
1ad166b6 BC |
2083 | 'vdi': 'BlockdevOptionsGenericFormat', |
2084 | 'vhdx': 'BlockdevOptionsGenericFormat', | |
2085 | 'vmdk': 'BlockdevOptionsGenericCOWFormat', | |
2086 | 'vpc': 'BlockdevOptionsGenericFormat', | |
db866be9 | 2087 | 'vvfat': 'BlockdevOptionsVVFAT' |
1ad166b6 BC |
2088 | } } |
2089 | ||
2090 | ## | |
2091 | # @BlockdevRef | |
2092 | # | |
2093 | # Reference to a block device. | |
2094 | # | |
2095 | # @definition: defines a new block device inline | |
2096 | # @reference: references the ID of an existing block device. An | |
2097 | # empty string means that no block device should be | |
2098 | # referenced. | |
2099 | # | |
2100 | # Since: 1.7 | |
2101 | ## | |
ab916fad | 2102 | { 'alternate': 'BlockdevRef', |
1ad166b6 BC |
2103 | 'data': { 'definition': 'BlockdevOptions', |
2104 | 'reference': 'str' } } | |
2105 | ||
2106 | ## | |
2107 | # @blockdev-add: | |
2108 | # | |
be4b67bc HR |
2109 | # Creates a new block device. If the @id option is given at the top level, a |
2110 | # BlockBackend will be created; otherwise, @node-name is mandatory at the top | |
2111 | # level and no BlockBackend will be created. | |
1ad166b6 | 2112 | # |
da2cf4e8 | 2113 | # This command is still a work in progress. It doesn't support all |
81b936ae AG |
2114 | # block drivers among other things. Stay away from it unless you want |
2115 | # to help with its development. | |
da2cf4e8 | 2116 | # |
1ad166b6 BC |
2117 | # @options: block device options for the new device |
2118 | # | |
2119 | # Since: 1.7 | |
2120 | ## | |
2121 | { 'command': 'blockdev-add', 'data': { 'options': 'BlockdevOptions' } } | |
2122 | ||
81b936ae AG |
2123 | ## |
2124 | # @x-blockdev-del: | |
2125 | # | |
2126 | # Deletes a block device that has been added using blockdev-add. | |
2127 | # The selected device can be either a block backend or a graph node. | |
2128 | # | |
2129 | # In the former case the backend will be destroyed, along with its | |
2130 | # inserted medium if there's any. The command will fail if the backend | |
2131 | # or its medium are in use. | |
2132 | # | |
2133 | # In the latter case the node will be destroyed. The command will fail | |
2134 | # if the node is attached to a block backend or is otherwise being | |
2135 | # used. | |
2136 | # | |
2137 | # One of @id or @node-name must be specified, but not both. | |
2138 | # | |
2139 | # This command is still a work in progress and is considered | |
2140 | # experimental. Stay away from it unless you want to help with its | |
2141 | # development. | |
2142 | # | |
2143 | # @id: #optional Name of the block backend device to delete. | |
2144 | # | |
2145 | # @node-name: #optional Name of the graph node to delete. | |
2146 | # | |
2147 | # Since: 2.5 | |
2148 | ## | |
2149 | { 'command': 'x-blockdev-del', 'data': { '*id': 'str', '*node-name': 'str' } } | |
2150 | ||
7d8a9f71 HR |
2151 | ## |
2152 | # @blockdev-open-tray: | |
2153 | # | |
2154 | # Opens a block device's tray. If there is a block driver state tree inserted as | |
2155 | # a medium, it will become inaccessible to the guest (but it will remain | |
2156 | # associated to the block device, so closing the tray will make it accessible | |
2157 | # again). | |
2158 | # | |
2159 | # If the tray was already open before, this will be a no-op. | |
2160 | # | |
2161 | # Once the tray opens, a DEVICE_TRAY_MOVED event is emitted. There are cases in | |
2162 | # which no such event will be generated, these include: | |
2163 | # - if the guest has locked the tray, @force is false and the guest does not | |
2164 | # respond to the eject request | |
2165 | # - if the BlockBackend denoted by @device does not have a guest device attached | |
2166 | # to it | |
12c7ec87 | 2167 | # - if the guest device does not have an actual tray |
7d8a9f71 HR |
2168 | # |
2169 | # @device: block device name | |
2170 | # | |
2171 | # @force: #optional if false (the default), an eject request will be sent to | |
2172 | # the guest if it has locked the tray (and the tray will not be opened | |
2173 | # immediately); if true, the tray will be opened regardless of whether | |
2174 | # it is locked | |
2175 | # | |
2176 | # Since: 2.5 | |
2177 | ## | |
2178 | { 'command': 'blockdev-open-tray', | |
2179 | 'data': { 'device': 'str', | |
2180 | '*force': 'bool' } } | |
2181 | ||
abaaf59d HR |
2182 | ## |
2183 | # @blockdev-close-tray: | |
2184 | # | |
2185 | # Closes a block device's tray. If there is a block driver state tree associated | |
2186 | # with the block device (which is currently ejected), that tree will be loaded | |
2187 | # as the medium. | |
2188 | # | |
2189 | # If the tray was already closed before, this will be a no-op. | |
2190 | # | |
2191 | # @device: block device name | |
2192 | # | |
2193 | # Since: 2.5 | |
2194 | ## | |
2195 | { 'command': 'blockdev-close-tray', | |
2196 | 'data': { 'device': 'str' } } | |
2197 | ||
2814f672 | 2198 | ## |
6e0abc25 | 2199 | # @x-blockdev-remove-medium: |
2814f672 HR |
2200 | # |
2201 | # Removes a medium (a block driver state tree) from a block device. That block | |
2202 | # device's tray must currently be open (unless there is no attached guest | |
2203 | # device). | |
2204 | # | |
2205 | # If the tray is open and there is no medium inserted, this will be a no-op. | |
2206 | # | |
6e0abc25 HR |
2207 | # This command is still a work in progress and is considered experimental. |
2208 | # Stay away from it unless you want to help with its development. | |
2209 | # | |
2814f672 HR |
2210 | # @device: block device name |
2211 | # | |
2212 | # Since: 2.5 | |
2213 | ## | |
6e0abc25 | 2214 | { 'command': 'x-blockdev-remove-medium', |
2814f672 HR |
2215 | 'data': { 'device': 'str' } } |
2216 | ||
d1299882 | 2217 | ## |
6e0abc25 | 2218 | # @x-blockdev-insert-medium: |
d1299882 HR |
2219 | # |
2220 | # Inserts a medium (a block driver state tree) into a block device. That block | |
2221 | # device's tray must currently be open (unless there is no attached guest | |
2222 | # device) and there must be no medium inserted already. | |
2223 | # | |
6e0abc25 HR |
2224 | # This command is still a work in progress and is considered experimental. |
2225 | # Stay away from it unless you want to help with its development. | |
2226 | # | |
d1299882 HR |
2227 | # @device: block device name |
2228 | # | |
2229 | # @node-name: name of a node in the block driver state graph | |
2230 | # | |
2231 | # Since: 2.5 | |
2232 | ## | |
6e0abc25 | 2233 | { 'command': 'x-blockdev-insert-medium', |
d1299882 HR |
2234 | 'data': { 'device': 'str', |
2235 | 'node-name': 'str'} } | |
2236 | ||
a589569f | 2237 | |
39ff43d9 HR |
2238 | ## |
2239 | # @BlockdevChangeReadOnlyMode: | |
2240 | # | |
2241 | # Specifies the new read-only mode of a block device subject to the | |
2242 | # @blockdev-change-medium command. | |
2243 | # | |
2244 | # @retain: Retains the current read-only mode | |
2245 | # | |
2246 | # @read-only: Makes the device read-only | |
2247 | # | |
2248 | # @read-write: Makes the device writable | |
2249 | # | |
2250 | # Since: 2.3 | |
2251 | ## | |
2252 | { 'enum': 'BlockdevChangeReadOnlyMode', | |
2253 | 'data': ['retain', 'read-only', 'read-write'] } | |
2254 | ||
2255 | ||
24fb4133 HR |
2256 | ## |
2257 | # @blockdev-change-medium: | |
2258 | # | |
2259 | # Changes the medium inserted into a block device by ejecting the current medium | |
2260 | # and loading a new image file which is inserted as the new medium (this command | |
6e0abc25 HR |
2261 | # combines blockdev-open-tray, x-blockdev-remove-medium, |
2262 | # x-blockdev-insert-medium and blockdev-close-tray). | |
24fb4133 HR |
2263 | # |
2264 | # @device: block device name | |
2265 | # | |
2266 | # @filename: filename of the new image to be loaded | |
2267 | # | |
2268 | # @format: #optional, format to open the new image with (defaults to | |
2269 | # the probed format) | |
2270 | # | |
39ff43d9 HR |
2271 | # @read-only-mode: #optional, change the read-only mode of the device; defaults |
2272 | # to 'retain' | |
2273 | # | |
24fb4133 HR |
2274 | # Since: 2.5 |
2275 | ## | |
2276 | { 'command': 'blockdev-change-medium', | |
2277 | 'data': { 'device': 'str', | |
2278 | 'filename': 'str', | |
39ff43d9 HR |
2279 | '*format': 'str', |
2280 | '*read-only-mode': 'BlockdevChangeReadOnlyMode' } } | |
24fb4133 HR |
2281 | |
2282 | ||
a589569f WX |
2283 | ## |
2284 | # @BlockErrorAction | |
2285 | # | |
2286 | # An enumeration of action that has been taken when a DISK I/O occurs | |
2287 | # | |
2288 | # @ignore: error has been ignored | |
2289 | # | |
2290 | # @report: error has been reported to the device | |
2291 | # | |
2292 | # @stop: error caused VM to be stopped | |
2293 | # | |
2294 | # Since: 2.1 | |
2295 | ## | |
2296 | { 'enum': 'BlockErrorAction', | |
2297 | 'data': [ 'ignore', 'report', 'stop' ] } | |
5a2d2cbd WX |
2298 | |
2299 | ||
c120f0fa WX |
2300 | ## |
2301 | # @BLOCK_IMAGE_CORRUPTED | |
2302 | # | |
9bf040b9 | 2303 | # Emitted when a corruption has been detected in a disk image |
c120f0fa | 2304 | # |
dc881b44 AG |
2305 | # @device: device name. This is always present for compatibility |
2306 | # reasons, but it can be empty ("") if the image does not | |
2307 | # have a device name associated. | |
2308 | # | |
2309 | # @node-name: #optional node name (Since: 2.4) | |
c120f0fa WX |
2310 | # |
2311 | # @msg: informative message for human consumption, such as the kind of | |
2f44a08b WX |
2312 | # corruption being detected. It should not be parsed by machine as it is |
2313 | # not guaranteed to be stable | |
c120f0fa WX |
2314 | # |
2315 | # @offset: #optional, if the corruption resulted from an image access, this is | |
0caef8f6 | 2316 | # the host's access offset into the image |
c120f0fa WX |
2317 | # |
2318 | # @size: #optional, if the corruption resulted from an image access, this is | |
2319 | # the access size | |
2320 | # | |
9bf040b9 HR |
2321 | # fatal: if set, the image is marked corrupt and therefore unusable after this |
2322 | # event and must be repaired (Since 2.2; before, every | |
2323 | # BLOCK_IMAGE_CORRUPTED event was fatal) | |
2324 | # | |
c120f0fa WX |
2325 | # Since: 1.7 |
2326 | ## | |
2327 | { 'event': 'BLOCK_IMAGE_CORRUPTED', | |
dc881b44 AG |
2328 | 'data': { 'device' : 'str', |
2329 | '*node-name' : 'str', | |
2330 | 'msg' : 'str', | |
2331 | '*offset' : 'int', | |
2332 | '*size' : 'int', | |
2333 | 'fatal' : 'bool' } } | |
c120f0fa | 2334 | |
5a2d2cbd WX |
2335 | ## |
2336 | # @BLOCK_IO_ERROR | |
2337 | # | |
2338 | # Emitted when a disk I/O error occurs | |
2339 | # | |
2340 | # @device: device name | |
2341 | # | |
2342 | # @operation: I/O operation | |
2343 | # | |
2344 | # @action: action that has been taken | |
2345 | # | |
c7c2ff0c LC |
2346 | # @nospace: #optional true if I/O error was caused due to a no-space |
2347 | # condition. This key is only present if query-block's | |
2348 | # io-status is present, please see query-block documentation | |
2349 | # for more information (since: 2.2) | |
2350 | # | |
624ff573 LC |
2351 | # @reason: human readable string describing the error cause. |
2352 | # (This field is a debugging aid for humans, it should not | |
2353 | # be parsed by applications) (since: 2.2) | |
2354 | # | |
5a2d2cbd WX |
2355 | # Note: If action is "stop", a STOP event will eventually follow the |
2356 | # BLOCK_IO_ERROR event | |
2357 | # | |
2358 | # Since: 0.13.0 | |
2359 | ## | |
2360 | { 'event': 'BLOCK_IO_ERROR', | |
2361 | 'data': { 'device': 'str', 'operation': 'IoOperationType', | |
624ff573 LC |
2362 | 'action': 'BlockErrorAction', '*nospace': 'bool', |
2363 | 'reason': 'str' } } | |
5a2d2cbd | 2364 | |
bcada37b WX |
2365 | ## |
2366 | # @BLOCK_JOB_COMPLETED | |
2367 | # | |
2368 | # Emitted when a block job has completed | |
2369 | # | |
2370 | # @type: job type | |
2371 | # | |
2372 | # @device: device name | |
2373 | # | |
2374 | # @len: maximum progress value | |
2375 | # | |
2376 | # @offset: current progress value. On success this is equal to len. | |
2377 | # On failure this is less than len | |
2378 | # | |
2379 | # @speed: rate limit, bytes per second | |
2380 | # | |
2381 | # @error: #optional, error message. Only present on failure. This field | |
2382 | # contains a human-readable error message. There are no semantics | |
2383 | # other than that streaming has failed and clients should not try to | |
2384 | # interpret the error string | |
2385 | # | |
2386 | # Since: 1.1 | |
2387 | ## | |
2388 | { 'event': 'BLOCK_JOB_COMPLETED', | |
2389 | 'data': { 'type' : 'BlockJobType', | |
2390 | 'device': 'str', | |
2391 | 'len' : 'int', | |
2392 | 'offset': 'int', | |
2393 | 'speed' : 'int', | |
2394 | '*error': 'str' } } | |
2395 | ||
2396 | ## | |
2397 | # @BLOCK_JOB_CANCELLED | |
2398 | # | |
2399 | # Emitted when a block job has been cancelled | |
2400 | # | |
2401 | # @type: job type | |
2402 | # | |
2403 | # @device: device name | |
2404 | # | |
2405 | # @len: maximum progress value | |
2406 | # | |
2407 | # @offset: current progress value. On success this is equal to len. | |
2408 | # On failure this is less than len | |
2409 | # | |
2410 | # @speed: rate limit, bytes per second | |
2411 | # | |
2412 | # Since: 1.1 | |
2413 | ## | |
2414 | { 'event': 'BLOCK_JOB_CANCELLED', | |
2415 | 'data': { 'type' : 'BlockJobType', | |
2416 | 'device': 'str', | |
2417 | 'len' : 'int', | |
2418 | 'offset': 'int', | |
2419 | 'speed' : 'int' } } | |
2420 | ||
5a2d2cbd WX |
2421 | ## |
2422 | # @BLOCK_JOB_ERROR | |
2423 | # | |
2424 | # Emitted when a block job encounters an error | |
2425 | # | |
2426 | # @device: device name | |
2427 | # | |
2428 | # @operation: I/O operation | |
2429 | # | |
2430 | # @action: action that has been taken | |
2431 | # | |
2432 | # Since: 1.3 | |
2433 | ## | |
2434 | { 'event': 'BLOCK_JOB_ERROR', | |
2435 | 'data': { 'device' : 'str', | |
2436 | 'operation': 'IoOperationType', | |
823c6863 | 2437 | 'action' : 'BlockErrorAction' } } |
bcada37b WX |
2438 | |
2439 | ## | |
2440 | # @BLOCK_JOB_READY | |
2441 | # | |
2442 | # Emitted when a block job is ready to complete | |
2443 | # | |
518848a2 MA |
2444 | # @type: job type |
2445 | # | |
bcada37b WX |
2446 | # @device: device name |
2447 | # | |
518848a2 MA |
2448 | # @len: maximum progress value |
2449 | # | |
2450 | # @offset: current progress value. On success this is equal to len. | |
2451 | # On failure this is less than len | |
2452 | # | |
2453 | # @speed: rate limit, bytes per second | |
2454 | # | |
bcada37b WX |
2455 | # Note: The "ready to complete" status is always reset by a @BLOCK_JOB_ERROR |
2456 | # event | |
2457 | # | |
2458 | # Since: 1.3 | |
2459 | ## | |
2460 | { 'event': 'BLOCK_JOB_READY', | |
518848a2 MA |
2461 | 'data': { 'type' : 'BlockJobType', |
2462 | 'device': 'str', | |
2463 | 'len' : 'int', | |
2464 | 'offset': 'int', | |
2465 | 'speed' : 'int' } } | |
ffeaac9b HT |
2466 | |
2467 | # @PreallocMode | |
2468 | # | |
2469 | # Preallocation mode of QEMU image file | |
2470 | # | |
2471 | # @off: no preallocation | |
2472 | # @metadata: preallocate only for metadata | |
2473 | # @falloc: like @full preallocation but allocate disk space by | |
2474 | # posix_fallocate() rather than writing zeros. | |
2475 | # @full: preallocate all data by writing zeros to device to ensure disk | |
2476 | # space is really available. @full preallocation also sets up | |
2477 | # metadata correctly. | |
2478 | # | |
2479 | # Since 2.2 | |
2480 | ## | |
2481 | { 'enum': 'PreallocMode', | |
2482 | 'data': [ 'off', 'metadata', 'falloc', 'full' ] } | |
e2462113 FR |
2483 | |
2484 | ## | |
2485 | # @BLOCK_WRITE_THRESHOLD | |
2486 | # | |
2487 | # Emitted when writes on block device reaches or exceeds the | |
2488 | # configured write threshold. For thin-provisioned devices, this | |
2489 | # means the device should be extended to avoid pausing for | |
2490 | # disk exhaustion. | |
2491 | # The event is one shot. Once triggered, it needs to be | |
2492 | # re-registered with another block-set-threshold command. | |
2493 | # | |
2494 | # @node-name: graph node name on which the threshold was exceeded. | |
2495 | # | |
2496 | # @amount-exceeded: amount of data which exceeded the threshold, in bytes. | |
2497 | # | |
2498 | # @write-threshold: last configured threshold, in bytes. | |
2499 | # | |
2500 | # Since: 2.3 | |
2501 | ## | |
2502 | { 'event': 'BLOCK_WRITE_THRESHOLD', | |
2503 | 'data': { 'node-name': 'str', | |
2504 | 'amount-exceeded': 'uint64', | |
2505 | 'write-threshold': 'uint64' } } | |
2506 | ||
2507 | ## | |
2508 | # @block-set-write-threshold | |
2509 | # | |
2510 | # Change the write threshold for a block drive. An event will be delivered | |
2511 | # if a write to this block drive crosses the configured threshold. | |
2512 | # This is useful to transparently resize thin-provisioned drives without | |
2513 | # the guest OS noticing. | |
2514 | # | |
2515 | # @node-name: graph node name on which the threshold must be set. | |
2516 | # | |
2517 | # @write-threshold: configured threshold for the block device, bytes. | |
2518 | # Use 0 to disable the threshold. | |
2519 | # | |
e2462113 FR |
2520 | # Since: 2.3 |
2521 | ## | |
2522 | { 'command': 'block-set-write-threshold', | |
2523 | 'data': { 'node-name': 'str', 'write-threshold': 'uint64' } } |