]>
Commit | Line | Data |
---|---|---|
5db15096 | 1 | # -*- Mode: Python -*- |
f7160f32 | 2 | # vim: filetype=python |
d3a48372 MAL |
3 | |
4 | ## | |
f5cf31c5 | 5 | # == Block core (VM unrelated) |
d3a48372 | 6 | ## |
5db15096 | 7 | |
5db15096 | 8 | { 'include': 'common.json' } |
2031c133 | 9 | { 'include': 'crypto.json' } |
bf42508f | 10 | { 'include': 'job.json' } |
a2ff5a48 | 11 | { 'include': 'sockets.json' } |
1ad166b6 BC |
12 | |
13 | ## | |
5072f7b3 | 14 | # @SnapshotInfo: |
1ad166b6 BC |
15 | # |
16 | # @id: unique snapshot id | |
17 | # | |
18 | # @name: user chosen name | |
19 | # | |
20 | # @vm-state-size: size of the VM state | |
21 | # | |
22 | # @date-sec: UTC date of the snapshot in seconds | |
23 | # | |
24 | # @date-nsec: fractional part in nano seconds to be used with date-sec | |
25 | # | |
26 | # @vm-clock-sec: VM clock relative to boot in seconds | |
27 | # | |
a937b6aa MA |
28 | # @vm-clock-nsec: fractional part in nano seconds to be used with |
29 | # vm-clock-sec | |
1ad166b6 | 30 | # |
a937b6aa MA |
31 | # @icount: Current instruction count. Appears when execution |
32 | # record/replay is enabled. Used for "time-traveling" to match | |
33 | # the moment in the recorded execution with the snapshots. This | |
34 | # counter may be obtained through @query-replay command (since | |
35 | # 5.2) | |
b39847a5 | 36 | # |
1ad166b6 | 37 | # Since: 1.3 |
1ad166b6 | 38 | ## |
895a2a80 | 39 | { 'struct': 'SnapshotInfo', |
1ad166b6 BC |
40 | 'data': { 'id': 'str', 'name': 'str', 'vm-state-size': 'int', |
41 | 'date-sec': 'int', 'date-nsec': 'int', | |
b39847a5 PD |
42 | 'vm-clock-sec': 'int', 'vm-clock-nsec': 'int', |
43 | '*icount': 'int' } } | |
1ad166b6 | 44 | |
0a12f6f8 DB |
45 | ## |
46 | # @ImageInfoSpecificQCow2EncryptionBase: | |
47 | # | |
48 | # @format: The encryption format | |
49 | # | |
50 | # Since: 2.10 | |
51 | ## | |
52 | { 'struct': 'ImageInfoSpecificQCow2EncryptionBase', | |
53 | 'data': { 'format': 'BlockdevQcow2EncryptionFormat'}} | |
54 | ||
55 | ## | |
56 | # @ImageInfoSpecificQCow2Encryption: | |
57 | # | |
58 | # Since: 2.10 | |
59 | ## | |
60 | { 'union': 'ImageInfoSpecificQCow2Encryption', | |
61 | 'base': 'ImageInfoSpecificQCow2EncryptionBase', | |
62 | 'discriminator': 'format', | |
29cd0403 | 63 | 'data': { 'luks': 'QCryptoBlockInfoLUKS' } } |
0a12f6f8 | 64 | |
1ad166b6 BC |
65 | ## |
66 | # @ImageInfoSpecificQCow2: | |
67 | # | |
68 | # @compat: compatibility level | |
69 | # | |
a937b6aa MA |
70 | # @data-file: the filename of the external data file that is stored in |
71 | # the image and used as a default for opening the image | |
72 | # (since: 4.0) | |
9b890bdc | 73 | # |
6c3944dc | 74 | # @data-file-raw: True if the external data file must stay valid as a |
a937b6aa MA |
75 | # standalone (read-only) raw image without looking at qcow2 |
76 | # metadata (since: 4.0) | |
6c3944dc | 77 | # |
a937b6aa MA |
78 | # @extended-l2: true if the image has extended L2 entries; only valid |
79 | # for compat >= 1.1 (since 5.2) | |
7be20252 | 80 | # |
1d8bda12 | 81 | # @lazy-refcounts: on or off; only valid for compat >= 1.1 |
1ad166b6 | 82 | # |
1d8bda12 | 83 | # @corrupt: true if the image has been marked corrupt; only valid for |
a937b6aa | 84 | # compat >= 1.1 (since 2.2) |
9009b196 | 85 | # |
0709c5a1 HR |
86 | # @refcount-bits: width of a refcount entry in bits (since 2.3) |
87 | # | |
a937b6aa MA |
88 | # @encrypt: details about encryption parameters; only set if image is |
89 | # encrypted (since 2.10) | |
0a12f6f8 | 90 | # |
b8968c87 AS |
91 | # @bitmaps: A list of qcow2 bitmap details (since 4.0) |
92 | # | |
572ad978 DP |
93 | # @compression-type: the image cluster compression method (since 5.1) |
94 | # | |
1ad166b6 BC |
95 | # Since: 1.7 |
96 | ## | |
895a2a80 | 97 | { 'struct': 'ImageInfoSpecificQCow2', |
1ad166b6 BC |
98 | 'data': { |
99 | 'compat': 'str', | |
9b890bdc | 100 | '*data-file': 'str', |
6c3944dc | 101 | '*data-file-raw': 'bool', |
7be20252 | 102 | '*extended-l2': 'bool', |
9009b196 | 103 | '*lazy-refcounts': 'bool', |
0709c5a1 | 104 | '*corrupt': 'bool', |
0a12f6f8 | 105 | 'refcount-bits': 'int', |
b8968c87 | 106 | '*encrypt': 'ImageInfoSpecificQCow2Encryption', |
572ad978 DP |
107 | '*bitmaps': ['Qcow2BitmapInfo'], |
108 | 'compression-type': 'Qcow2CompressionType' | |
1ad166b6 BC |
109 | } } |
110 | ||
111 | ## | |
112 | # @ImageInfoSpecificVmdk: | |
113 | # | |
114 | # @create-type: The create type of VMDK image | |
115 | # | |
116 | # @cid: Content id of image | |
117 | # | |
118 | # @parent-cid: Parent VMDK image's cid | |
119 | # | |
120 | # @extents: List of extent files | |
121 | # | |
122 | # Since: 1.7 | |
123 | ## | |
895a2a80 | 124 | { 'struct': 'ImageInfoSpecificVmdk', |
1ad166b6 BC |
125 | 'data': { |
126 | 'create-type': 'str', | |
127 | 'cid': 'int', | |
128 | 'parent-cid': 'int', | |
456e7517 HR |
129 | 'extents': ['VmdkExtentInfo'] |
130 | } } | |
131 | ||
132 | ## | |
133 | # @VmdkExtentInfo: | |
134 | # | |
135 | # Information about a VMDK extent file | |
136 | # | |
137 | # @filename: Name of the extent file | |
138 | # | |
9e272073 | 139 | # @format: Extent type (e.g. FLAT or SPARSE) |
456e7517 HR |
140 | # |
141 | # @virtual-size: Number of bytes covered by this extent | |
142 | # | |
143 | # @cluster-size: Cluster size in bytes (for non-flat extents) | |
144 | # | |
145 | # @compressed: Whether this extent contains compressed data | |
146 | # | |
147 | # Since: 8.0 | |
148 | ## | |
149 | { 'struct': 'VmdkExtentInfo', | |
150 | 'data': { | |
151 | 'filename': 'str', | |
152 | 'format': 'str', | |
153 | 'virtual-size': 'int', | |
154 | '*cluster-size': 'int', | |
155 | '*compressed': 'bool' | |
1ad166b6 BC |
156 | } } |
157 | ||
42e4ac9e OO |
158 | ## |
159 | # @ImageInfoSpecificRbd: | |
160 | # | |
161 | # @encryption-format: Image encryption format | |
162 | # | |
163 | # Since: 6.1 | |
164 | ## | |
165 | { 'struct': 'ImageInfoSpecificRbd', | |
166 | 'data': { | |
167 | '*encryption-format': 'RbdImageEncryptionFormat' | |
168 | } } | |
169 | ||
7f36a50a HR |
170 | ## |
171 | # @ImageInfoSpecificFile: | |
172 | # | |
173 | # @extent-size-hint: Extent size hint (if available) | |
174 | # | |
175 | # Since: 8.0 | |
176 | ## | |
177 | { 'struct': 'ImageInfoSpecificFile', | |
178 | 'data': { | |
179 | '*extent-size-hint': 'size' | |
180 | } } | |
181 | ||
0db4f503 MA |
182 | ## |
183 | # @ImageInfoSpecificKind: | |
184 | # | |
185 | # @luks: Since 2.7 | |
a937b6aa | 186 | # |
0db4f503 | 187 | # @rbd: Since 6.1 |
a937b6aa | 188 | # |
7f36a50a | 189 | # @file: Since 8.0 |
0db4f503 MA |
190 | # |
191 | # Since: 1.7 | |
192 | ## | |
193 | { 'enum': 'ImageInfoSpecificKind', | |
7f36a50a | 194 | 'data': [ 'qcow2', 'vmdk', 'luks', 'rbd', 'file' ] } |
0db4f503 MA |
195 | |
196 | ## | |
197 | # @ImageInfoSpecificQCow2Wrapper: | |
198 | # | |
199 | # Since: 1.7 | |
200 | ## | |
201 | { 'struct': 'ImageInfoSpecificQCow2Wrapper', | |
202 | 'data': { 'data': 'ImageInfoSpecificQCow2' } } | |
203 | ||
204 | ## | |
205 | # @ImageInfoSpecificVmdkWrapper: | |
206 | # | |
207 | # Since: 6.1 | |
208 | ## | |
209 | { 'struct': 'ImageInfoSpecificVmdkWrapper', | |
210 | 'data': { 'data': 'ImageInfoSpecificVmdk' } } | |
211 | ||
212 | ## | |
213 | # @ImageInfoSpecificLUKSWrapper: | |
214 | # | |
215 | # Since: 2.7 | |
216 | ## | |
217 | { 'struct': 'ImageInfoSpecificLUKSWrapper', | |
218 | 'data': { 'data': 'QCryptoBlockInfoLUKS' } } | |
219 | # If we need to add block driver specific parameters for | |
220 | # LUKS in future, then we'll subclass QCryptoBlockInfoLUKS | |
221 | # to define a ImageInfoSpecificLUKS | |
222 | ||
223 | ## | |
224 | # @ImageInfoSpecificRbdWrapper: | |
225 | # | |
226 | # Since: 6.1 | |
227 | ## | |
228 | { 'struct': 'ImageInfoSpecificRbdWrapper', | |
229 | 'data': { 'data': 'ImageInfoSpecificRbd' } } | |
230 | ||
7f36a50a HR |
231 | ## |
232 | # @ImageInfoSpecificFileWrapper: | |
233 | # | |
234 | # Since: 8.0 | |
235 | ## | |
236 | { 'struct': 'ImageInfoSpecificFileWrapper', | |
237 | 'data': { 'data': 'ImageInfoSpecificFile' } } | |
238 | ||
1ad166b6 BC |
239 | ## |
240 | # @ImageInfoSpecific: | |
241 | # | |
a937b6aa MA |
242 | # A discriminated record of image format specific information |
243 | # structures. | |
1ad166b6 BC |
244 | # |
245 | # Since: 1.7 | |
246 | ## | |
1ad166b6 | 247 | { 'union': 'ImageInfoSpecific', |
0db4f503 MA |
248 | 'base': { 'type': 'ImageInfoSpecificKind' }, |
249 | 'discriminator': 'type', | |
1ad166b6 | 250 | 'data': { |
0db4f503 MA |
251 | 'qcow2': 'ImageInfoSpecificQCow2Wrapper', |
252 | 'vmdk': 'ImageInfoSpecificVmdkWrapper', | |
253 | 'luks': 'ImageInfoSpecificLUKSWrapper', | |
7f36a50a HR |
254 | 'rbd': 'ImageInfoSpecificRbdWrapper', |
255 | 'file': 'ImageInfoSpecificFileWrapper' | |
1ad166b6 BC |
256 | } } |
257 | ||
258 | ## | |
a2085f89 | 259 | # @BlockNodeInfo: |
1ad166b6 BC |
260 | # |
261 | # Information about a QEMU image file | |
262 | # | |
263 | # @filename: name of the image file | |
264 | # | |
265 | # @format: format of the image file | |
266 | # | |
267 | # @virtual-size: maximum capacity in bytes of the image | |
268 | # | |
1d8bda12 | 269 | # @actual-size: actual size on disk in bytes of the image |
1ad166b6 | 270 | # |
1d8bda12 | 271 | # @dirty-flag: true if image is not cleanly closed |
1ad166b6 | 272 | # |
1d8bda12 | 273 | # @cluster-size: size of a cluster in bytes |
1ad166b6 | 274 | # |
1d8bda12 | 275 | # @encrypted: true if the image is encrypted |
1ad166b6 | 276 | # |
1d8bda12 | 277 | # @compressed: true if the image is compressed (Since 1.7) |
1ad166b6 | 278 | # |
1d8bda12 | 279 | # @backing-filename: name of the backing file |
1ad166b6 | 280 | # |
1d8bda12 | 281 | # @full-backing-filename: full path of the backing file |
1ad166b6 | 282 | # |
1d8bda12 | 283 | # @backing-filename-format: the format of the backing file |
1ad166b6 | 284 | # |
1d8bda12 | 285 | # @snapshots: list of VM snapshots |
1ad166b6 | 286 | # |
1d8bda12 | 287 | # @format-specific: structure supplying additional format-specific |
a937b6aa | 288 | # information (since 1.7) |
1ad166b6 | 289 | # |
a2085f89 | 290 | # Since: 8.0 |
1ad166b6 | 291 | ## |
a2085f89 | 292 | { 'struct': 'BlockNodeInfo', |
1ad166b6 BC |
293 | 'data': {'filename': 'str', 'format': 'str', '*dirty-flag': 'bool', |
294 | '*actual-size': 'int', 'virtual-size': 'int', | |
295 | '*cluster-size': 'int', '*encrypted': 'bool', '*compressed': 'bool', | |
296 | '*backing-filename': 'str', '*full-backing-filename': 'str', | |
297 | '*backing-filename-format': 'str', '*snapshots': ['SnapshotInfo'], | |
24bf10da | 298 | '*format-specific': 'ImageInfoSpecific' } } |
1ad166b6 | 299 | |
a2085f89 HR |
300 | ## |
301 | # @ImageInfo: | |
302 | # | |
a937b6aa MA |
303 | # Information about a QEMU image file, and potentially its backing |
304 | # image | |
a2085f89 HR |
305 | # |
306 | # @backing-image: info of the backing image | |
307 | # | |
308 | # Since: 1.3 | |
309 | ## | |
310 | { 'struct': 'ImageInfo', | |
311 | 'base': 'BlockNodeInfo', | |
312 | 'data': { | |
313 | '*backing-image': 'ImageInfo' | |
314 | } } | |
315 | ||
6cab3399 HR |
316 | ## |
317 | # @BlockChildInfo: | |
318 | # | |
a937b6aa MA |
319 | # Information about all nodes in the block graph starting at some |
320 | # node, annotated with information about that node in relation to its | |
321 | # parent. | |
6cab3399 | 322 | # |
a937b6aa MA |
323 | # @name: Child name of the root node in the BlockGraphInfo struct, in |
324 | # its role as the child of some undescribed parent node | |
6cab3399 HR |
325 | # |
326 | # @info: Block graph information starting at this node | |
327 | # | |
328 | # Since: 8.0 | |
329 | ## | |
330 | { 'struct': 'BlockChildInfo', | |
331 | 'data': { | |
332 | 'name': 'str', | |
333 | 'info': 'BlockGraphInfo' | |
334 | } } | |
335 | ||
336 | ## | |
337 | # @BlockGraphInfo: | |
338 | # | |
a937b6aa MA |
339 | # Information about all nodes in a block (sub)graph in the form of |
340 | # BlockNodeInfo data. The base BlockNodeInfo struct contains the | |
341 | # information for the (sub)graph's root node. | |
6cab3399 HR |
342 | # |
343 | # @children: Array of links to this node's child nodes' information | |
344 | # | |
345 | # Since: 8.0 | |
346 | ## | |
347 | { 'struct': 'BlockGraphInfo', | |
348 | 'base': 'BlockNodeInfo', | |
349 | 'data': { 'children': ['BlockChildInfo'] } } | |
350 | ||
1ad166b6 BC |
351 | ## |
352 | # @ImageCheck: | |
353 | # | |
354 | # Information about a QEMU image file check | |
355 | # | |
356 | # @filename: name of the image file checked | |
357 | # | |
358 | # @format: format of the image file checked | |
359 | # | |
360 | # @check-errors: number of unexpected errors occurred during check | |
361 | # | |
1d8bda12 | 362 | # @image-end-offset: offset (in bytes) where the image ends, this |
a937b6aa | 363 | # field is present if the driver for the image format supports it |
1ad166b6 | 364 | # |
1d8bda12 | 365 | # @corruptions: number of corruptions found during the check if any |
1ad166b6 | 366 | # |
1d8bda12 | 367 | # @leaks: number of leaks found during the check if any |
1ad166b6 | 368 | # |
a937b6aa MA |
369 | # @corruptions-fixed: number of corruptions fixed during the check if |
370 | # any | |
1ad166b6 | 371 | # |
1d8bda12 | 372 | # @leaks-fixed: number of leaks fixed during the check if any |
1ad166b6 | 373 | # |
a937b6aa MA |
374 | # @total-clusters: total number of clusters, this field is present if |
375 | # the driver for the image format supports it | |
1ad166b6 | 376 | # |
a937b6aa MA |
377 | # @allocated-clusters: total number of allocated clusters, this field |
378 | # is present if the driver for the image format supports it | |
1ad166b6 | 379 | # |
1d8bda12 | 380 | # @fragmented-clusters: total number of fragmented clusters, this |
a937b6aa | 381 | # field is present if the driver for the image format supports it |
1ad166b6 | 382 | # |
1d8bda12 | 383 | # @compressed-clusters: total number of compressed clusters, this |
a937b6aa | 384 | # field is present if the driver for the image format supports it |
1ad166b6 BC |
385 | # |
386 | # Since: 1.4 | |
1ad166b6 | 387 | ## |
895a2a80 | 388 | { 'struct': 'ImageCheck', |
1ad166b6 BC |
389 | 'data': {'filename': 'str', 'format': 'str', 'check-errors': 'int', |
390 | '*image-end-offset': 'int', '*corruptions': 'int', '*leaks': 'int', | |
391 | '*corruptions-fixed': 'int', '*leaks-fixed': 'int', | |
392 | '*total-clusters': 'int', '*allocated-clusters': 'int', | |
393 | '*fragmented-clusters': 'int', '*compressed-clusters': 'int' } } | |
394 | ||
16b0d555 FZ |
395 | ## |
396 | # @MapEntry: | |
397 | # | |
398 | # Mapping information from a virtual block range to a host file range | |
399 | # | |
ffb515fa | 400 | # @start: virtual (guest) offset of the first byte described by this |
a937b6aa | 401 | # entry |
16b0d555 FZ |
402 | # |
403 | # @length: the number of bytes of the mapped virtual range | |
404 | # | |
ffb515fa | 405 | # @data: reading the image will actually read data from a file (in |
a937b6aa MA |
406 | # particular, if @offset is present this means that the sectors |
407 | # are not simply preallocated, but contain actual data in raw | |
408 | # format) | |
16b0d555 | 409 | # |
ffb515fa | 410 | # @zero: whether the virtual blocks read as zeroes |
16b0d555 | 411 | # |
52b10c9c AD |
412 | # @compressed: true if the data is stored compressed (since 8.2) |
413 | # | |
ffb515fa | 414 | # @depth: number of layers (0 = top image, 1 = top image's backing |
a937b6aa MA |
415 | # file, ..., n - 1 = bottom image (where n is the number of images |
416 | # in the chain)) before reaching one for which the range is | |
417 | # allocated | |
16b0d555 | 418 | # |
a937b6aa MA |
419 | # @present: true if this layer provides the data, false if adding a |
420 | # backing layer could impact this region (since 6.1) | |
8417e137 | 421 | # |
ffb515fa | 422 | # @offset: if present, the image file stores the data for this range |
a937b6aa | 423 | # in raw format at the given (host) offset |
16b0d555 | 424 | # |
1d8bda12 | 425 | # @filename: filename that is referred to by @offset |
16b0d555 FZ |
426 | # |
427 | # Since: 2.6 | |
16b0d555 FZ |
428 | ## |
429 | { 'struct': 'MapEntry', | |
430 | 'data': {'start': 'int', 'length': 'int', 'data': 'bool', | |
52b10c9c AD |
431 | 'zero': 'bool', 'compressed': 'bool', 'depth': 'int', |
432 | 'present': 'bool', '*offset': 'int', '*filename': 'str' } } | |
16b0d555 | 433 | |
9e193c5a | 434 | ## |
5072f7b3 | 435 | # @BlockdevCacheInfo: |
9e193c5a KW |
436 | # |
437 | # Cache mode information for a block device | |
438 | # | |
c0ac533b | 439 | # @writeback: true if writeback mode is enabled |
a937b6aa | 440 | # |
c0ac533b | 441 | # @direct: true if the host page cache is bypassed (O_DIRECT) |
a937b6aa | 442 | # |
c0ac533b | 443 | # @no-flush: true if flush requests are ignored for the device |
9e193c5a KW |
444 | # |
445 | # Since: 2.3 | |
446 | ## | |
895a2a80 | 447 | { 'struct': 'BlockdevCacheInfo', |
9e193c5a KW |
448 | 'data': { 'writeback': 'bool', |
449 | 'direct': 'bool', | |
450 | 'no-flush': 'bool' } } | |
451 | ||
1ad166b6 BC |
452 | ## |
453 | # @BlockDeviceInfo: | |
454 | # | |
455 | # Information about the backing device for a block device. | |
456 | # | |
457 | # @file: the filename of the backing device | |
458 | # | |
1d8bda12 | 459 | # @node-name: the name of the block driver node (Since 2.0) |
1ad166b6 BC |
460 | # |
461 | # @ro: true if the backing device was open read-only | |
462 | # | |
a937b6aa MA |
463 | # @drv: the name of the block format used to open the backing device. |
464 | # As of 0.14 this can be: 'blkdebug', 'bochs', 'cloop', 'cow', | |
465 | # 'dmg', 'file', 'file', 'ftp', 'ftps', 'host_cdrom', | |
466 | # 'host_device', 'http', 'https', 'luks', 'nbd', 'parallels', | |
467 | # 'qcow', 'qcow2', 'raw', 'vdi', 'vmdk', 'vpc', 'vvfat' 2.2: | |
468 | # 'archipelago' added, 'cow' dropped 2.3: 'host_floppy' deprecated | |
469 | # 2.5: 'host_floppy' dropped 2.6: 'luks' added 2.8: 'replication' | |
470 | # added, 'tftp' dropped 2.9: 'archipelago' dropped | |
1ad166b6 | 471 | # |
1d8bda12 | 472 | # @backing_file: the name of the backing file (for copy-on-write) |
1ad166b6 | 473 | # |
a937b6aa MA |
474 | # @backing_file_depth: number of files in the backing file chain |
475 | # (since: 1.2) | |
1ad166b6 BC |
476 | # |
477 | # @encrypted: true if the backing device is encrypted | |
478 | # | |
1ad166b6 BC |
479 | # @detect_zeroes: detect and optimize zero writes (Since 2.1) |
480 | # | |
481 | # @bps: total throughput limit in bytes per second is specified | |
482 | # | |
483 | # @bps_rd: read throughput limit in bytes per second is specified | |
484 | # | |
485 | # @bps_wr: write throughput limit in bytes per second is specified | |
486 | # | |
487 | # @iops: total I/O operations per second is specified | |
488 | # | |
489 | # @iops_rd: read I/O operations per second is specified | |
490 | # | |
491 | # @iops_wr: write I/O operations per second is specified | |
492 | # | |
493 | # @image: the info of image used (since: 1.6) | |
494 | # | |
a937b6aa | 495 | # @bps_max: total throughput limit during bursts, in bytes (Since 1.7) |
1ad166b6 | 496 | # |
a937b6aa MA |
497 | # @bps_rd_max: read throughput limit during bursts, in bytes (Since |
498 | # 1.7) | |
1ad166b6 | 499 | # |
a937b6aa MA |
500 | # @bps_wr_max: write throughput limit during bursts, in bytes (Since |
501 | # 1.7) | |
1ad166b6 | 502 | # |
f2de3b92 | 503 | # @iops_max: total I/O operations per second during bursts, in bytes |
a937b6aa | 504 | # (Since 1.7) |
1ad166b6 | 505 | # |
f2de3b92 | 506 | # @iops_rd_max: read I/O operations per second during bursts, in bytes |
a937b6aa | 507 | # (Since 1.7) |
1ad166b6 | 508 | # |
f2de3b92 | 509 | # @iops_wr_max: write I/O operations per second during bursts, in |
a937b6aa | 510 | # bytes (Since 1.7) |
398befdf | 511 | # |
f2de3b92 | 512 | # @bps_max_length: maximum length of the @bps_max burst period, in |
a937b6aa | 513 | # seconds. (Since 2.6) |
398befdf | 514 | # |
f2de3b92 | 515 | # @bps_rd_max_length: maximum length of the @bps_rd_max burst period, |
a937b6aa | 516 | # in seconds. (Since 2.6) |
398befdf | 517 | # |
f2de3b92 | 518 | # @bps_wr_max_length: maximum length of the @bps_wr_max burst period, |
a937b6aa | 519 | # in seconds. (Since 2.6) |
398befdf | 520 | # |
f2de3b92 | 521 | # @iops_max_length: maximum length of the @iops burst period, in |
a937b6aa | 522 | # seconds. (Since 2.6) |
398befdf | 523 | # |
f2de3b92 | 524 | # @iops_rd_max_length: maximum length of the @iops_rd_max burst |
a937b6aa | 525 | # period, in seconds. (Since 2.6) |
398befdf | 526 | # |
f2de3b92 | 527 | # @iops_wr_max_length: maximum length of the @iops_wr_max burst |
a937b6aa | 528 | # period, in seconds. (Since 2.6) |
1ad166b6 | 529 | # |
1d8bda12 | 530 | # @iops_size: an I/O size in bytes (Since 1.7) |
1ad166b6 | 531 | # |
1d8bda12 | 532 | # @group: throttle group name (Since 2.4) |
b8fe1694 | 533 | # |
9e193c5a KW |
534 | # @cache: the cache mode used for the block device (since: 2.3) |
535 | # | |
a937b6aa MA |
536 | # @write_threshold: configured write threshold for the device. 0 if |
537 | # disabled. (Since 2.3) | |
e2462113 | 538 | # |
a937b6aa MA |
539 | # @dirty-bitmaps: dirty bitmaps information (only present if node has |
540 | # one or more dirty bitmaps) (Since 4.2) | |
590a63d5 | 541 | # |
9bc6e893 | 542 | # Since: 0.14 |
1ad166b6 | 543 | ## |
895a2a80 | 544 | { 'struct': 'BlockDeviceInfo', |
1ad166b6 BC |
545 | 'data': { 'file': 'str', '*node-name': 'str', 'ro': 'bool', 'drv': 'str', |
546 | '*backing_file': 'str', 'backing_file_depth': 'int', | |
df4097ae | 547 | 'encrypted': 'bool', |
1ad166b6 BC |
548 | 'detect_zeroes': 'BlockdevDetectZeroesOptions', |
549 | 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int', | |
550 | 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int', | |
551 | 'image': 'ImageInfo', | |
552 | '*bps_max': 'int', '*bps_rd_max': 'int', | |
553 | '*bps_wr_max': 'int', '*iops_max': 'int', | |
554 | '*iops_rd_max': 'int', '*iops_wr_max': 'int', | |
398befdf AG |
555 | '*bps_max_length': 'int', '*bps_rd_max_length': 'int', |
556 | '*bps_wr_max_length': 'int', '*iops_max_length': 'int', | |
557 | '*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int', | |
b8fe1694 | 558 | '*iops_size': 'int', '*group': 'str', 'cache': 'BlockdevCacheInfo', |
590a63d5 | 559 | 'write_threshold': 'int', '*dirty-bitmaps': ['BlockDirtyInfo'] } } |
1ad166b6 BC |
560 | |
561 | ## | |
562 | # @BlockDeviceIoStatus: | |
563 | # | |
564 | # An enumeration of block device I/O status. | |
565 | # | |
566 | # @ok: The last I/O operation has succeeded | |
567 | # | |
568 | # @failed: The last I/O operation has failed | |
569 | # | |
a937b6aa MA |
570 | # @nospace: The last I/O operation has failed due to a no-space |
571 | # condition | |
1ad166b6 BC |
572 | # |
573 | # Since: 1.0 | |
574 | ## | |
575 | { 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] } | |
576 | ||
1ad166b6 BC |
577 | ## |
578 | # @BlockDirtyInfo: | |
579 | # | |
580 | # Block dirty bitmap information. | |
581 | # | |
1d8bda12 | 582 | # @name: the name of the dirty bitmap (Since 2.4) |
0db6e54a | 583 | # |
1ad166b6 BC |
584 | # @count: number of dirty bytes according to the dirty bitmap |
585 | # | |
586 | # @granularity: granularity of the dirty bitmap in bytes (since 1.4) | |
587 | # | |
a937b6aa MA |
588 | # @recording: true if the bitmap is recording new writes from the |
589 | # guest. (since 4.0) | |
4db6ceb0 JS |
590 | # |
591 | # @busy: true if the bitmap is in-use by some operation (NBD or jobs) | |
a937b6aa MA |
592 | # and cannot be modified via QMP or used by another operation. |
593 | # (since 4.0) | |
a113534f | 594 | # |
a937b6aa MA |
595 | # @persistent: true if the bitmap was stored on disk, is scheduled to |
596 | # be stored on disk, or both. (since 4.0) | |
a113534f | 597 | # |
a937b6aa MA |
598 | # @inconsistent: true if this is a persistent bitmap that was |
599 | # improperly stored. Implies @persistent to be true; @recording | |
600 | # and @busy to be false. This bitmap cannot be used. To remove | |
601 | # it, use @block-dirty-bitmap-remove. (Since 4.0) | |
f67cf661 | 602 | # |
1ad166b6 BC |
603 | # Since: 1.3 |
604 | ## | |
895a2a80 | 605 | { 'struct': 'BlockDirtyInfo', |
a113534f | 606 | 'data': {'*name': 'str', 'count': 'int', 'granularity': 'uint32', |
df4097ae | 607 | 'recording': 'bool', 'busy': 'bool', |
b0f45559 | 608 | 'persistent': 'bool', '*inconsistent': 'bool' } } |
1ad166b6 | 609 | |
b8968c87 AS |
610 | ## |
611 | # @Qcow2BitmapInfoFlags: | |
612 | # | |
613 | # An enumeration of flags that a bitmap can report to the user. | |
614 | # | |
a937b6aa MA |
615 | # @in-use: This flag is set by any process actively modifying the |
616 | # qcow2 file, and cleared when the updated bitmap is flushed to | |
617 | # the qcow2 image. The presence of this flag in an offline image | |
618 | # means that the bitmap was not saved correctly after its last | |
619 | # usage, and may contain inconsistent data. | |
b8968c87 | 620 | # |
a937b6aa MA |
621 | # @auto: The bitmap must reflect all changes of the virtual disk by |
622 | # any application that would write to this qcow2 file. | |
b8968c87 AS |
623 | # |
624 | # Since: 4.0 | |
625 | ## | |
626 | { 'enum': 'Qcow2BitmapInfoFlags', | |
627 | 'data': ['in-use', 'auto'] } | |
628 | ||
629 | ## | |
630 | # @Qcow2BitmapInfo: | |
631 | # | |
632 | # Qcow2 bitmap information. | |
633 | # | |
634 | # @name: the name of the bitmap | |
635 | # | |
636 | # @granularity: granularity of the bitmap in bytes | |
637 | # | |
638 | # @flags: flags of the bitmap | |
639 | # | |
640 | # Since: 4.0 | |
641 | ## | |
642 | { 'struct': 'Qcow2BitmapInfo', | |
643 | 'data': {'name': 'str', 'granularity': 'uint32', | |
644 | 'flags': ['Qcow2BitmapInfoFlags'] } } | |
645 | ||
7e5c776d VSO |
646 | ## |
647 | # @BlockLatencyHistogramInfo: | |
648 | # | |
649 | # Block latency histogram. | |
650 | # | |
a937b6aa MA |
651 | # @boundaries: list of interval boundary values in nanoseconds, all |
652 | # greater than zero and in ascending order. For example, the list | |
653 | # [10, 50, 100] produces the following histogram intervals: [0, | |
654 | # 10), [10, 50), [50, 100), [100, +inf). | |
7e5c776d | 655 | # |
a937b6aa | 656 | # @bins: list of io request counts corresponding to histogram |
dad3c956 MA |
657 | # intervals, one more element than @boundaries has. For the |
658 | # example above, @bins may be something like [3, 1, 5, 2], and | |
659 | # corresponding histogram looks like: | |
7e5c776d | 660 | # |
a0fcff38 PM |
661 | # :: |
662 | # | |
663 | # 5| * | |
664 | # 4| * | |
665 | # 3| * * | |
666 | # 2| * * * | |
667 | # 1| * * * * | |
668 | # +------------------ | |
669 | # 10 50 100 | |
7e5c776d | 670 | # |
cb8aac37 | 671 | # Since: 4.0 |
7e5c776d VSO |
672 | ## |
673 | { 'struct': 'BlockLatencyHistogramInfo', | |
674 | 'data': {'boundaries': ['uint64'], 'bins': ['uint64'] } } | |
675 | ||
1ad166b6 BC |
676 | ## |
677 | # @BlockInfo: | |
678 | # | |
a937b6aa MA |
679 | # Block device information. This structure describes a virtual device |
680 | # and the backing device associated with it. | |
1ad166b6 BC |
681 | # |
682 | # @device: The device name associated with the virtual device. | |
683 | # | |
a937b6aa MA |
684 | # @qdev: The qdev ID, or if no ID is assigned, the QOM path of the |
685 | # block device. (since 2.10) | |
46eade7b | 686 | # |
a937b6aa MA |
687 | # @type: This field is returned only for compatibility reasons, it |
688 | # should not be used (always returns 'unknown') | |
1ad166b6 BC |
689 | # |
690 | # @removable: True if the device supports removable media. | |
691 | # | |
a937b6aa MA |
692 | # @locked: True if the guest has locked this device from having its |
693 | # media removed | |
1ad166b6 | 694 | # |
a937b6aa MA |
695 | # @tray_open: True if the device's tray is open (only present if it |
696 | # has a tray) | |
1ad166b6 | 697 | # |
a937b6aa MA |
698 | # @io-status: @BlockDeviceIoStatus. Only present if the device |
699 | # supports it and the VM is configured to stop on errors | |
700 | # (supported device models: virtio-blk, IDE, SCSI except | |
701 | # scsi-generic) | |
1ad166b6 | 702 | # |
1d8bda12 | 703 | # @inserted: @BlockDeviceInfo describing the device if media is |
a937b6aa | 704 | # present |
1ad166b6 | 705 | # |
23e46452 | 706 | # Since: 0.14 |
1ad166b6 | 707 | ## |
895a2a80 | 708 | { 'struct': 'BlockInfo', |
46eade7b | 709 | 'data': {'device': 'str', '*qdev': 'str', 'type': 'str', 'removable': 'bool', |
1ad166b6 | 710 | 'locked': 'bool', '*inserted': 'BlockDeviceInfo', |
e67d8e29 | 711 | '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus' } } |
1ad166b6 | 712 | |
90880ff1 SH |
713 | ## |
714 | # @BlockMeasureInfo: | |
715 | # | |
a937b6aa MA |
716 | # Image file size calculation information. This structure describes |
717 | # the size requirements for creating a new image file. | |
90880ff1 | 718 | # |
a937b6aa MA |
719 | # The size requirements depend on the new image file format. File |
720 | # size always equals virtual disk size for the 'raw' format, even for | |
721 | # sparse POSIX files. Compact formats such as 'qcow2' represent | |
722 | # unallocated and zero regions efficiently so file size may be smaller | |
723 | # than virtual disk size. | |
90880ff1 | 724 | # |
a937b6aa MA |
725 | # The values are upper bounds that are guaranteed to fit the new image |
726 | # file. Subsequent modification, such as internal snapshot or further | |
727 | # bitmap creation, may require additional space and is not covered | |
728 | # here. | |
90880ff1 | 729 | # |
a937b6aa MA |
730 | # @required: Size required for a new image file, in bytes, when |
731 | # copying just allocated guest-visible contents. | |
90880ff1 | 732 | # |
a937b6aa MA |
733 | # @fully-allocated: Image file size, in bytes, once data has been |
734 | # written to all sectors, when copying just guest-visible | |
735 | # contents. | |
5d72c68b | 736 | # |
a937b6aa MA |
737 | # @bitmaps: Additional size required if all the top-level bitmap |
738 | # metadata in the source image were to be copied to the | |
739 | # destination, present only when source and destination both | |
740 | # support persistent bitmaps. (since 5.1) | |
90880ff1 SH |
741 | # |
742 | # Since: 2.10 | |
743 | ## | |
744 | { 'struct': 'BlockMeasureInfo', | |
5d72c68b | 745 | 'data': {'required': 'int', 'fully-allocated': 'int', '*bitmaps': 'int'} } |
90880ff1 | 746 | |
1ad166b6 BC |
747 | ## |
748 | # @query-block: | |
749 | # | |
750 | # Get a list of BlockInfo for all virtual block devices. | |
751 | # | |
a937b6aa MA |
752 | # Returns: a list of @BlockInfo describing each virtual block device. |
753 | # Filter nodes that were created implicitly are skipped over. | |
1ad166b6 | 754 | # |
9bc6e893 | 755 | # Since: 0.14 |
978cceab MAL |
756 | # |
757 | # Example: | |
758 | # | |
759 | # -> { "execute": "query-block" } | |
760 | # <- { | |
761 | # "return":[ | |
762 | # { | |
763 | # "io-status": "ok", | |
764 | # "device":"ide0-hd0", | |
765 | # "locked":false, | |
766 | # "removable":false, | |
767 | # "inserted":{ | |
768 | # "ro":false, | |
769 | # "drv":"qcow2", | |
770 | # "encrypted":false, | |
771 | # "file":"disks/test.qcow2", | |
772 | # "backing_file_depth":1, | |
773 | # "bps":1000000, | |
774 | # "bps_rd":0, | |
775 | # "bps_wr":0, | |
776 | # "iops":1000000, | |
777 | # "iops_rd":0, | |
778 | # "iops_wr":0, | |
779 | # "bps_max": 8000000, | |
780 | # "bps_rd_max": 0, | |
781 | # "bps_wr_max": 0, | |
782 | # "iops_max": 0, | |
783 | # "iops_rd_max": 0, | |
784 | # "iops_wr_max": 0, | |
785 | # "iops_size": 0, | |
786 | # "detect_zeroes": "on", | |
787 | # "write_threshold": 0, | |
788 | # "image":{ | |
789 | # "filename":"disks/test.qcow2", | |
790 | # "format":"qcow2", | |
791 | # "virtual-size":2048000, | |
792 | # "backing_file":"base.qcow2", | |
793 | # "full-backing-filename":"disks/base.qcow2", | |
794 | # "backing-filename-format":"qcow2", | |
795 | # "snapshots":[ | |
796 | # { | |
797 | # "id": "1", | |
798 | # "name": "snapshot1", | |
799 | # "vm-state-size": 0, | |
800 | # "date-sec": 10000200, | |
801 | # "date-nsec": 12, | |
802 | # "vm-clock-sec": 206, | |
803 | # "vm-clock-nsec": 30 | |
804 | # } | |
805 | # ], | |
806 | # "backing-image":{ | |
807 | # "filename":"disks/base.qcow2", | |
808 | # "format":"qcow2", | |
809 | # "virtual-size":2048000 | |
810 | # } | |
811 | # } | |
812 | # }, | |
46eade7b | 813 | # "qdev": "ide_disk", |
978cceab MAL |
814 | # "type":"unknown" |
815 | # }, | |
816 | # { | |
817 | # "io-status": "ok", | |
818 | # "device":"ide1-cd0", | |
819 | # "locked":false, | |
820 | # "removable":true, | |
46eade7b KW |
821 | # "qdev": "/machine/unattached/device[23]", |
822 | # "tray_open": false, | |
978cceab MAL |
823 | # "type":"unknown" |
824 | # }, | |
825 | # { | |
826 | # "device":"floppy0", | |
827 | # "locked":false, | |
828 | # "removable":true, | |
46eade7b | 829 | # "qdev": "/machine/unattached/device[20]", |
978cceab MAL |
830 | # "type":"unknown" |
831 | # }, | |
832 | # { | |
833 | # "device":"sd0", | |
834 | # "locked":false, | |
835 | # "removable":true, | |
836 | # "type":"unknown" | |
837 | # } | |
838 | # ] | |
839 | # } | |
1ad166b6 | 840 | ## |
f55ba801 PB |
841 | { 'command': 'query-block', 'returns': ['BlockInfo'], |
842 | 'allow-preconfig': true } | |
1ad166b6 | 843 | |
979e9b03 AG |
844 | ## |
845 | # @BlockDeviceTimedStats: | |
846 | # | |
847 | # Statistics of a block device during a given interval of time. | |
848 | # | |
a937b6aa MA |
849 | # @interval_length: Interval used for calculating the statistics, in |
850 | # seconds. | |
979e9b03 AG |
851 | # |
852 | # @min_rd_latency_ns: Minimum latency of read operations in the | |
a937b6aa | 853 | # defined interval, in nanoseconds. |
979e9b03 AG |
854 | # |
855 | # @min_wr_latency_ns: Minimum latency of write operations in the | |
a937b6aa | 856 | # defined interval, in nanoseconds. |
979e9b03 | 857 | # |
9e272073 MA |
858 | # @min_zone_append_latency_ns: Minimum latency of zone append |
859 | # operations in the defined interval, in nanoseconds (since 8.1) | |
52eb76f4 | 860 | # |
979e9b03 | 861 | # @min_flush_latency_ns: Minimum latency of flush operations in the |
a937b6aa | 862 | # defined interval, in nanoseconds. |
979e9b03 AG |
863 | # |
864 | # @max_rd_latency_ns: Maximum latency of read operations in the | |
a937b6aa | 865 | # defined interval, in nanoseconds. |
979e9b03 AG |
866 | # |
867 | # @max_wr_latency_ns: Maximum latency of write operations in the | |
a937b6aa | 868 | # defined interval, in nanoseconds. |
979e9b03 | 869 | # |
9e272073 MA |
870 | # @max_zone_append_latency_ns: Maximum latency of zone append |
871 | # operations in the defined interval, in nanoseconds (since 8.1) | |
52eb76f4 | 872 | # |
979e9b03 | 873 | # @max_flush_latency_ns: Maximum latency of flush operations in the |
a937b6aa | 874 | # defined interval, in nanoseconds. |
979e9b03 AG |
875 | # |
876 | # @avg_rd_latency_ns: Average latency of read operations in the | |
a937b6aa | 877 | # defined interval, in nanoseconds. |
979e9b03 AG |
878 | # |
879 | # @avg_wr_latency_ns: Average latency of write operations in the | |
a937b6aa | 880 | # defined interval, in nanoseconds. |
979e9b03 | 881 | # |
9e272073 MA |
882 | # @avg_zone_append_latency_ns: Average latency of zone append |
883 | # operations in the defined interval, in nanoseconds (since 8.1) | |
52eb76f4 | 884 | # |
979e9b03 | 885 | # @avg_flush_latency_ns: Average latency of flush operations in the |
a937b6aa | 886 | # defined interval, in nanoseconds. |
979e9b03 | 887 | # |
a937b6aa MA |
888 | # @avg_rd_queue_depth: Average number of pending read operations in |
889 | # the defined interval. | |
96e4deda | 890 | # |
a937b6aa MA |
891 | # @avg_wr_queue_depth: Average number of pending write operations in |
892 | # the defined interval. | |
96e4deda | 893 | # |
52eb76f4 | 894 | # @avg_zone_append_queue_depth: Average number of pending zone append |
9e272073 | 895 | # operations in the defined interval (since 8.1). |
52eb76f4 | 896 | # |
979e9b03 AG |
897 | # Since: 2.5 |
898 | ## | |
979e9b03 AG |
899 | { 'struct': 'BlockDeviceTimedStats', |
900 | 'data': { 'interval_length': 'int', 'min_rd_latency_ns': 'int', | |
901 | 'max_rd_latency_ns': 'int', 'avg_rd_latency_ns': 'int', | |
902 | 'min_wr_latency_ns': 'int', 'max_wr_latency_ns': 'int', | |
52eb76f4 SL |
903 | 'avg_wr_latency_ns': 'int', 'min_zone_append_latency_ns': 'int', |
904 | 'max_zone_append_latency_ns': 'int', | |
905 | 'avg_zone_append_latency_ns': 'int', | |
906 | 'min_flush_latency_ns': 'int', 'max_flush_latency_ns': 'int', | |
907 | 'avg_flush_latency_ns': 'int', 'avg_rd_queue_depth': 'number', | |
908 | 'avg_wr_queue_depth': 'number', | |
909 | 'avg_zone_append_queue_depth': 'number' } } | |
979e9b03 | 910 | |
1ad166b6 BC |
911 | ## |
912 | # @BlockDeviceStats: | |
913 | # | |
914 | # Statistics of a virtual block device or a block backing device. | |
915 | # | |
23e46452 | 916 | # @rd_bytes: The number of bytes read by the device. |
1ad166b6 | 917 | # |
23e46452 | 918 | # @wr_bytes: The number of bytes written by the device. |
1ad166b6 | 919 | # |
9e272073 MA |
920 | # @zone_append_bytes: The number of bytes appended by the zoned |
921 | # devices (since 8.1) | |
52eb76f4 | 922 | # |
159f85dd AN |
923 | # @unmap_bytes: The number of bytes unmapped by the device (Since 4.2) |
924 | # | |
a937b6aa MA |
925 | # @rd_operations: The number of read operations performed by the |
926 | # device. | |
1ad166b6 | 927 | # |
a937b6aa MA |
928 | # @wr_operations: The number of write operations performed by the |
929 | # device. | |
1ad166b6 | 930 | # |
9e272073 MA |
931 | # @zone_append_operations: The number of zone append operations |
932 | # performed by the zoned devices (since 8.1) | |
52eb76f4 | 933 | # |
a937b6aa MA |
934 | # @flush_operations: The number of cache flush operations performed by |
935 | # the device (since 0.15) | |
1ad166b6 | 936 | # |
a937b6aa MA |
937 | # @unmap_operations: The number of unmap operations performed by the |
938 | # device (Since 4.2) | |
159f85dd | 939 | # |
a937b6aa MA |
940 | # @rd_total_time_ns: Total time spent on reads in nanoseconds (since |
941 | # 0.15). | |
1ad166b6 | 942 | # |
a937b6aa MA |
943 | # @wr_total_time_ns: Total time spent on writes in nanoseconds (since |
944 | # 0.15). | |
1ad166b6 | 945 | # |
52eb76f4 | 946 | # @zone_append_total_time_ns: Total time spent on zone append writes |
9e272073 | 947 | # in nanoseconds (since 8.1) |
52eb76f4 | 948 | # |
a937b6aa MA |
949 | # @flush_total_time_ns: Total time spent on cache flushes in |
950 | # nanoseconds (since 0.15). | |
1ad166b6 | 951 | # |
a937b6aa MA |
952 | # @unmap_total_time_ns: Total time spent on unmap operations in |
953 | # nanoseconds (Since 4.2) | |
159f85dd | 954 | # |
a937b6aa MA |
955 | # @wr_highest_offset: The offset after the greatest byte written to |
956 | # the device. The intended use of this information is for | |
957 | # growable sparse files (like qcow2) that are used on top of a | |
958 | # physical device. | |
1ad166b6 | 959 | # |
a937b6aa MA |
960 | # @rd_merged: Number of read requests that have been merged into |
961 | # another request (Since 2.3). | |
f4564d53 | 962 | # |
a937b6aa MA |
963 | # @wr_merged: Number of write requests that have been merged into |
964 | # another request (Since 2.3). | |
f4564d53 | 965 | # |
9e272073 MA |
966 | # @zone_append_merged: Number of zone append requests that have been |
967 | # merged into another request (since 8.1) | |
52eb76f4 | 968 | # |
a937b6aa MA |
969 | # @unmap_merged: Number of unmap requests that have been merged into |
970 | # another request (Since 4.2) | |
159f85dd | 971 | # |
a937b6aa MA |
972 | # @idle_time_ns: Time since the last I/O operation, in nanoseconds. |
973 | # If the field is absent it means that there haven't been any | |
974 | # operations yet (Since 2.5). | |
cb38fffb | 975 | # |
7ee12daf | 976 | # @failed_rd_operations: The number of failed read operations |
a937b6aa | 977 | # performed by the device (Since 2.5) |
7ee12daf AG |
978 | # |
979 | # @failed_wr_operations: The number of failed write operations | |
a937b6aa | 980 | # performed by the device (Since 2.5) |
7ee12daf | 981 | # |
9e272073 MA |
982 | # @failed_zone_append_operations: The number of failed zone append |
983 | # write operations performed by the zoned devices (since 8.1) | |
52eb76f4 | 984 | # |
7ee12daf | 985 | # @failed_flush_operations: The number of failed flush operations |
a937b6aa | 986 | # performed by the device (Since 2.5) |
7ee12daf | 987 | # |
a937b6aa MA |
988 | # @failed_unmap_operations: The number of failed unmap operations |
989 | # performed by the device (Since 4.2) | |
159f85dd | 990 | # |
7ee12daf | 991 | # @invalid_rd_operations: The number of invalid read operations |
a937b6aa | 992 | # performed by the device (Since 2.5) |
7ee12daf AG |
993 | # |
994 | # @invalid_wr_operations: The number of invalid write operations | |
a937b6aa | 995 | # performed by the device (Since 2.5) |
7ee12daf | 996 | # |
9e272073 MA |
997 | # @invalid_zone_append_operations: The number of invalid zone append |
998 | # operations performed by the zoned device (since 8.1) | |
52eb76f4 | 999 | # |
7ee12daf | 1000 | # @invalid_flush_operations: The number of invalid flush operations |
a937b6aa | 1001 | # performed by the device (Since 2.5) |
7ee12daf | 1002 | # |
a937b6aa MA |
1003 | # @invalid_unmap_operations: The number of invalid unmap operations |
1004 | # performed by the device (Since 4.2) | |
159f85dd | 1005 | # |
362e9299 | 1006 | # @account_invalid: Whether invalid operations are included in the |
a937b6aa | 1007 | # last access statistics (Since 2.5) |
362e9299 AG |
1008 | # |
1009 | # @account_failed: Whether failed operations are included in the | |
a937b6aa | 1010 | # latency and last access statistics (Since 2.5) |
362e9299 | 1011 | # |
979e9b03 | 1012 | # @timed_stats: Statistics specific to the set of previously defined |
a937b6aa | 1013 | # intervals of time (Since 2.5) |
979e9b03 | 1014 | # |
a937b6aa | 1015 | # @rd_latency_histogram: @BlockLatencyHistogramInfo. (Since 4.0) |
7e5c776d | 1016 | # |
a937b6aa | 1017 | # @wr_latency_histogram: @BlockLatencyHistogramInfo. (Since 4.0) |
7e5c776d | 1018 | # |
9e272073 MA |
1019 | # @zone_append_latency_histogram: @BlockLatencyHistogramInfo. |
1020 | # (since 8.1) | |
52eb76f4 | 1021 | # |
a937b6aa | 1022 | # @flush_latency_histogram: @BlockLatencyHistogramInfo. (Since 4.0) |
7e5c776d | 1023 | # |
9bc6e893 | 1024 | # Since: 0.14 |
1ad166b6 | 1025 | ## |
895a2a80 | 1026 | { 'struct': 'BlockDeviceStats', |
52eb76f4 SL |
1027 | 'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'zone_append_bytes': 'int', |
1028 | 'unmap_bytes' : 'int', 'rd_operations': 'int', | |
1029 | 'wr_operations': 'int', 'zone_append_operations': 'int', | |
159f85dd | 1030 | 'flush_operations': 'int', 'unmap_operations': 'int', |
329d27e3 | 1031 | 'rd_total_time_ns': 'int', 'wr_total_time_ns': 'int', |
52eb76f4 SL |
1032 | 'zone_append_total_time_ns': 'int', 'flush_total_time_ns': 'int', |
1033 | 'unmap_total_time_ns': 'int', 'wr_highest_offset': 'int', | |
1034 | 'rd_merged': 'int', 'wr_merged': 'int', 'zone_append_merged': 'int', | |
1035 | 'unmap_merged': 'int', '*idle_time_ns': 'int', | |
7ee12daf | 1036 | 'failed_rd_operations': 'int', 'failed_wr_operations': 'int', |
52eb76f4 SL |
1037 | 'failed_zone_append_operations': 'int', |
1038 | 'failed_flush_operations': 'int', | |
1039 | 'failed_unmap_operations': 'int', 'invalid_rd_operations': 'int', | |
1040 | 'invalid_wr_operations': 'int', | |
1041 | 'invalid_zone_append_operations': 'int', | |
159f85dd | 1042 | 'invalid_flush_operations': 'int', 'invalid_unmap_operations': 'int', |
979e9b03 | 1043 | 'account_invalid': 'bool', 'account_failed': 'bool', |
7e5c776d | 1044 | 'timed_stats': ['BlockDeviceTimedStats'], |
cb8aac37 VSO |
1045 | '*rd_latency_histogram': 'BlockLatencyHistogramInfo', |
1046 | '*wr_latency_histogram': 'BlockLatencyHistogramInfo', | |
52eb76f4 | 1047 | '*zone_append_latency_histogram': 'BlockLatencyHistogramInfo', |
cb8aac37 | 1048 | '*flush_latency_histogram': 'BlockLatencyHistogramInfo' } } |
1ad166b6 | 1049 | |
d9245599 AN |
1050 | ## |
1051 | # @BlockStatsSpecificFile: | |
1052 | # | |
1053 | # File driver statistics | |
1054 | # | |
a937b6aa MA |
1055 | # @discard-nb-ok: The number of successful discard operations |
1056 | # performed by the driver. | |
d9245599 | 1057 | # |
a937b6aa MA |
1058 | # @discard-nb-failed: The number of failed discard operations |
1059 | # performed by the driver. | |
d9245599 AN |
1060 | # |
1061 | # @discard-bytes-ok: The number of bytes discarded by the driver. | |
1062 | # | |
1063 | # Since: 4.2 | |
1064 | ## | |
1065 | { 'struct': 'BlockStatsSpecificFile', | |
1066 | 'data': { | |
1067 | 'discard-nb-ok': 'uint64', | |
1068 | 'discard-nb-failed': 'uint64', | |
1069 | 'discard-bytes-ok': 'uint64' } } | |
1070 | ||
f25e7ab2 PMD |
1071 | ## |
1072 | # @BlockStatsSpecificNvme: | |
1073 | # | |
1074 | # NVMe driver statistics | |
1075 | # | |
1076 | # @completion-errors: The number of completion errors. | |
1077 | # | |
a937b6aa MA |
1078 | # @aligned-accesses: The number of aligned accesses performed by the |
1079 | # driver. | |
f25e7ab2 PMD |
1080 | # |
1081 | # @unaligned-accesses: The number of unaligned accesses performed by | |
a937b6aa | 1082 | # the driver. |
f25e7ab2 PMD |
1083 | # |
1084 | # Since: 5.2 | |
1085 | ## | |
1086 | { 'struct': 'BlockStatsSpecificNvme', | |
1087 | 'data': { | |
1088 | 'completion-errors': 'uint64', | |
1089 | 'aligned-accesses': 'uint64', | |
1090 | 'unaligned-accesses': 'uint64' } } | |
1091 | ||
d9245599 AN |
1092 | ## |
1093 | # @BlockStatsSpecific: | |
1094 | # | |
1095 | # Block driver specific statistics | |
1096 | # | |
1097 | # Since: 4.2 | |
1098 | ## | |
1099 | { 'union': 'BlockStatsSpecific', | |
1100 | 'base': { 'driver': 'BlockdevDriver' }, | |
1101 | 'discriminator': 'driver', | |
1102 | 'data': { | |
1103 | 'file': 'BlockStatsSpecificFile', | |
14176c8d | 1104 | 'host_device': { 'type': 'BlockStatsSpecificFile', |
8a9f1e1d | 1105 | 'if': 'HAVE_HOST_BLOCK_DEVICE' }, |
f25e7ab2 | 1106 | 'nvme': 'BlockStatsSpecificNvme' } } |
d9245599 | 1107 | |
1ad166b6 BC |
1108 | ## |
1109 | # @BlockStats: | |
1110 | # | |
1111 | # Statistics of a virtual block device or a block backing device. | |
1112 | # | |
1d8bda12 | 1113 | # @device: If the stats are for a virtual block device, the name |
a937b6aa | 1114 | # corresponding to the virtual block device. |
1ad166b6 | 1115 | # |
a937b6aa | 1116 | # @node-name: The node name of the device. (Since 2.3) |
4875a779 | 1117 | # |
a937b6aa MA |
1118 | # @qdev: The qdev ID, or if no ID is assigned, the QOM path of the |
1119 | # block device. (since 3.0) | |
5a9cb5a9 | 1120 | # |
23e46452 | 1121 | # @stats: A @BlockDeviceStats for the device. |
1ad166b6 | 1122 | # |
a937b6aa | 1123 | # @driver-specific: Optional driver-specific stats. (Since 4.2) |
d9245599 | 1124 | # |
1d8bda12 | 1125 | # @parent: This describes the file block device if it has one. |
a937b6aa | 1126 | # Contains recursively the statistics of the underlying protocol |
9e272073 | 1127 | # (e.g. the host file for a qcow2 image). If there is no |
a937b6aa | 1128 | # underlying protocol, this field is omitted |
1ad166b6 | 1129 | # |
1d8bda12 | 1130 | # @backing: This describes the backing block device if it has one. |
a937b6aa | 1131 | # (Since 2.0) |
1ad166b6 | 1132 | # |
9bc6e893 | 1133 | # Since: 0.14 |
1ad166b6 | 1134 | ## |
895a2a80 | 1135 | { 'struct': 'BlockStats', |
5a9cb5a9 | 1136 | 'data': {'*device': 'str', '*qdev': 'str', '*node-name': 'str', |
4875a779 | 1137 | 'stats': 'BlockDeviceStats', |
d9245599 | 1138 | '*driver-specific': 'BlockStatsSpecific', |
1ad166b6 BC |
1139 | '*parent': 'BlockStats', |
1140 | '*backing': 'BlockStats'} } | |
1141 | ||
1142 | ## | |
1143 | # @query-blockstats: | |
1144 | # | |
1145 | # Query the @BlockStats for all virtual block devices. | |
1146 | # | |
1d8bda12 | 1147 | # @query-nodes: If true, the command will query all the block nodes |
a937b6aa MA |
1148 | # that have a node name, in a list which will include "parent" |
1149 | # information, but not "backing". If false or omitted, the | |
1150 | # behavior is as before - query all the device backends, | |
1151 | # recursively including their "parent" and "backing". Filter nodes | |
1152 | # that were created implicitly are skipped over in this mode. | |
1153 | # (Since 2.3) | |
f71eaa74 | 1154 | # |
1ad166b6 BC |
1155 | # Returns: A list of @BlockStats for each virtual block devices. |
1156 | # | |
9bc6e893 | 1157 | # Since: 0.14 |
f2eaea18 MAL |
1158 | # |
1159 | # Example: | |
1160 | # | |
1161 | # -> { "execute": "query-blockstats" } | |
1162 | # <- { | |
1163 | # "return":[ | |
1164 | # { | |
1165 | # "device":"ide0-hd0", | |
1166 | # "parent":{ | |
1167 | # "stats":{ | |
1168 | # "wr_highest_offset":3686448128, | |
1169 | # "wr_bytes":9786368, | |
1170 | # "wr_operations":751, | |
1171 | # "rd_bytes":122567168, | |
1172 | # "rd_operations":36772 | |
1173 | # "wr_total_times_ns":313253456 | |
1174 | # "rd_total_times_ns":3465673657 | |
1175 | # "flush_total_times_ns":49653 | |
1176 | # "flush_operations":61, | |
1177 | # "rd_merged":0, | |
1178 | # "wr_merged":0, | |
1179 | # "idle_time_ns":2953431879, | |
1180 | # "account_invalid":true, | |
1181 | # "account_failed":false | |
1182 | # } | |
1183 | # }, | |
1184 | # "stats":{ | |
1185 | # "wr_highest_offset":2821110784, | |
1186 | # "wr_bytes":9786368, | |
1187 | # "wr_operations":692, | |
1188 | # "rd_bytes":122739200, | |
1189 | # "rd_operations":36604 | |
1190 | # "flush_operations":51, | |
1191 | # "wr_total_times_ns":313253456 | |
1192 | # "rd_total_times_ns":3465673657 | |
1193 | # "flush_total_times_ns":49653, | |
1194 | # "rd_merged":0, | |
1195 | # "wr_merged":0, | |
1196 | # "idle_time_ns":2953431879, | |
1197 | # "account_invalid":true, | |
1198 | # "account_failed":false | |
5a9cb5a9 KW |
1199 | # }, |
1200 | # "qdev": "/machine/unattached/device[23]" | |
f2eaea18 MAL |
1201 | # }, |
1202 | # { | |
1203 | # "device":"ide1-cd0", | |
1204 | # "stats":{ | |
1205 | # "wr_highest_offset":0, | |
1206 | # "wr_bytes":0, | |
1207 | # "wr_operations":0, | |
1208 | # "rd_bytes":0, | |
1209 | # "rd_operations":0 | |
1210 | # "flush_operations":0, | |
1211 | # "wr_total_times_ns":0 | |
1212 | # "rd_total_times_ns":0 | |
1213 | # "flush_total_times_ns":0, | |
1214 | # "rd_merged":0, | |
1215 | # "wr_merged":0, | |
1216 | # "account_invalid":false, | |
1217 | # "account_failed":false | |
5a9cb5a9 KW |
1218 | # }, |
1219 | # "qdev": "/machine/unattached/device[24]" | |
f2eaea18 MAL |
1220 | # }, |
1221 | # { | |
1222 | # "device":"floppy0", | |
1223 | # "stats":{ | |
1224 | # "wr_highest_offset":0, | |
1225 | # "wr_bytes":0, | |
1226 | # "wr_operations":0, | |
1227 | # "rd_bytes":0, | |
1228 | # "rd_operations":0 | |
1229 | # "flush_operations":0, | |
1230 | # "wr_total_times_ns":0 | |
1231 | # "rd_total_times_ns":0 | |
1232 | # "flush_total_times_ns":0, | |
1233 | # "rd_merged":0, | |
1234 | # "wr_merged":0, | |
1235 | # "account_invalid":false, | |
1236 | # "account_failed":false | |
5a9cb5a9 KW |
1237 | # }, |
1238 | # "qdev": "/machine/unattached/device[16]" | |
f2eaea18 MAL |
1239 | # }, |
1240 | # { | |
1241 | # "device":"sd0", | |
1242 | # "stats":{ | |
1243 | # "wr_highest_offset":0, | |
1244 | # "wr_bytes":0, | |
1245 | # "wr_operations":0, | |
1246 | # "rd_bytes":0, | |
1247 | # "rd_operations":0 | |
1248 | # "flush_operations":0, | |
1249 | # "wr_total_times_ns":0 | |
1250 | # "rd_total_times_ns":0 | |
1251 | # "flush_total_times_ns":0, | |
1252 | # "rd_merged":0, | |
1253 | # "wr_merged":0, | |
1254 | # "account_invalid":false, | |
1255 | # "account_failed":false | |
1256 | # } | |
1257 | # } | |
1258 | # ] | |
1259 | # } | |
1ad166b6 | 1260 | ## |
f71eaa74 FZ |
1261 | { 'command': 'query-blockstats', |
1262 | 'data': { '*query-nodes': 'bool' }, | |
f55ba801 PB |
1263 | 'returns': ['BlockStats'], |
1264 | 'allow-preconfig': true } | |
1ad166b6 BC |
1265 | |
1266 | ## | |
1267 | # @BlockdevOnError: | |
1268 | # | |
1269 | # An enumeration of possible behaviors for errors on I/O operations. | |
a937b6aa MA |
1270 | # The exact meaning depends on whether the I/O was initiated by a |
1271 | # guest or by a block job | |
1ad166b6 | 1272 | # |
a937b6aa MA |
1273 | # @report: for guest operations, report the error to the guest; for |
1274 | # jobs, cancel the job | |
1ad166b6 BC |
1275 | # |
1276 | # @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR | |
a937b6aa MA |
1277 | # or BLOCK_JOB_ERROR). The backup, mirror and commit block jobs |
1278 | # retry the failing request later and may still complete | |
1279 | # successfully. The stream block job continues to stream and will | |
1280 | # complete with an error. | |
1ad166b6 BC |
1281 | # |
1282 | # @enospc: same as @stop on ENOSPC, same as @report otherwise. | |
1283 | # | |
a937b6aa MA |
1284 | # @stop: for guest operations, stop the virtual machine; for jobs, |
1285 | # pause the job | |
1ad166b6 | 1286 | # |
8c398252 KW |
1287 | # @auto: inherit the error handling policy of the backend (since: 2.7) |
1288 | # | |
1ad166b6 BC |
1289 | # Since: 1.3 |
1290 | ## | |
1291 | { 'enum': 'BlockdevOnError', | |
8c398252 | 1292 | 'data': ['report', 'ignore', 'enospc', 'stop', 'auto'] } |
1ad166b6 BC |
1293 | |
1294 | ## | |
1295 | # @MirrorSyncMode: | |
1296 | # | |
1297 | # An enumeration of possible behaviors for the initial synchronization | |
1298 | # phase of storage mirroring. | |
1299 | # | |
1300 | # @top: copies data in the topmost image to the destination | |
1301 | # | |
1302 | # @full: copies data from all images to the destination | |
1303 | # | |
1304 | # @none: only copy data written from now on | |
1305 | # | |
a937b6aa MA |
1306 | # @incremental: only copy data described by the dirty bitmap. |
1307 | # (since: 2.4) | |
c8b56501 | 1308 | # |
a937b6aa MA |
1309 | # @bitmap: only copy data described by the dirty bitmap. (since: 4.2) |
1310 | # Behavior on completion is determined by the BitmapSyncMode. | |
d58d8453 | 1311 | # |
1ad166b6 BC |
1312 | # Since: 1.3 |
1313 | ## | |
1314 | { 'enum': 'MirrorSyncMode', | |
c8b56501 | 1315 | 'data': ['top', 'full', 'none', 'incremental', 'bitmap'] } |
1ad166b6 | 1316 | |
00a463b1 JS |
1317 | ## |
1318 | # @BitmapSyncMode: | |
1319 | # | |
a937b6aa MA |
1320 | # An enumeration of possible behaviors for the synchronization of a |
1321 | # bitmap when used for data copy operations. | |
00a463b1 | 1322 | # |
a937b6aa MA |
1323 | # @on-success: The bitmap is only synced when the operation is |
1324 | # successful. This is the behavior always used for 'INCREMENTAL' | |
1325 | # backups. | |
00a463b1 | 1326 | # |
cf0cd293 | 1327 | # @never: The bitmap is never synchronized with the operation, and is |
a937b6aa | 1328 | # treated solely as a read-only manifest of blocks to copy. |
cf0cd293 | 1329 | # |
c23909e5 | 1330 | # @always: The bitmap is always synchronized with the operation, |
a937b6aa | 1331 | # regardless of whether or not the operation was successful. |
c23909e5 | 1332 | # |
00a463b1 JS |
1333 | # Since: 4.2 |
1334 | ## | |
1335 | { 'enum': 'BitmapSyncMode', | |
c23909e5 | 1336 | 'data': ['on-success', 'never', 'always'] } |
00a463b1 | 1337 | |
d06107ad HR |
1338 | ## |
1339 | # @MirrorCopyMode: | |
1340 | # | |
1341 | # An enumeration whose values tell the mirror block job when to | |
1342 | # trigger writes to the target. | |
1343 | # | |
1344 | # @background: copy data in background only. | |
1345 | # | |
1346 | # @write-blocking: when data is written to the source, write it | |
a937b6aa MA |
1347 | # (synchronously) to the target as well. In addition, data is |
1348 | # copied in background just like in @background mode. | |
d06107ad HR |
1349 | # |
1350 | # Since: 3.0 | |
1351 | ## | |
1352 | { 'enum': 'MirrorCopyMode', | |
1353 | 'data': ['background', 'write-blocking'] } | |
1354 | ||
76cb2f24 FE |
1355 | ## |
1356 | # @BlockJobInfoMirror: | |
1357 | # | |
1358 | # Information specific to mirror block jobs. | |
1359 | # | |
1360 | # @actively-synced: Whether the source is actively synced to the | |
1361 | # target, i.e. same data and new writes are done synchronously to | |
1362 | # both. | |
1363 | # | |
37507c14 | 1364 | # Since: 8.2 |
76cb2f24 FE |
1365 | ## |
1366 | { 'struct': 'BlockJobInfoMirror', | |
1367 | 'data': { 'actively-synced': 'bool' } } | |
1368 | ||
1ad166b6 BC |
1369 | ## |
1370 | # @BlockJobInfo: | |
1371 | # | |
1372 | # Information about a long-running block device operation. | |
1373 | # | |
1374 | # @type: the job type ('stream' for image streaming) | |
1375 | # | |
a937b6aa MA |
1376 | # @device: The job identifier. Originally the device name but other |
1377 | # values are allowed since QEMU 2.7 | |
1ad166b6 | 1378 | # |
a937b6aa MA |
1379 | # @len: Estimated @offset value at the completion of the job. This |
1380 | # value can arbitrarily change while the job is running, in both | |
1381 | # directions. | |
a81e0a82 | 1382 | # |
a937b6aa MA |
1383 | # @offset: Progress made until now. The unit is arbitrary and the |
1384 | # value can only meaningfully be used for the ratio of @offset to | |
1385 | # @len. The value is monotonically increasing. | |
1ad166b6 | 1386 | # |
a937b6aa MA |
1387 | # @busy: false if the job is known to be in a quiescent state, with no |
1388 | # pending I/O. (Since 1.3) | |
1ad166b6 | 1389 | # |
a937b6aa MA |
1390 | # @paused: whether the job is paused or, if @busy is true, will pause |
1391 | # itself as soon as possible. (Since 1.3) | |
1ad166b6 | 1392 | # |
1ad166b6 BC |
1393 | # @speed: the rate limit, bytes per second |
1394 | # | |
1395 | # @io-status: the status of the job (since 1.3) | |
1396 | # | |
ef6dbf1e HR |
1397 | # @ready: true if the job may be completed (since 2.2) |
1398 | # | |
58b295ba JS |
1399 | # @status: Current job state/status (since 2.12) |
1400 | # | |
a937b6aa MA |
1401 | # @auto-finalize: Job will finalize itself when PENDING, moving to the |
1402 | # CONCLUDED state. (since 2.12) | |
b40dacdc | 1403 | # |
a937b6aa MA |
1404 | # @auto-dismiss: Job will dismiss itself when CONCLUDED, moving to the |
1405 | # NULL state and disappearing from the query list. (since 2.12) | |
b40dacdc | 1406 | # |
ab9ba614 | 1407 | # @error: Error information if the job did not complete successfully. |
a937b6aa | 1408 | # Not set if the job completed successfully. (since 2.12.1) |
ab9ba614 | 1409 | # |
1ad166b6 BC |
1410 | # Since: 1.1 |
1411 | ## | |
701efc9f FE |
1412 | { 'union': 'BlockJobInfo', |
1413 | 'base': {'type': 'JobType', 'device': 'str', 'len': 'int', | |
1ad166b6 | 1414 | 'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int', |
58b295ba | 1415 | 'io-status': 'BlockDeviceIoStatus', 'ready': 'bool', |
a50c2ab8 | 1416 | 'status': 'JobStatus', |
ab9ba614 | 1417 | 'auto-finalize': 'bool', 'auto-dismiss': 'bool', |
701efc9f FE |
1418 | '*error': 'str' }, |
1419 | 'discriminator': 'type', | |
76cb2f24 | 1420 | 'data': { 'mirror': 'BlockJobInfoMirror' } } |
1ad166b6 BC |
1421 | |
1422 | ## | |
1423 | # @query-block-jobs: | |
1424 | # | |
1425 | # Return information about long-running block device operations. | |
1426 | # | |
1427 | # Returns: a list of @BlockJobInfo for each active block job | |
1428 | # | |
1429 | # Since: 1.1 | |
1430 | ## | |
f55ba801 PB |
1431 | { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'], |
1432 | 'allow-preconfig': true } | |
1ad166b6 | 1433 | |
1ad166b6 | 1434 | ## |
5072f7b3 | 1435 | # @block_resize: |
1ad166b6 BC |
1436 | # |
1437 | # Resize a block image while a guest is running. | |
1438 | # | |
1439 | # Either @device or @node-name must be set but not both. | |
1440 | # | |
1d8bda12 | 1441 | # @device: the name of the device to get the image resized |
1ad166b6 | 1442 | # |
1d8bda12 | 1443 | # @node-name: graph node name to get the image resized (Since 2.0) |
1ad166b6 | 1444 | # |
23e46452 | 1445 | # @size: new image size in bytes |
1ad166b6 | 1446 | # |
a937b6aa MA |
1447 | # Returns: |
1448 | # - nothing on success | |
1449 | # - If @device is not a valid block device, DeviceNotFound | |
1ad166b6 | 1450 | # |
9bc6e893 | 1451 | # Since: 0.14 |
0dc869cf MAL |
1452 | # |
1453 | # Example: | |
1454 | # | |
1455 | # -> { "execute": "block_resize", | |
1456 | # "arguments": { "device": "scratch", "size": 1073741824 } } | |
1457 | # <- { "return": {} } | |
1ad166b6 | 1458 | ## |
b0ddeba2 MAL |
1459 | { 'command': 'block_resize', |
1460 | 'data': { '*device': 'str', | |
1461 | '*node-name': 'str', | |
eb94b81a | 1462 | 'size': 'int' }, |
f55ba801 PB |
1463 | 'coroutine': true, |
1464 | 'allow-preconfig': true } | |
1ad166b6 BC |
1465 | |
1466 | ## | |
5072f7b3 | 1467 | # @NewImageMode: |
1ad166b6 | 1468 | # |
a937b6aa MA |
1469 | # An enumeration that tells QEMU how to set the backing file path in a |
1470 | # new image file. | |
1ad166b6 BC |
1471 | # |
1472 | # @existing: QEMU should look for an existing image file. | |
1473 | # | |
1474 | # @absolute-paths: QEMU should create a new image with absolute paths | |
a937b6aa MA |
1475 | # for the backing file. If there is no backing file available, |
1476 | # the new image will not be backed either. | |
1ad166b6 BC |
1477 | # |
1478 | # Since: 1.1 | |
1479 | ## | |
1480 | { 'enum': 'NewImageMode', | |
1481 | 'data': [ 'existing', 'absolute-paths' ] } | |
1482 | ||
1483 | ## | |
5072f7b3 | 1484 | # @BlockdevSnapshotSync: |
1ad166b6 BC |
1485 | # |
1486 | # Either @device or @node-name must be set but not both. | |
1487 | # | |
681b86ac | 1488 | # @device: the name of the device to take a snapshot of. |
1ad166b6 | 1489 | # |
a937b6aa MA |
1490 | # @node-name: graph node name to generate the snapshot from (Since |
1491 | # 2.0) | |
1ad166b6 | 1492 | # |
a937b6aa MA |
1493 | # @snapshot-file: the target of the new overlay image. If the file |
1494 | # exists, or if it is a device, the overlay will be created in the | |
1495 | # existing file/device. Otherwise, a new file will be created. | |
1ad166b6 | 1496 | # |
a937b6aa MA |
1497 | # @snapshot-node-name: the graph node name of the new image (Since |
1498 | # 2.0) | |
1ad166b6 | 1499 | # |
681b86ac | 1500 | # @format: the format of the overlay image, default is 'qcow2'. |
1ad166b6 | 1501 | # |
1d8bda12 | 1502 | # @mode: whether and how QEMU should create a new image, default is |
9e272073 | 1503 | # 'absolute-paths'. |
1ad166b6 | 1504 | ## |
a911e6ae | 1505 | { 'struct': 'BlockdevSnapshotSync', |
1ad166b6 BC |
1506 | 'data': { '*device': 'str', '*node-name': 'str', |
1507 | 'snapshot-file': 'str', '*snapshot-node-name': 'str', | |
1508 | '*format': 'str', '*mode': 'NewImageMode' } } | |
1509 | ||
43de7e2d | 1510 | ## |
5072f7b3 | 1511 | # @BlockdevSnapshot: |
43de7e2d | 1512 | # |
681b86ac | 1513 | # @node: device or node name that will have a snapshot taken. |
43de7e2d AG |
1514 | # |
1515 | # @overlay: reference to the existing block device that will become | |
a937b6aa MA |
1516 | # the overlay of @node, as part of taking the snapshot. It must |
1517 | # not have a current backing file (this can be achieved by passing | |
1518 | # "backing": null to blockdev-add). | |
43de7e2d | 1519 | # |
5072f7b3 | 1520 | # Since: 2.5 |
43de7e2d AG |
1521 | ## |
1522 | { 'struct': 'BlockdevSnapshot', | |
1523 | 'data': { 'node': 'str', 'overlay': 'str' } } | |
1524 | ||
86c6a3b6 VSO |
1525 | ## |
1526 | # @BackupPerf: | |
1527 | # | |
a937b6aa | 1528 | # Optional parameters for backup. These parameters don't affect |
86c6a3b6 VSO |
1529 | # functionality, but may significantly affect performance. |
1530 | # | |
a937b6aa | 1531 | # @use-copy-range: Use copy offloading. Default false. |
86c6a3b6 | 1532 | # |
a937b6aa MA |
1533 | # @max-workers: Maximum number of parallel requests for the sustained |
1534 | # background copying process. Doesn't influence copy-before-write | |
1535 | # operations. Default 64. | |
2c59fd83 | 1536 | # |
a937b6aa MA |
1537 | # @max-chunk: Maximum request length for the sustained background |
1538 | # copying process. Doesn't influence copy-before-write | |
1539 | # operations. 0 means unlimited. If max-chunk is non-zero then | |
1540 | # it should not be less than job cluster size which is calculated | |
1541 | # as maximum of target image cluster size and 64k. Default 0. | |
2c59fd83 | 1542 | # |
86c6a3b6 VSO |
1543 | # Since: 6.0 |
1544 | ## | |
1545 | { 'struct': 'BackupPerf', | |
2c59fd83 VSO |
1546 | 'data': { '*use-copy-range': 'bool', |
1547 | '*max-workers': 'int', '*max-chunk': 'int64' } } | |
86c6a3b6 | 1548 | |
1ad166b6 | 1549 | ## |
3c95037a | 1550 | # @BackupCommon: |
1ad166b6 | 1551 | # |
a937b6aa MA |
1552 | # @job-id: identifier for the newly-created block job. If omitted, |
1553 | # the device name will be used. (Since 2.7) | |
70559d49 | 1554 | # |
a937b6aa MA |
1555 | # @device: the device name or node-name of a root node which should be |
1556 | # copied. | |
1ad166b6 | 1557 | # |
a937b6aa MA |
1558 | # @sync: what parts of the disk image should be copied to the |
1559 | # destination (all the disk, only the sectors allocated in the | |
1560 | # topmost image, from a dirty bitmap, or only new I/O). | |
1ad166b6 | 1561 | # |
a937b6aa MA |
1562 | # @speed: the maximum speed, in bytes per second. The default is 0, |
1563 | # for unlimited. | |
1ad166b6 | 1564 | # |
a937b6aa MA |
1565 | # @bitmap: The name of a dirty bitmap to use. Must be present if sync |
1566 | # is "bitmap" or "incremental". Can be present if sync is "full" | |
9e272073 | 1567 | # or "top". Must not be present otherwise. |
a937b6aa | 1568 | # (Since 2.4 (drive-backup), 3.1 (blockdev-backup)) |
c8b56501 | 1569 | # |
a937b6aa MA |
1570 | # @bitmap-mode: Specifies the type of data the bitmap should contain |
1571 | # after the operation concludes. Must be present if a bitmap was | |
1572 | # provided, Must NOT be present otherwise. (Since 4.2) | |
d58d8453 | 1573 | # |
1d8bda12 | 1574 | # @compress: true to compress data, if the target format supports it. |
a937b6aa | 1575 | # (default: false) (since 2.8) |
13b9414b | 1576 | # |
1d8bda12 | 1577 | # @on-source-error: the action to take on an error on the source, |
a937b6aa MA |
1578 | # default 'report'. 'stop' and 'enospc' can only be used if the |
1579 | # block device supports io-status (see BlockInfo). | |
1ad166b6 | 1580 | # |
1d8bda12 | 1581 | # @on-target-error: the action to take on an error on the target, |
a937b6aa MA |
1582 | # default 'report' (no limitations, since this applies to a |
1583 | # different block device than @device). | |
1584 | # | |
1585 | # @auto-finalize: When false, this job will wait in a PENDING state | |
1586 | # after it has finished its work, waiting for @block-job-finalize | |
1587 | # before making any block graph changes. When true, this job will | |
1588 | # automatically perform its abort or commit actions. Defaults to | |
1589 | # true. (Since 2.12) | |
1590 | # | |
1591 | # @auto-dismiss: When false, this job will wait in a CONCLUDED state | |
1592 | # after it has completely ceased all work, and awaits | |
1593 | # @block-job-dismiss. When true, this job will automatically | |
1594 | # disappear from the query list without user intervention. | |
1595 | # Defaults to true. (Since 2.12) | |
b40dacdc | 1596 | # |
00e30f05 | 1597 | # @filter-node-name: the node name that should be assigned to the |
a937b6aa MA |
1598 | # filter driver that the backup job inserts into the graph above |
1599 | # node specified by @drive. If this option is not given, a node | |
1600 | # name is autogenerated. (Since: 4.2) | |
00e30f05 | 1601 | # |
a937b6aa | 1602 | # @x-perf: Performance options. (Since 6.0) |
86c6a3b6 | 1603 | # |
9fb49daa | 1604 | # Features: |
a937b6aa | 1605 | # |
9fb49daa MA |
1606 | # @unstable: Member @x-perf is experimental. |
1607 | # | |
5072f7b3 | 1608 | # Note: @on-source-error and @on-target-error only affect background |
a937b6aa MA |
1609 | # I/O. If an error occurs during a guest write request, the |
1610 | # device's rerror/werror actions will be used. | |
1ad166b6 | 1611 | # |
3c95037a | 1612 | # Since: 4.2 |
1ad166b6 | 1613 | ## |
3c95037a JS |
1614 | { 'struct': 'BackupCommon', |
1615 | 'data': { '*job-id': 'str', 'device': 'str', | |
1616 | 'sync': 'MirrorSyncMode', '*speed': 'int', | |
c8b56501 JS |
1617 | '*bitmap': 'str', '*bitmap-mode': 'BitmapSyncMode', |
1618 | '*compress': 'bool', | |
1ad166b6 | 1619 | '*on-source-error': 'BlockdevOnError', |
b40dacdc | 1620 | '*on-target-error': 'BlockdevOnError', |
00e30f05 | 1621 | '*auto-finalize': 'bool', '*auto-dismiss': 'bool', |
9fb49daa MA |
1622 | '*filter-node-name': 'str', |
1623 | '*x-perf': { 'type': 'BackupPerf', | |
1624 | 'features': [ 'unstable' ] } } } | |
1ad166b6 | 1625 | |
c29c1dd3 | 1626 | ## |
3c95037a | 1627 | # @DriveBackup: |
3b7b1236 | 1628 | # |
a937b6aa MA |
1629 | # @target: the target of the new image. If the file exists, or if it |
1630 | # is a device, the existing file/device will be used as the new | |
1631 | # destination. If it does not exist, a new file will be created. | |
c29c1dd3 | 1632 | # |
a937b6aa MA |
1633 | # @format: the format of the new destination, default is to probe if |
1634 | # @mode is 'existing', else the format of the source | |
c29c1dd3 | 1635 | # |
3c95037a | 1636 | # @mode: whether and how QEMU should create a new image, default is |
a937b6aa | 1637 | # 'absolute-paths'. |
b40dacdc | 1638 | # |
3c95037a JS |
1639 | # Since: 1.6 |
1640 | ## | |
1641 | { 'struct': 'DriveBackup', | |
1642 | 'base': 'BackupCommon', | |
1643 | 'data': { 'target': 'str', | |
1644 | '*format': 'str', | |
1645 | '*mode': 'NewImageMode' } } | |
1646 | ||
1647 | ## | |
1648 | # @BlockdevBackup: | |
b40dacdc | 1649 | # |
3c95037a | 1650 | # @target: the device name or node-name of the backup target node. |
c29c1dd3 FZ |
1651 | # |
1652 | # Since: 2.3 | |
1653 | ## | |
895a2a80 | 1654 | { 'struct': 'BlockdevBackup', |
3c95037a JS |
1655 | 'base': 'BackupCommon', |
1656 | 'data': { 'target': 'str' } } | |
c29c1dd3 | 1657 | |
1ad166b6 | 1658 | ## |
5072f7b3 | 1659 | # @blockdev-snapshot-sync: |
1ad166b6 | 1660 | # |
681b86ac | 1661 | # Takes a synchronous snapshot of a block device. |
1ad166b6 | 1662 | # |
a911e6ae | 1663 | # For the arguments, see the documentation of BlockdevSnapshotSync. |
1ad166b6 | 1664 | # |
a937b6aa MA |
1665 | # Returns: |
1666 | # - nothing on success | |
1667 | # - If @device is not a valid block device, DeviceNotFound | |
1ad166b6 | 1668 | # |
9bc6e893 | 1669 | # Since: 0.14 |
b4039d8d MAL |
1670 | # |
1671 | # Example: | |
1672 | # | |
1673 | # -> { "execute": "blockdev-snapshot-sync", | |
1674 | # "arguments": { "device": "ide-hd0", | |
1675 | # "snapshot-file": | |
1676 | # "/some/place/my-image", | |
1677 | # "format": "qcow2" } } | |
1678 | # <- { "return": {} } | |
1ad166b6 BC |
1679 | ## |
1680 | { 'command': 'blockdev-snapshot-sync', | |
f55ba801 PB |
1681 | 'data': 'BlockdevSnapshotSync', |
1682 | 'allow-preconfig': true } | |
1ad166b6 | 1683 | |
43de7e2d | 1684 | ## |
5072f7b3 | 1685 | # @blockdev-snapshot: |
43de7e2d | 1686 | # |
681b86ac | 1687 | # Takes a snapshot of a block device. |
43de7e2d | 1688 | # |
681b86ac | 1689 | # Take a snapshot, by installing 'node' as the backing image of |
3282eca4 | 1690 | # 'overlay'. Additionally, if 'node' is associated with a block |
a937b6aa MA |
1691 | # device, the block device changes to using 'overlay' as its new |
1692 | # active image. | |
3282eca4 | 1693 | # |
43de7e2d AG |
1694 | # For the arguments, see the documentation of BlockdevSnapshot. |
1695 | # | |
c6bdc312 | 1696 | # Features: |
a937b6aa MA |
1697 | # |
1698 | # @allow-write-only-overlay: If present, the check whether this | |
1699 | # operation is safe was relaxed so that it can be used to change | |
1700 | # backing file of a destination of a blockdev-mirror. (since 5.0) | |
c6bdc312 | 1701 | # |
5072f7b3 | 1702 | # Since: 2.5 |
3282eca4 MAL |
1703 | # |
1704 | # Example: | |
1705 | # | |
1706 | # -> { "execute": "blockdev-add", | |
244d04db EB |
1707 | # "arguments": { "driver": "qcow2", |
1708 | # "node-name": "node1534", | |
34f58df5 MA |
1709 | # "file": { "driver": "file", |
1710 | # "filename": "hd1.qcow2" }, | |
4f7be280 | 1711 | # "backing": null } } |
3282eca4 MAL |
1712 | # |
1713 | # <- { "return": {} } | |
1714 | # | |
1715 | # -> { "execute": "blockdev-snapshot", | |
1716 | # "arguments": { "node": "ide-hd0", | |
1717 | # "overlay": "node1534" } } | |
1718 | # <- { "return": {} } | |
43de7e2d AG |
1719 | ## |
1720 | { 'command': 'blockdev-snapshot', | |
c6bdc312 | 1721 | 'data': 'BlockdevSnapshot', |
f55ba801 PB |
1722 | 'features': [ 'allow-write-only-overlay' ], |
1723 | 'allow-preconfig': true } | |
43de7e2d | 1724 | |
fa40e656 | 1725 | ## |
5072f7b3 | 1726 | # @change-backing-file: |
fa40e656 JC |
1727 | # |
1728 | # Change the backing file in the image file metadata. This does not | |
1729 | # cause QEMU to reopen the image file to reparse the backing filename | |
a937b6aa MA |
1730 | # (it may, however, perform a reopen to change permissions from r/o -> |
1731 | # r/w -> r/o, if needed). The new backing file string is written into | |
1732 | # the image file metadata, and the QEMU internal strings are updated. | |
fa40e656 JC |
1733 | # |
1734 | # @image-node-name: The name of the block driver state node of the | |
a937b6aa MA |
1735 | # image to modify. The "device" argument is used to verify |
1736 | # "image-node-name" is in the chain described by "device". | |
fa40e656 | 1737 | # |
26ec4e53 | 1738 | # @device: The device name or node-name of the root node that owns |
a937b6aa | 1739 | # image-node-name. |
fa40e656 | 1740 | # |
a937b6aa MA |
1741 | # @backing-file: The string to write as the backing file. This string |
1742 | # is not validated, so care should be taken when specifying the | |
1743 | # string or the image chain may not be able to be reopened again. | |
fa40e656 | 1744 | # |
a937b6aa MA |
1745 | # Returns: |
1746 | # - Nothing on success | |
1747 | # - If "device" does not exist or cannot be determined, | |
1748 | # DeviceNotFound | |
280c4b3c | 1749 | # |
fa40e656 JC |
1750 | # Since: 2.1 |
1751 | ## | |
1752 | { 'command': 'change-backing-file', | |
1753 | 'data': { 'device': 'str', 'image-node-name': 'str', | |
f55ba801 PB |
1754 | 'backing-file': 'str' }, |
1755 | 'allow-preconfig': true } | |
fa40e656 | 1756 | |
1ad166b6 | 1757 | ## |
5072f7b3 | 1758 | # @block-commit: |
1ad166b6 | 1759 | # |
a937b6aa MA |
1760 | # Live commit of data from overlay image nodes into backing nodes - |
1761 | # i.e., writes data between 'top' and 'base' into 'base'. | |
1ad166b6 | 1762 | # |
a937b6aa MA |
1763 | # If top == base, that is an error. If top has no overlays on top of |
1764 | # it, or if it is in use by a writer, the job will not be completed by | |
1765 | # itself. The user needs to complete the job with the | |
1766 | # block-job-complete command after getting the ready event. (Since | |
1767 | # 2.0) | |
05ea385a HR |
1768 | # |
1769 | # If the base image is smaller than top, then the base image will be | |
1770 | # resized to be the same size as top. If top is smaller than the base | |
1771 | # image, the base will not be truncated. If you want the base image | |
1772 | # size to match the size of the smaller top, you can safely truncate | |
1773 | # it yourself once the commit operation successfully completes. | |
1774 | # | |
a937b6aa MA |
1775 | # @job-id: identifier for the newly-created block job. If omitted, |
1776 | # the device name will be used. (Since 2.7) | |
fd62c609 | 1777 | # |
26ec4e53 | 1778 | # @device: the device name or node-name of a root node |
1ad166b6 | 1779 | # |
3c605f40 | 1780 | # @base-node: The node name of the backing image to write data into. |
a937b6aa MA |
1781 | # If not specified, this is the deepest backing image. |
1782 | # (since: 3.1) | |
1ad166b6 | 1783 | # |
a937b6aa MA |
1784 | # @base: Same as @base-node, except that it is a file name rather than |
1785 | # a node name. This must be the exact filename string that was | |
1786 | # used to open the node; other strings, even if addressing the | |
1787 | # same file, are not accepted | |
3c605f40 KW |
1788 | # |
1789 | # @top-node: The node name of the backing image within the image chain | |
a937b6aa MA |
1790 | # which contains the topmost data to be committed down. If not |
1791 | # specified, this is the active layer. (since: 3.1) | |
3c605f40 | 1792 | # |
a937b6aa MA |
1793 | # @top: Same as @top-node, except that it is a file name rather than a |
1794 | # node name. This must be the exact filename string that was used | |
1795 | # to open the node; other strings, even if addressing the same | |
1796 | # file, are not accepted | |
1ad166b6 | 1797 | # |
26ec4e53 | 1798 | # @backing-file: The backing file string to write into the overlay |
a937b6aa MA |
1799 | # image of 'top'. If 'top' does not have an overlay image, or if |
1800 | # 'top' is in use by a writer, specifying a backing file string is | |
1801 | # an error. | |
1802 | # | |
1803 | # This filename is not validated. If a pathname string is such | |
1804 | # that it cannot be resolved by QEMU, that means that subsequent | |
1805 | # QMP or HMP commands must use node-names for the image in | |
1806 | # question, as filename lookup methods will fail. | |
1807 | # | |
1808 | # If not specified, QEMU will automatically determine the backing | |
1809 | # file string to use, or error out if there is no obvious choice. | |
1810 | # Care should be taken when specifying the string, to specify a | |
1811 | # valid filename or protocol. (Since 2.1) | |
26ec4e53 | 1812 | # |
4b028cbe PK |
1813 | # @backing-mask-protocol: If true, replace any protocol mentioned in the |
1814 | # 'backing file format' with 'raw', rather than storing the protocol | |
1815 | # name as the backing format. Can be used even when no image header | |
1816 | # will be updated (default false; since 9.0). | |
1817 | # | |
26ec4e53 | 1818 | # @speed: the maximum speed, in bytes per second |
1ad166b6 | 1819 | # |
a937b6aa MA |
1820 | # @on-error: the action to take on an error. 'ignore' means that the |
1821 | # request should be retried. (default: report; Since: 5.0) | |
8faad1c7 | 1822 | # |
1d8bda12 | 1823 | # @filter-node-name: the node name that should be assigned to the |
a937b6aa MA |
1824 | # filter driver that the commit job inserts into the graph above |
1825 | # @top. If this option is not given, a node name is | |
1826 | # autogenerated. (Since: 2.9) | |
1827 | # | |
1828 | # @auto-finalize: When false, this job will wait in a PENDING state | |
1829 | # after it has finished its work, waiting for @block-job-finalize | |
1830 | # before making any block graph changes. When true, this job will | |
1831 | # automatically perform its abort or commit actions. Defaults to | |
1832 | # true. (Since 3.1) | |
1833 | # | |
1834 | # @auto-dismiss: When false, this job will wait in a CONCLUDED state | |
1835 | # after it has completely ceased all work, and awaits | |
1836 | # @block-job-dismiss. When true, this job will automatically | |
1837 | # disappear from the query list without user intervention. | |
1838 | # Defaults to true. (Since 3.1) | |
96fbf534 | 1839 | # |
df4097ae | 1840 | # Features: |
a937b6aa | 1841 | # |
df4097ae | 1842 | # @deprecated: Members @base and @top are deprecated. Use @base-node |
a937b6aa | 1843 | # and @top-node instead. |
df4097ae | 1844 | # |
a937b6aa MA |
1845 | # Returns: |
1846 | # - Nothing on success | |
1847 | # - If @device does not exist, DeviceNotFound | |
1848 | # - Any other error returns a GenericError. | |
1ad166b6 BC |
1849 | # |
1850 | # Since: 1.3 | |
1851 | # | |
f44fb58f MAL |
1852 | # Example: |
1853 | # | |
1854 | # -> { "execute": "block-commit", | |
1855 | # "arguments": { "device": "virtio0", | |
1856 | # "top": "/tmp/snap1.qcow2" } } | |
1857 | # <- { "return": {} } | |
1ad166b6 BC |
1858 | ## |
1859 | { 'command': 'block-commit', | |
3c605f40 | 1860 | 'data': { '*job-id': 'str', 'device': 'str', '*base-node': 'str', |
df4097ae MA |
1861 | '*base': { 'type': 'str', 'features': [ 'deprecated' ] }, |
1862 | '*top-node': 'str', | |
1863 | '*top': { 'type': 'str', 'features': [ 'deprecated' ] }, | |
4b028cbe PK |
1864 | '*backing-file': 'str', '*backing-mask-protocol': 'bool', |
1865 | '*speed': 'int', | |
8faad1c7 | 1866 | '*on-error': 'BlockdevOnError', |
96fbf534 | 1867 | '*filter-node-name': 'str', |
f55ba801 PB |
1868 | '*auto-finalize': 'bool', '*auto-dismiss': 'bool' }, |
1869 | 'allow-preconfig': true } | |
1ad166b6 BC |
1870 | |
1871 | ## | |
5072f7b3 | 1872 | # @drive-backup: |
1ad166b6 | 1873 | # |
a937b6aa MA |
1874 | # Start a point-in-time copy of a block device to a new destination. |
1875 | # The status of ongoing drive-backup operations can be checked with | |
1876 | # query-block-jobs where the BlockJobInfo.type field has the value | |
1877 | # 'backup'. The operation can be stopped before it has completed using | |
1878 | # the block-job-cancel command. | |
1ad166b6 | 1879 | # |
1084159b | 1880 | # Features: |
1084159b | 1881 | # |
a937b6aa MA |
1882 | # @deprecated: This command is deprecated. Use @blockdev-backup |
1883 | # instead. | |
1884 | # | |
1885 | # Returns: | |
1886 | # - nothing on success | |
1887 | # - If @device is not a valid block device, GenericError | |
1ad166b6 | 1888 | # |
5072f7b3 | 1889 | # Since: 1.6 |
b0336412 MAL |
1890 | # |
1891 | # Example: | |
1892 | # | |
1893 | # -> { "execute": "drive-backup", | |
1894 | # "arguments": { "device": "drive0", | |
1895 | # "sync": "full", | |
1896 | # "target": "backup.img" } } | |
1897 | # <- { "return": {} } | |
1ad166b6 | 1898 | ## |
81206a89 | 1899 | { 'command': 'drive-backup', 'boxed': true, |
f55ba801 PB |
1900 | 'data': 'DriveBackup', 'features': ['deprecated'], |
1901 | 'allow-preconfig': true } | |
1ad166b6 | 1902 | |
c29c1dd3 | 1903 | ## |
5072f7b3 | 1904 | # @blockdev-backup: |
c29c1dd3 | 1905 | # |
a937b6aa MA |
1906 | # Start a point-in-time copy of a block device to a new destination. |
1907 | # The status of ongoing blockdev-backup operations can be checked with | |
1908 | # query-block-jobs where the BlockJobInfo.type field has the value | |
1909 | # 'backup'. The operation can be stopped before it has completed using | |
1910 | # the block-job-cancel command. | |
c29c1dd3 | 1911 | # |
a937b6aa MA |
1912 | # Returns: |
1913 | # - nothing on success | |
1914 | # - If @device is not a valid block device, DeviceNotFound | |
dc7a4a9e | 1915 | # |
5072f7b3 | 1916 | # Since: 2.3 |
1cf75113 MAL |
1917 | # |
1918 | # Example: | |
4ae65a52 | 1919 | # |
1cf75113 MAL |
1920 | # -> { "execute": "blockdev-backup", |
1921 | # "arguments": { "device": "src-id", | |
1922 | # "sync": "full", | |
1923 | # "target": "tgt-id" } } | |
1924 | # <- { "return": {} } | |
c29c1dd3 | 1925 | ## |
dc7a4a9e | 1926 | { 'command': 'blockdev-backup', 'boxed': true, |
f55ba801 PB |
1927 | 'data': 'BlockdevBackup', |
1928 | 'allow-preconfig': true } | |
c29c1dd3 | 1929 | |
1ad166b6 | 1930 | ## |
5072f7b3 | 1931 | # @query-named-block-nodes: |
1ad166b6 BC |
1932 | # |
1933 | # Get the named block driver list | |
1934 | # | |
a937b6aa MA |
1935 | # @flat: Omit the nested data about backing image ("backing-image" |
1936 | # key) if true. Default is false (Since 5.0) | |
facda544 | 1937 | # |
1ad166b6 BC |
1938 | # Returns: the list of BlockDeviceInfo |
1939 | # | |
5072f7b3 | 1940 | # Since: 2.0 |
e1f34cb2 MAL |
1941 | # |
1942 | # Example: | |
1943 | # | |
1944 | # -> { "execute": "query-named-block-nodes" } | |
1945 | # <- { "return": [ { "ro":false, | |
1946 | # "drv":"qcow2", | |
1947 | # "encrypted":false, | |
1948 | # "file":"disks/test.qcow2", | |
1949 | # "node-name": "my-node", | |
1950 | # "backing_file_depth":1, | |
016b8359 | 1951 | # "detect_zeroes":"off", |
e1f34cb2 MAL |
1952 | # "bps":1000000, |
1953 | # "bps_rd":0, | |
1954 | # "bps_wr":0, | |
1955 | # "iops":1000000, | |
1956 | # "iops_rd":0, | |
1957 | # "iops_wr":0, | |
1958 | # "bps_max": 8000000, | |
1959 | # "bps_rd_max": 0, | |
1960 | # "bps_wr_max": 0, | |
1961 | # "iops_max": 0, | |
1962 | # "iops_rd_max": 0, | |
1963 | # "iops_wr_max": 0, | |
1964 | # "iops_size": 0, | |
1965 | # "write_threshold": 0, | |
1966 | # "image":{ | |
1967 | # "filename":"disks/test.qcow2", | |
1968 | # "format":"qcow2", | |
1969 | # "virtual-size":2048000, | |
1970 | # "backing_file":"base.qcow2", | |
1971 | # "full-backing-filename":"disks/base.qcow2", | |
1972 | # "backing-filename-format":"qcow2", | |
1973 | # "snapshots":[ | |
1974 | # { | |
1975 | # "id": "1", | |
1976 | # "name": "snapshot1", | |
1977 | # "vm-state-size": 0, | |
1978 | # "date-sec": 10000200, | |
1979 | # "date-nsec": 12, | |
1980 | # "vm-clock-sec": 206, | |
1981 | # "vm-clock-nsec": 30 | |
1982 | # } | |
1983 | # ], | |
1984 | # "backing-image":{ | |
1985 | # "filename":"disks/base.qcow2", | |
1986 | # "format":"qcow2", | |
1987 | # "virtual-size":2048000 | |
1988 | # } | |
1989 | # } } ] } | |
1ad166b6 | 1990 | ## |
facda544 PK |
1991 | { 'command': 'query-named-block-nodes', |
1992 | 'returns': [ 'BlockDeviceInfo' ], | |
f55ba801 PB |
1993 | 'data': { '*flat': 'bool' }, |
1994 | 'allow-preconfig': true } | |
1ad166b6 | 1995 | |
5d3b4e99 VSO |
1996 | ## |
1997 | # @XDbgBlockGraphNodeType: | |
1998 | # | |
1999 | # @block-backend: corresponds to BlockBackend | |
2000 | # | |
2400e50c | 2001 | # @block-job: corresponds to BlockJob |
5d3b4e99 VSO |
2002 | # |
2003 | # @block-driver: corresponds to BlockDriverState | |
2004 | # | |
2005 | # Since: 4.0 | |
2006 | ## | |
2007 | { 'enum': 'XDbgBlockGraphNodeType', | |
2008 | 'data': [ 'block-backend', 'block-job', 'block-driver' ] } | |
2009 | ||
2010 | ## | |
2011 | # @XDbgBlockGraphNode: | |
2012 | # | |
a937b6aa MA |
2013 | # @id: Block graph node identifier. This @id is generated only for |
2014 | # x-debug-query-block-graph and does not relate to any other | |
2015 | # identifiers in Qemu. | |
5d3b4e99 | 2016 | # |
a937b6aa MA |
2017 | # @type: Type of graph node. Can be one of block-backend, block-job |
2018 | # or block-driver-state. | |
5d3b4e99 | 2019 | # |
a937b6aa MA |
2020 | # @name: Human readable name of the node. Corresponds to node-name |
2021 | # for block-driver-state nodes; is not guaranteed to be unique in | |
2022 | # the whole graph (with block-jobs and block-backends). | |
5d3b4e99 VSO |
2023 | # |
2024 | # Since: 4.0 | |
2025 | ## | |
2026 | { 'struct': 'XDbgBlockGraphNode', | |
2027 | 'data': { 'id': 'uint64', 'type': 'XDbgBlockGraphNodeType', 'name': 'str' } } | |
2028 | ||
2029 | ## | |
2030 | # @BlockPermission: | |
2031 | # | |
2032 | # Enum of base block permissions. | |
2033 | # | |
a937b6aa MA |
2034 | # @consistent-read: A user that has the "permission" of consistent |
2035 | # reads is guaranteed that their view of the contents of the block | |
2036 | # device is complete and self-consistent, representing the | |
2037 | # contents of a disk at a specific point. For most block devices | |
2038 | # (including their backing files) this is true, but the property | |
2039 | # cannot be maintained in a few situations like for intermediate | |
2040 | # nodes of a commit block job. | |
5d3b4e99 | 2041 | # |
a937b6aa MA |
2042 | # @write: This permission is required to change the visible disk |
2043 | # contents. | |
5d3b4e99 | 2044 | # |
a937b6aa MA |
2045 | # @write-unchanged: This permission (which is weaker than |
2046 | # BLK_PERM_WRITE) is both enough and required for writes to the | |
2047 | # block node when the caller promises that the visible disk | |
2048 | # content doesn't change. As the BLK_PERM_WRITE permission is | |
2049 | # strictly stronger, either is sufficient to perform an unchanging | |
2050 | # write. | |
5d3b4e99 | 2051 | # |
a937b6aa MA |
2052 | # @resize: This permission is required to change the size of a block |
2053 | # node. | |
5d3b4e99 | 2054 | # |
5d3b4e99 VSO |
2055 | # Since: 4.0 |
2056 | ## | |
fbeed197 | 2057 | { 'enum': 'BlockPermission', |
64631f36 VSO |
2058 | 'data': [ 'consistent-read', 'write', 'write-unchanged', 'resize' ] } |
2059 | ||
5d3b4e99 VSO |
2060 | ## |
2061 | # @XDbgBlockGraphEdge: | |
2062 | # | |
2063 | # Block Graph edge description for x-debug-query-block-graph. | |
2064 | # | |
2065 | # @parent: parent id | |
2066 | # | |
2067 | # @child: child id | |
2068 | # | |
2069 | # @name: name of the relation (examples are 'file' and 'backing') | |
2070 | # | |
2071 | # @perm: granted permissions for the parent operating on the child | |
2072 | # | |
a937b6aa MA |
2073 | # @shared-perm: permissions that can still be granted to other users |
2074 | # of the child while it is still attached to this parent | |
5d3b4e99 VSO |
2075 | # |
2076 | # Since: 4.0 | |
2077 | ## | |
2078 | { 'struct': 'XDbgBlockGraphEdge', | |
2079 | 'data': { 'parent': 'uint64', 'child': 'uint64', | |
2080 | 'name': 'str', 'perm': [ 'BlockPermission' ], | |
2081 | 'shared-perm': [ 'BlockPermission' ] } } | |
2082 | ||
2083 | ## | |
2084 | # @XDbgBlockGraph: | |
2085 | # | |
2086 | # Block Graph - list of nodes and list of edges. | |
2087 | # | |
2088 | # Since: 4.0 | |
2089 | ## | |
2090 | { 'struct': 'XDbgBlockGraph', | |
2091 | 'data': { 'nodes': ['XDbgBlockGraphNode'], 'edges': ['XDbgBlockGraphEdge'] } } | |
2092 | ||
2093 | ## | |
2094 | # @x-debug-query-block-graph: | |
2095 | # | |
2096 | # Get the block graph. | |
2097 | # | |
9fb49daa | 2098 | # Features: |
a937b6aa | 2099 | # |
9fb49daa MA |
2100 | # @unstable: This command is meant for debugging. |
2101 | # | |
5d3b4e99 VSO |
2102 | # Since: 4.0 |
2103 | ## | |
9fb49daa | 2104 | { 'command': 'x-debug-query-block-graph', 'returns': 'XDbgBlockGraph', |
f55ba801 PB |
2105 | 'features': [ 'unstable' ], |
2106 | 'allow-preconfig': true } | |
5d3b4e99 | 2107 | |
1ad166b6 | 2108 | ## |
5072f7b3 | 2109 | # @drive-mirror: |
1ad166b6 | 2110 | # |
a937b6aa MA |
2111 | # Start mirroring a block device's writes to a new destination. |
2112 | # target specifies the target of the new image. If the file exists, | |
2113 | # or if it is a device, it will be used as the new destination for | |
2114 | # writes. If it does not exist, a new file will be created. format | |
2115 | # specifies the format of the mirror image, default is to probe if | |
2116 | # mode='existing', else the format of the source. | |
1ad166b6 | 2117 | # |
a937b6aa MA |
2118 | # Returns: |
2119 | # - nothing on success | |
2120 | # - If @device is not a valid block device, GenericError | |
faecd40a | 2121 | # |
5072f7b3 | 2122 | # Since: 1.3 |
12a21b73 MAL |
2123 | # |
2124 | # Example: | |
2125 | # | |
2126 | # -> { "execute": "drive-mirror", | |
2127 | # "arguments": { "device": "ide-hd0", | |
2128 | # "target": "/some/place/my-image", | |
2129 | # "sync": "full", | |
2130 | # "format": "qcow2" } } | |
2131 | # <- { "return": {} } | |
faecd40a EB |
2132 | ## |
2133 | { 'command': 'drive-mirror', 'boxed': true, | |
f55ba801 PB |
2134 | 'data': 'DriveMirror', |
2135 | 'allow-preconfig': true } | |
faecd40a EB |
2136 | |
2137 | ## | |
5072f7b3 | 2138 | # @DriveMirror: |
faecd40a EB |
2139 | # |
2140 | # A set of parameters describing drive mirror setup. | |
2141 | # | |
a937b6aa MA |
2142 | # @job-id: identifier for the newly-created block job. If omitted, |
2143 | # the device name will be used. (Since 2.7) | |
71aa9867 | 2144 | # |
a937b6aa MA |
2145 | # @device: the device name or node-name of a root node whose writes |
2146 | # should be mirrored. | |
1ad166b6 | 2147 | # |
a937b6aa MA |
2148 | # @target: the target of the new image. If the file exists, or if it |
2149 | # is a device, the existing file/device will be used as the new | |
2150 | # destination. If it does not exist, a new file will be created. | |
1ad166b6 | 2151 | # |
a937b6aa MA |
2152 | # @format: the format of the new destination, default is to probe if |
2153 | # @mode is 'existing', else the format of the source | |
1ad166b6 | 2154 | # |
a937b6aa MA |
2155 | # @node-name: the new block driver state node name in the graph (Since |
2156 | # 2.1) | |
4c828dc6 | 2157 | # |
1d8bda12 | 2158 | # @replaces: with sync=full graph node name to be replaced by the new |
a937b6aa MA |
2159 | # image when a whole image copy is done. This can be used to |
2160 | # repair broken Quorum files. By default, @device is replaced, | |
2161 | # although implicitly created filters on it are kept. (Since 2.1) | |
09158f00 | 2162 | # |
1d8bda12 | 2163 | # @mode: whether and how QEMU should create a new image, default is |
a937b6aa | 2164 | # 'absolute-paths'. |
1ad166b6 | 2165 | # |
23e46452 | 2166 | # @speed: the maximum speed, in bytes per second |
1ad166b6 | 2167 | # |
a937b6aa MA |
2168 | # @sync: what parts of the disk image should be copied to the |
2169 | # destination (all the disk, only the sectors allocated in the | |
2170 | # topmost image, or only new I/O). | |
1ad166b6 | 2171 | # |
a937b6aa MA |
2172 | # @granularity: granularity of the dirty bitmap, default is 64K if the |
2173 | # image format doesn't have clusters, 4K if the clusters are | |
2174 | # smaller than that, else the cluster size. Must be a power of 2 | |
2175 | # between 512 and 64M (since 1.4). | |
1ad166b6 | 2176 | # |
a937b6aa MA |
2177 | # @buf-size: maximum amount of data in flight from source to target |
2178 | # (since 1.4). | |
1ad166b6 | 2179 | # |
1d8bda12 | 2180 | # @on-source-error: the action to take on an error on the source, |
a937b6aa MA |
2181 | # default 'report'. 'stop' and 'enospc' can only be used if the |
2182 | # block device supports io-status (see BlockInfo). | |
1ad166b6 | 2183 | # |
1d8bda12 | 2184 | # @on-target-error: the action to take on an error on the target, |
a937b6aa MA |
2185 | # default 'report' (no limitations, since this applies to a |
2186 | # different block device than @device). | |
2187 | # | |
2188 | # @unmap: Whether to try to unmap target sectors where source has only | |
2189 | # zero. If true, and target unallocated sectors will read as | |
2190 | # zero, target image sectors will be unmapped; otherwise, zeroes | |
2191 | # will be written. Both will result in identical contents. | |
2192 | # Default is true. (Since 2.4) | |
2193 | # | |
2194 | # @copy-mode: when to copy data to the destination; defaults to | |
2195 | # 'background' (Since: 3.0) | |
2196 | # | |
2197 | # @auto-finalize: When false, this job will wait in a PENDING state | |
2198 | # after it has finished its work, waiting for @block-job-finalize | |
2199 | # before making any block graph changes. When true, this job will | |
2200 | # automatically perform its abort or commit actions. Defaults to | |
2201 | # true. (Since 3.1) | |
2202 | # | |
2203 | # @auto-dismiss: When false, this job will wait in a CONCLUDED state | |
2204 | # after it has completely ceased all work, and awaits | |
2205 | # @block-job-dismiss. When true, this job will automatically | |
2206 | # disappear from the query list without user intervention. | |
2207 | # Defaults to true. (Since 3.1) | |
4ae65a52 | 2208 | # |
5072f7b3 | 2209 | # Since: 1.3 |
1ad166b6 | 2210 | ## |
faecd40a | 2211 | { 'struct': 'DriveMirror', |
71aa9867 AG |
2212 | 'data': { '*job-id': 'str', 'device': 'str', 'target': 'str', |
2213 | '*format': 'str', '*node-name': 'str', '*replaces': 'str', | |
1ad166b6 BC |
2214 | 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode', |
2215 | '*speed': 'int', '*granularity': 'uint32', | |
2216 | '*buf-size': 'int', '*on-source-error': 'BlockdevOnError', | |
0fc9f8ea | 2217 | '*on-target-error': 'BlockdevOnError', |
a6b58ade JS |
2218 | '*unmap': 'bool', '*copy-mode': 'MirrorCopyMode', |
2219 | '*auto-finalize': 'bool', '*auto-dismiss': 'bool' } } | |
1ad166b6 | 2220 | |
341ebc2f | 2221 | ## |
5072f7b3 | 2222 | # @BlockDirtyBitmap: |
341ebc2f JS |
2223 | # |
2224 | # @node: name of device/node which the bitmap is tracking | |
2225 | # | |
2226 | # @name: name of the dirty bitmap | |
2227 | # | |
5072f7b3 | 2228 | # Since: 2.4 |
341ebc2f | 2229 | ## |
895a2a80 | 2230 | { 'struct': 'BlockDirtyBitmap', |
341ebc2f JS |
2231 | 'data': { 'node': 'str', 'name': 'str' } } |
2232 | ||
2233 | ## | |
5072f7b3 | 2234 | # @BlockDirtyBitmapAdd: |
341ebc2f JS |
2235 | # |
2236 | # @node: name of device/node which the bitmap is tracking | |
2237 | # | |
cf7c49cf | 2238 | # @name: name of the dirty bitmap (must be less than 1024 bytes) |
341ebc2f | 2239 | # |
1d8bda12 | 2240 | # @granularity: the bitmap granularity, default is 64k for |
a937b6aa | 2241 | # block-dirty-bitmap-add |
341ebc2f | 2242 | # |
fd5ae4cc | 2243 | # @persistent: the bitmap is persistent, i.e. it will be saved to the |
a937b6aa MA |
2244 | # corresponding block device image file on its close. For now |
2245 | # only Qcow2 disks support persistent bitmaps. Default is false | |
2246 | # for block-dirty-bitmap-add. (Since: 2.10) | |
fd5ae4cc | 2247 | # |
a937b6aa MA |
2248 | # @disabled: the bitmap is created in the disabled state, which means |
2249 | # that it will not track drive changes. The bitmap may be enabled | |
2250 | # with block-dirty-bitmap-enable. Default is false. (Since: 4.0) | |
a6e2ca5f | 2251 | # |
5072f7b3 | 2252 | # Since: 2.4 |
341ebc2f | 2253 | ## |
895a2a80 | 2254 | { 'struct': 'BlockDirtyBitmapAdd', |
fd5ae4cc | 2255 | 'data': { 'node': 'str', 'name': 'str', '*granularity': 'uint32', |
3264ffce | 2256 | '*persistent': 'bool', '*disabled': 'bool' } } |
341ebc2f | 2257 | |
eff0829b | 2258 | ## |
1466ef6c | 2259 | # @BlockDirtyBitmapOrStr: |
eff0829b | 2260 | # |
a937b6aa MA |
2261 | # @local: name of the bitmap, attached to the same node as target |
2262 | # bitmap. | |
eff0829b VSO |
2263 | # |
2264 | # @external: bitmap with specified node | |
2265 | # | |
2266 | # Since: 4.1 | |
2267 | ## | |
1466ef6c | 2268 | { 'alternate': 'BlockDirtyBitmapOrStr', |
eff0829b VSO |
2269 | 'data': { 'local': 'str', |
2270 | 'external': 'BlockDirtyBitmap' } } | |
2271 | ||
b598e531 VSO |
2272 | ## |
2273 | # @BlockDirtyBitmapMerge: | |
2274 | # | |
eff0829b | 2275 | # @node: name of device/node which the @target bitmap is tracking |
b598e531 | 2276 | # |
360d4e4e | 2277 | # @target: name of the destination dirty bitmap |
b598e531 | 2278 | # |
a937b6aa MA |
2279 | # @bitmaps: name(s) of the source dirty bitmap(s) at @node and/or |
2280 | # fully specified BlockDirtyBitmap elements. The latter are | |
2281 | # supported since 4.1. | |
b598e531 | 2282 | # |
0e2b7f09 | 2283 | # Since: 4.0 |
b598e531 VSO |
2284 | ## |
2285 | { 'struct': 'BlockDirtyBitmapMerge', | |
eff0829b | 2286 | 'data': { 'node': 'str', 'target': 'str', |
1466ef6c | 2287 | 'bitmaps': ['BlockDirtyBitmapOrStr'] } } |
b598e531 | 2288 | |
341ebc2f | 2289 | ## |
5072f7b3 | 2290 | # @block-dirty-bitmap-add: |
341ebc2f | 2291 | # |
a937b6aa MA |
2292 | # Create a dirty bitmap with a name on the node, and start tracking |
2293 | # the writes. | |
341ebc2f | 2294 | # |
a937b6aa MA |
2295 | # Returns: |
2296 | # - nothing on success | |
2297 | # - If @node is not a valid block device or node, DeviceNotFound | |
2298 | # - If @name is already taken, GenericError with an explanation | |
341ebc2f | 2299 | # |
5072f7b3 | 2300 | # Since: 2.4 |
2258a5db MAL |
2301 | # |
2302 | # Example: | |
2303 | # | |
2304 | # -> { "execute": "block-dirty-bitmap-add", | |
2305 | # "arguments": { "node": "drive0", "name": "bitmap0" } } | |
2306 | # <- { "return": {} } | |
341ebc2f JS |
2307 | ## |
2308 | { 'command': 'block-dirty-bitmap-add', | |
f55ba801 PB |
2309 | 'data': 'BlockDirtyBitmapAdd', |
2310 | 'allow-preconfig': true } | |
341ebc2f JS |
2311 | |
2312 | ## | |
5072f7b3 | 2313 | # @block-dirty-bitmap-remove: |
341ebc2f | 2314 | # |
4bbca422 | 2315 | # Stop write tracking and remove the dirty bitmap that was created |
a937b6aa MA |
2316 | # with block-dirty-bitmap-add. If the bitmap is persistent, remove it |
2317 | # from its storage too. | |
341ebc2f | 2318 | # |
a937b6aa MA |
2319 | # Returns: |
2320 | # - nothing on success | |
2321 | # - If @node is not a valid block device or node, DeviceNotFound | |
2322 | # - If @name is not found, GenericError with an explanation | |
2323 | # - if @name is frozen by an operation, GenericError | |
341ebc2f | 2324 | # |
5072f7b3 | 2325 | # Since: 2.4 |
4bbca422 MAL |
2326 | # |
2327 | # Example: | |
2328 | # | |
2329 | # -> { "execute": "block-dirty-bitmap-remove", | |
2330 | # "arguments": { "node": "drive0", "name": "bitmap0" } } | |
2331 | # <- { "return": {} } | |
341ebc2f JS |
2332 | ## |
2333 | { 'command': 'block-dirty-bitmap-remove', | |
f55ba801 PB |
2334 | 'data': 'BlockDirtyBitmap', |
2335 | 'allow-preconfig': true } | |
341ebc2f | 2336 | |
e74e6b78 | 2337 | ## |
5072f7b3 | 2338 | # @block-dirty-bitmap-clear: |
e74e6b78 | 2339 | # |
73dffdc8 MAL |
2340 | # Clear (reset) a dirty bitmap on the device, so that an incremental |
2341 | # backup from this point in time forward will only backup clusters | |
2342 | # modified after this clear operation. | |
e74e6b78 | 2343 | # |
a937b6aa MA |
2344 | # Returns: |
2345 | # - nothing on success | |
2346 | # - If @node is not a valid block device, DeviceNotFound | |
2347 | # - If @name is not found, GenericError with an explanation | |
e74e6b78 | 2348 | # |
5072f7b3 | 2349 | # Since: 2.4 |
73dffdc8 MAL |
2350 | # |
2351 | # Example: | |
2352 | # | |
2353 | # -> { "execute": "block-dirty-bitmap-clear", | |
2354 | # "arguments": { "node": "drive0", "name": "bitmap0" } } | |
2355 | # <- { "return": {} } | |
e74e6b78 JS |
2356 | ## |
2357 | { 'command': 'block-dirty-bitmap-clear', | |
f55ba801 PB |
2358 | 'data': 'BlockDirtyBitmap', |
2359 | 'allow-preconfig': true } | |
e74e6b78 | 2360 | |
5c5d2e50 | 2361 | ## |
0e2b7f09 | 2362 | # @block-dirty-bitmap-enable: |
5c5d2e50 VSO |
2363 | # |
2364 | # Enables a dirty bitmap so that it will begin tracking disk changes. | |
2365 | # | |
a937b6aa MA |
2366 | # Returns: |
2367 | # - nothing on success | |
2368 | # - If @node is not a valid block device, DeviceNotFound | |
2369 | # - If @name is not found, GenericError with an explanation | |
5c5d2e50 | 2370 | # |
0e2b7f09 | 2371 | # Since: 4.0 |
5c5d2e50 VSO |
2372 | # |
2373 | # Example: | |
2374 | # | |
0e2b7f09 | 2375 | # -> { "execute": "block-dirty-bitmap-enable", |
5c5d2e50 VSO |
2376 | # "arguments": { "node": "drive0", "name": "bitmap0" } } |
2377 | # <- { "return": {} } | |
5c5d2e50 | 2378 | ## |
fbeed197 | 2379 | { 'command': 'block-dirty-bitmap-enable', |
f55ba801 PB |
2380 | 'data': 'BlockDirtyBitmap', |
2381 | 'allow-preconfig': true } | |
5c5d2e50 VSO |
2382 | |
2383 | ## | |
0e2b7f09 | 2384 | # @block-dirty-bitmap-disable: |
5c5d2e50 VSO |
2385 | # |
2386 | # Disables a dirty bitmap so that it will stop tracking disk changes. | |
2387 | # | |
a937b6aa MA |
2388 | # Returns: |
2389 | # - nothing on success | |
2390 | # - If @node is not a valid block device, DeviceNotFound | |
2391 | # - If @name is not found, GenericError with an explanation | |
5c5d2e50 | 2392 | # |
0e2b7f09 | 2393 | # Since: 4.0 |
5c5d2e50 VSO |
2394 | # |
2395 | # Example: | |
2396 | # | |
0e2b7f09 | 2397 | # -> { "execute": "block-dirty-bitmap-disable", |
5c5d2e50 VSO |
2398 | # "arguments": { "node": "drive0", "name": "bitmap0" } } |
2399 | # <- { "return": {} } | |
5c5d2e50 | 2400 | ## |
fbeed197 | 2401 | { 'command': 'block-dirty-bitmap-disable', |
f55ba801 PB |
2402 | 'data': 'BlockDirtyBitmap', |
2403 | 'allow-preconfig': true } | |
5c5d2e50 | 2404 | |
b598e531 | 2405 | ## |
0e2b7f09 | 2406 | # @block-dirty-bitmap-merge: |
b598e531 | 2407 | # |
360d4e4e | 2408 | # Merge dirty bitmaps listed in @bitmaps to the @target dirty bitmap. |
a937b6aa MA |
2409 | # Dirty bitmaps in @bitmaps will be unchanged, except if it also |
2410 | # appears as the @target bitmap. Any bits already set in @target will | |
2411 | # still be set after the merge, i.e., this operation does not clear | |
2412 | # the target. On error, @target is unchanged. | |
2413 | # | |
2414 | # The resulting bitmap will count as dirty any clusters that were | |
2415 | # dirty in any of the source bitmaps. This can be used to achieve | |
2416 | # backup checkpoints, or in simpler usages, to copy bitmaps. | |
2417 | # | |
2418 | # Returns: | |
2419 | # - nothing on success | |
2420 | # - If @node is not a valid block device, DeviceNotFound | |
2421 | # - If any bitmap in @bitmaps or @target is not found, | |
2422 | # GenericError | |
2423 | # - If any of the bitmaps have different sizes or granularities, | |
2424 | # GenericError | |
b598e531 | 2425 | # |
0e2b7f09 | 2426 | # Since: 4.0 |
b598e531 VSO |
2427 | # |
2428 | # Example: | |
2429 | # | |
0e2b7f09 | 2430 | # -> { "execute": "block-dirty-bitmap-merge", |
360d4e4e JS |
2431 | # "arguments": { "node": "drive0", "target": "bitmap0", |
2432 | # "bitmaps": ["bitmap1"] } } | |
b598e531 | 2433 | # <- { "return": {} } |
b598e531 | 2434 | ## |
fbeed197 | 2435 | { 'command': 'block-dirty-bitmap-merge', |
f55ba801 PB |
2436 | 'data': 'BlockDirtyBitmapMerge', |
2437 | 'allow-preconfig': true } | |
b598e531 | 2438 | |
a3b52535 VSO |
2439 | ## |
2440 | # @BlockDirtyBitmapSha256: | |
2441 | # | |
2442 | # SHA256 hash of dirty bitmap data | |
2443 | # | |
2444 | # @sha256: ASCII representation of SHA256 bitmap hash | |
2445 | # | |
2446 | # Since: 2.10 | |
2447 | ## | |
fbeed197 MA |
2448 | { 'struct': 'BlockDirtyBitmapSha256', |
2449 | 'data': {'sha256': 'str'} } | |
a3b52535 VSO |
2450 | |
2451 | ## | |
2452 | # @x-debug-block-dirty-bitmap-sha256: | |
2453 | # | |
73ab5d60 | 2454 | # Get bitmap SHA256. |
a3b52535 | 2455 | # |
9fb49daa | 2456 | # Features: |
a937b6aa | 2457 | # |
9fb49daa MA |
2458 | # @unstable: This command is meant for debugging. |
2459 | # | |
a937b6aa MA |
2460 | # Returns: |
2461 | # - BlockDirtyBitmapSha256 on success | |
2462 | # - If @node is not a valid block device, DeviceNotFound | |
2463 | # - If @name is not found or if hashing has failed, GenericError | |
2464 | # with an explanation | |
a3b52535 VSO |
2465 | # |
2466 | # Since: 2.10 | |
2467 | ## | |
fbeed197 | 2468 | { 'command': 'x-debug-block-dirty-bitmap-sha256', |
9fb49daa | 2469 | 'data': 'BlockDirtyBitmap', 'returns': 'BlockDirtyBitmapSha256', |
f55ba801 PB |
2470 | 'features': [ 'unstable' ], |
2471 | 'allow-preconfig': true } | |
a3b52535 | 2472 | |
df92562e | 2473 | ## |
5072f7b3 | 2474 | # @blockdev-mirror: |
df92562e FZ |
2475 | # |
2476 | # Start mirroring a block device's writes to a new destination. | |
2477 | # | |
a937b6aa MA |
2478 | # @job-id: identifier for the newly-created block job. If omitted, |
2479 | # the device name will be used. (Since 2.7) | |
71aa9867 | 2480 | # |
a937b6aa MA |
2481 | # @device: The device name or node-name of a root node whose writes |
2482 | # should be mirrored. | |
df92562e | 2483 | # |
a937b6aa MA |
2484 | # @target: the id or node-name of the block device to mirror to. This |
2485 | # mustn't be attached to guest. | |
df92562e | 2486 | # |
1d8bda12 | 2487 | # @replaces: with sync=full graph node name to be replaced by the new |
a937b6aa MA |
2488 | # image when a whole image copy is done. This can be used to |
2489 | # repair broken Quorum files. By default, @device is replaced, | |
2490 | # although implicitly created filters on it are kept. | |
df92562e | 2491 | # |
23e46452 | 2492 | # @speed: the maximum speed, in bytes per second |
df92562e | 2493 | # |
a937b6aa MA |
2494 | # @sync: what parts of the disk image should be copied to the |
2495 | # destination (all the disk, only the sectors allocated in the | |
2496 | # topmost image, or only new I/O). | |
df92562e | 2497 | # |
a937b6aa MA |
2498 | # @granularity: granularity of the dirty bitmap, default is 64K if the |
2499 | # image format doesn't have clusters, 4K if the clusters are | |
2500 | # smaller than that, else the cluster size. Must be a power of 2 | |
2501 | # between 512 and 64M | |
df92562e | 2502 | # |
a937b6aa | 2503 | # @buf-size: maximum amount of data in flight from source to target |
df92562e | 2504 | # |
1d8bda12 | 2505 | # @on-source-error: the action to take on an error on the source, |
a937b6aa MA |
2506 | # default 'report'. 'stop' and 'enospc' can only be used if the |
2507 | # block device supports io-status (see BlockInfo). | |
df92562e | 2508 | # |
1d8bda12 | 2509 | # @on-target-error: the action to take on an error on the target, |
a937b6aa MA |
2510 | # default 'report' (no limitations, since this applies to a |
2511 | # different block device than @device). | |
df92562e | 2512 | # |
1d8bda12 | 2513 | # @filter-node-name: the node name that should be assigned to the |
a937b6aa MA |
2514 | # filter driver that the mirror job inserts into the graph above |
2515 | # @device. If this option is not given, a node name is | |
2516 | # autogenerated. (Since: 2.9) | |
2517 | # | |
2518 | # @copy-mode: when to copy data to the destination; defaults to | |
2519 | # 'background' (Since: 3.0) | |
2520 | # | |
2521 | # @auto-finalize: When false, this job will wait in a PENDING state | |
2522 | # after it has finished its work, waiting for @block-job-finalize | |
2523 | # before making any block graph changes. When true, this job will | |
2524 | # automatically perform its abort or commit actions. Defaults to | |
2525 | # true. (Since 3.1) | |
2526 | # | |
2527 | # @auto-dismiss: When false, this job will wait in a CONCLUDED state | |
2528 | # after it has completely ceased all work, and awaits | |
2529 | # @block-job-dismiss. When true, this job will automatically | |
2530 | # disappear from the query list without user intervention. | |
2531 | # Defaults to true. (Since 3.1) | |
4ae65a52 | 2532 | # |
df92562e FZ |
2533 | # Returns: nothing on success. |
2534 | # | |
5072f7b3 | 2535 | # Since: 2.6 |
f6235a25 MAL |
2536 | # |
2537 | # Example: | |
2538 | # | |
2539 | # -> { "execute": "blockdev-mirror", | |
2540 | # "arguments": { "device": "ide-hd0", | |
2541 | # "target": "target0", | |
2542 | # "sync": "full" } } | |
2543 | # <- { "return": {} } | |
df92562e FZ |
2544 | ## |
2545 | { 'command': 'blockdev-mirror', | |
71aa9867 | 2546 | 'data': { '*job-id': 'str', 'device': 'str', 'target': 'str', |
df92562e FZ |
2547 | '*replaces': 'str', |
2548 | 'sync': 'MirrorSyncMode', | |
2549 | '*speed': 'int', '*granularity': 'uint32', | |
2550 | '*buf-size': 'int', '*on-source-error': 'BlockdevOnError', | |
6cdbceb1 | 2551 | '*on-target-error': 'BlockdevOnError', |
481debaa | 2552 | '*filter-node-name': 'str', |
a6b58ade | 2553 | '*copy-mode': 'MirrorCopyMode', |
f55ba801 PB |
2554 | '*auto-finalize': 'bool', '*auto-dismiss': 'bool' }, |
2555 | 'allow-preconfig': true } | |
df92562e | 2556 | |
4dc9397b | 2557 | ## |
5072f7b3 | 2558 | # @BlockIOThrottle: |
4dc9397b EB |
2559 | # |
2560 | # A set of parameters describing block throttling. | |
2561 | # | |
df4097ae | 2562 | # @device: Block device name |
7a9877a0 | 2563 | # |
1d8bda12 | 2564 | # @id: The name or QOM path of the guest device (since: 2.8) |
1ad166b6 BC |
2565 | # |
2566 | # @bps: total throughput limit in bytes per second | |
2567 | # | |
2568 | # @bps_rd: read throughput limit in bytes per second | |
2569 | # | |
2570 | # @bps_wr: write throughput limit in bytes per second | |
2571 | # | |
2572 | # @iops: total I/O operations per second | |
2573 | # | |
f5a845fd | 2574 | # @iops_rd: read I/O operations per second |
1ad166b6 BC |
2575 | # |
2576 | # @iops_wr: write I/O operations per second | |
2577 | # | |
a937b6aa | 2578 | # @bps_max: total throughput limit during bursts, in bytes (Since 1.7) |
1ad166b6 | 2579 | # |
a937b6aa MA |
2580 | # @bps_rd_max: read throughput limit during bursts, in bytes (Since |
2581 | # 1.7) | |
1ad166b6 | 2582 | # |
a937b6aa MA |
2583 | # @bps_wr_max: write throughput limit during bursts, in bytes (Since |
2584 | # 1.7) | |
1ad166b6 | 2585 | # |
a937b6aa MA |
2586 | # @iops_max: total I/O operations per second during bursts, in bytes |
2587 | # (Since 1.7) | |
1ad166b6 | 2588 | # |
a937b6aa MA |
2589 | # @iops_rd_max: read I/O operations per second during bursts, in bytes |
2590 | # (Since 1.7) | |
1ad166b6 | 2591 | # |
a937b6aa MA |
2592 | # @iops_wr_max: write I/O operations per second during bursts, in |
2593 | # bytes (Since 1.7) | |
dce13204 | 2594 | # |
a937b6aa MA |
2595 | # @bps_max_length: maximum length of the @bps_max burst period, in |
2596 | # seconds. It must only be set if @bps_max is set as well. | |
2597 | # Defaults to 1. (Since 2.6) | |
dce13204 | 2598 | # |
a937b6aa MA |
2599 | # @bps_rd_max_length: maximum length of the @bps_rd_max burst period, |
2600 | # in seconds. It must only be set if @bps_rd_max is set as well. | |
2601 | # Defaults to 1. (Since 2.6) | |
dce13204 | 2602 | # |
a937b6aa MA |
2603 | # @bps_wr_max_length: maximum length of the @bps_wr_max burst period, |
2604 | # in seconds. It must only be set if @bps_wr_max is set as well. | |
2605 | # Defaults to 1. (Since 2.6) | |
dce13204 | 2606 | # |
a937b6aa MA |
2607 | # @iops_max_length: maximum length of the @iops burst period, in |
2608 | # seconds. It must only be set if @iops_max is set as well. | |
2609 | # Defaults to 1. (Since 2.6) | |
dce13204 | 2610 | # |
a937b6aa MA |
2611 | # @iops_rd_max_length: maximum length of the @iops_rd_max burst |
2612 | # period, in seconds. It must only be set if @iops_rd_max is set | |
2613 | # as well. Defaults to 1. (Since 2.6) | |
dce13204 | 2614 | # |
a937b6aa MA |
2615 | # @iops_wr_max_length: maximum length of the @iops_wr_max burst |
2616 | # period, in seconds. It must only be set if @iops_wr_max is set | |
2617 | # as well. Defaults to 1. (Since 2.6) | |
1ad166b6 | 2618 | # |
1d8bda12 | 2619 | # @iops_size: an I/O size in bytes (Since 1.7) |
1ad166b6 | 2620 | # |
1d8bda12 | 2621 | # @group: throttle group name (Since 2.4) |
76f4afb4 | 2622 | # |
df4097ae | 2623 | # Features: |
a937b6aa | 2624 | # |
df4097ae MA |
2625 | # @deprecated: Member @device is deprecated. Use @id instead. |
2626 | # | |
1ad166b6 BC |
2627 | # Since: 1.1 |
2628 | ## | |
4dc9397b | 2629 | { 'struct': 'BlockIOThrottle', |
df4097ae MA |
2630 | 'data': { '*device': { 'type': 'str', 'features': [ 'deprecated' ] }, |
2631 | '*id': 'str', 'bps': 'int', 'bps_rd': 'int', | |
7a9877a0 | 2632 | 'bps_wr': 'int', 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int', |
1ad166b6 BC |
2633 | '*bps_max': 'int', '*bps_rd_max': 'int', |
2634 | '*bps_wr_max': 'int', '*iops_max': 'int', | |
2635 | '*iops_rd_max': 'int', '*iops_wr_max': 'int', | |
dce13204 AG |
2636 | '*bps_max_length': 'int', '*bps_rd_max_length': 'int', |
2637 | '*bps_wr_max_length': 'int', '*iops_max_length': 'int', | |
2638 | '*iops_rd_max_length': 'int', '*iops_wr_max_length': 'int', | |
76f4afb4 | 2639 | '*iops_size': 'int', '*group': 'str' } } |
1ad166b6 | 2640 | |
432d889e MP |
2641 | ## |
2642 | # @ThrottleLimits: | |
2643 | # | |
a937b6aa MA |
2644 | # Limit parameters for throttling. Since some limit combinations are |
2645 | # illegal, limits should always be set in one transaction. All fields | |
2646 | # are optional. When setting limits, if a field is missing the | |
2647 | # current value is not changed. | |
432d889e | 2648 | # |
26ec4e53 | 2649 | # @iops-total: limit total I/O operations per second |
a937b6aa | 2650 | # |
26ec4e53 | 2651 | # @iops-total-max: I/O operations burst |
a937b6aa MA |
2652 | # |
2653 | # @iops-total-max-length: length of the iops-total-max burst period, | |
2654 | # in seconds It must only be set if @iops-total-max is set as | |
2655 | # well. | |
2656 | # | |
26ec4e53 | 2657 | # @iops-read: limit read operations per second |
a937b6aa | 2658 | # |
26ec4e53 | 2659 | # @iops-read-max: I/O operations read burst |
a937b6aa MA |
2660 | # |
2661 | # @iops-read-max-length: length of the iops-read-max burst period, in | |
2662 | # seconds It must only be set if @iops-read-max is set as well. | |
2663 | # | |
26ec4e53 | 2664 | # @iops-write: limit write operations per second |
a937b6aa | 2665 | # |
26ec4e53 | 2666 | # @iops-write-max: I/O operations write burst |
a937b6aa MA |
2667 | # |
2668 | # @iops-write-max-length: length of the iops-write-max burst period, | |
2669 | # in seconds It must only be set if @iops-write-max is set as | |
2670 | # well. | |
2671 | # | |
26ec4e53 | 2672 | # @bps-total: limit total bytes per second |
a937b6aa | 2673 | # |
26ec4e53 | 2674 | # @bps-total-max: total bytes burst |
a937b6aa MA |
2675 | # |
2676 | # @bps-total-max-length: length of the bps-total-max burst period, in | |
2677 | # seconds. It must only be set if @bps-total-max is set as well. | |
2678 | # | |
26ec4e53 | 2679 | # @bps-read: limit read bytes per second |
a937b6aa | 2680 | # |
26ec4e53 | 2681 | # @bps-read-max: total bytes read burst |
a937b6aa MA |
2682 | # |
2683 | # @bps-read-max-length: length of the bps-read-max burst period, in | |
2684 | # seconds It must only be set if @bps-read-max is set as well. | |
2685 | # | |
26ec4e53 | 2686 | # @bps-write: limit write bytes per second |
a937b6aa | 2687 | # |
26ec4e53 | 2688 | # @bps-write-max: total bytes write burst |
a937b6aa MA |
2689 | # |
2690 | # @bps-write-max-length: length of the bps-write-max burst period, in | |
2691 | # seconds It must only be set if @bps-write-max is set as well. | |
2692 | # | |
26ec4e53 | 2693 | # @iops-size: when limiting by iops max size of an I/O in bytes |
432d889e MP |
2694 | # |
2695 | # Since: 2.11 | |
2696 | ## | |
2697 | { 'struct': 'ThrottleLimits', | |
2698 | 'data': { '*iops-total' : 'int', '*iops-total-max' : 'int', | |
2699 | '*iops-total-max-length' : 'int', '*iops-read' : 'int', | |
2700 | '*iops-read-max' : 'int', '*iops-read-max-length' : 'int', | |
2701 | '*iops-write' : 'int', '*iops-write-max' : 'int', | |
2702 | '*iops-write-max-length' : 'int', '*bps-total' : 'int', | |
2703 | '*bps-total-max' : 'int', '*bps-total-max-length' : 'int', | |
2704 | '*bps-read' : 'int', '*bps-read-max' : 'int', | |
2705 | '*bps-read-max-length' : 'int', '*bps-write' : 'int', | |
2706 | '*bps-write-max' : 'int', '*bps-write-max-length' : 'int', | |
2707 | '*iops-size' : 'int' } } | |
2708 | ||
381bd744 KW |
2709 | ## |
2710 | # @ThrottleGroupProperties: | |
2711 | # | |
2712 | # Properties for throttle-group objects. | |
2713 | # | |
381bd744 KW |
2714 | # @limits: limits to apply for this throttle group |
2715 | # | |
9fb49daa | 2716 | # Features: |
a937b6aa | 2717 | # |
9fb49daa | 2718 | # @unstable: All members starting with x- are aliases for the same key |
a937b6aa MA |
2719 | # without x- in the @limits object. This is not a stable |
2720 | # interface and may be removed or changed incompatibly in the | |
2721 | # future. Use @limits for a supported stable interface. | |
9fb49daa | 2722 | # |
381bd744 KW |
2723 | # Since: 2.11 |
2724 | ## | |
2725 | { 'struct': 'ThrottleGroupProperties', | |
2726 | 'data': { '*limits': 'ThrottleLimits', | |
9fb49daa MA |
2727 | '*x-iops-total': { 'type': 'int', |
2728 | 'features': [ 'unstable' ] }, | |
2729 | '*x-iops-total-max': { 'type': 'int', | |
2730 | 'features': [ 'unstable' ] }, | |
2731 | '*x-iops-total-max-length': { 'type': 'int', | |
2732 | 'features': [ 'unstable' ] }, | |
2733 | '*x-iops-read': { 'type': 'int', | |
2734 | 'features': [ 'unstable' ] }, | |
2735 | '*x-iops-read-max': { 'type': 'int', | |
2736 | 'features': [ 'unstable' ] }, | |
2737 | '*x-iops-read-max-length': { 'type': 'int', | |
2738 | 'features': [ 'unstable' ] }, | |
2739 | '*x-iops-write': { 'type': 'int', | |
2740 | 'features': [ 'unstable' ] }, | |
2741 | '*x-iops-write-max': { 'type': 'int', | |
2742 | 'features': [ 'unstable' ] }, | |
2743 | '*x-iops-write-max-length': { 'type': 'int', | |
2744 | 'features': [ 'unstable' ] }, | |
2745 | '*x-bps-total': { 'type': 'int', | |
2746 | 'features': [ 'unstable' ] }, | |
2747 | '*x-bps-total-max': { 'type': 'int', | |
2748 | 'features': [ 'unstable' ] }, | |
2749 | '*x-bps-total-max-length': { 'type': 'int', | |
2750 | 'features': [ 'unstable' ] }, | |
2751 | '*x-bps-read': { 'type': 'int', | |
2752 | 'features': [ 'unstable' ] }, | |
2753 | '*x-bps-read-max': { 'type': 'int', | |
2754 | 'features': [ 'unstable' ] }, | |
2755 | '*x-bps-read-max-length': { 'type': 'int', | |
2756 | 'features': [ 'unstable' ] }, | |
2757 | '*x-bps-write': { 'type': 'int', | |
2758 | 'features': [ 'unstable' ] }, | |
2759 | '*x-bps-write-max': { 'type': 'int', | |
2760 | 'features': [ 'unstable' ] }, | |
2761 | '*x-bps-write-max-length': { 'type': 'int', | |
2762 | 'features': [ 'unstable' ] }, | |
2763 | '*x-iops-size': { 'type': 'int', | |
2764 | 'features': [ 'unstable' ] } } } | |
381bd744 | 2765 | |
1ad166b6 BC |
2766 | ## |
2767 | # @block-stream: | |
2768 | # | |
2769 | # Copy data from a backing file into a block device. | |
2770 | # | |
a937b6aa MA |
2771 | # The block streaming operation is performed in the background until |
2772 | # the entire backing file has been copied. This command returns | |
2773 | # immediately once streaming has started. The status of ongoing block | |
2774 | # streaming operations can be checked with query-block-jobs. The | |
2775 | # operation can be stopped before it has completed using the | |
2776 | # block-job-cancel command. | |
2777 | # | |
2778 | # The node that receives the data is called the top image, can be | |
2779 | # located in any part of the chain (but always above the base image; | |
2780 | # see below) and can be specified using its device or node name. | |
2781 | # Earlier qemu versions only allowed 'device' to name the top level | |
2782 | # node; presence of the 'base-node' parameter during introspection can | |
2783 | # be used as a witness of the enhanced semantics of 'device'. | |
2784 | # | |
2785 | # If a base file is specified then sectors are not copied from that | |
2786 | # base file and its backing chain. This can be used to stream a | |
2787 | # subset of the backing file chain instead of flattening the entire | |
2788 | # image. When streaming completes the image file will have the base | |
2789 | # file as its backing file, unless that node was changed while the job | |
2790 | # was running. In that case, base's parent's backing (or filtered, | |
2791 | # whichever exists) child (i.e., base at the beginning of the job) | |
2792 | # will be the new backing file. | |
2793 | # | |
2794 | # On successful completion the image file is updated to drop the | |
2795 | # backing file and the BLOCK_JOB_COMPLETED event is emitted. | |
2796 | # | |
2797 | # In case @device is a filter node, block-stream modifies the first | |
2798 | # non-filter overlay node below it to point to the new backing node | |
2799 | # instead of modifying @device itself. | |
2800 | # | |
2801 | # @job-id: identifier for the newly-created block job. If omitted, | |
2802 | # the device name will be used. (Since 2.7) | |
2323322e | 2803 | # |
554b6147 | 2804 | # @device: the device or node name of the top image |
1ad166b6 | 2805 | # |
a937b6aa MA |
2806 | # @base: the common backing file name. It cannot be set if @base-node |
2807 | # or @bottom is also set. | |
312fe09c | 2808 | # |
a937b6aa MA |
2809 | # @base-node: the node name of the backing file. It cannot be set if |
2810 | # @base or @bottom is also set. (Since 2.8) | |
7f4a396d VSO |
2811 | # |
2812 | # @bottom: the last node in the chain that should be streamed into | |
a937b6aa MA |
2813 | # top. It cannot be set if @base or @base-node is also set. It |
2814 | # cannot be filter node. (Since 6.0) | |
1ad166b6 | 2815 | # |
a937b6aa MA |
2816 | # @backing-file: The backing file string to write into the top image. |
2817 | # This filename is not validated. | |
13d8cc51 | 2818 | # |
a937b6aa MA |
2819 | # If a pathname string is such that it cannot be resolved by QEMU, |
2820 | # that means that subsequent QMP or HMP commands must use | |
2821 | # node-names for the image in question, as filename lookup methods | |
2822 | # will fail. | |
13d8cc51 | 2823 | # |
a937b6aa MA |
2824 | # If not specified, QEMU will automatically determine the backing |
2825 | # file string to use, or error out if there is no obvious choice. | |
2826 | # Care should be taken when specifying the string, to specify a | |
2827 | # valid filename or protocol. (Since 2.1) | |
13d8cc51 | 2828 | # |
72098a3a PK |
2829 | # @backing-mask-protocol: If true, replace any protocol mentioned in the |
2830 | # 'backing file format' with 'raw', rather than storing the protocol | |
2831 | # name as the backing format. Can be used even when no image header | |
2832 | # will be updated (default false; since 9.0). | |
2833 | # | |
26ec4e53 | 2834 | # @speed: the maximum speed, in bytes per second |
1ad166b6 | 2835 | # |
a937b6aa MA |
2836 | # @on-error: the action to take on an error (default report). 'stop' |
2837 | # and 'enospc' can only be used if the block device supports | |
2838 | # io-status (see BlockInfo). (Since 1.3) | |
1ad166b6 | 2839 | # |
880747a8 | 2840 | # @filter-node-name: the node name that should be assigned to the |
a937b6aa MA |
2841 | # filter driver that the stream job inserts into the graph above |
2842 | # @device. If this option is not given, a node name is | |
2843 | # autogenerated. (Since: 6.0) | |
2844 | # | |
2845 | # @auto-finalize: When false, this job will wait in a PENDING state | |
2846 | # after it has finished its work, waiting for @block-job-finalize | |
2847 | # before making any block graph changes. When true, this job will | |
2848 | # automatically perform its abort or commit actions. Defaults to | |
2849 | # true. (Since 3.1) | |
2850 | # | |
2851 | # @auto-dismiss: When false, this job will wait in a CONCLUDED state | |
2852 | # after it has completely ceased all work, and awaits | |
2853 | # @block-job-dismiss. When true, this job will automatically | |
2854 | # disappear from the query list without user intervention. | |
2855 | # Defaults to true. (Since 3.1) | |
2856 | # | |
2857 | # Returns: | |
2858 | # - Nothing on success. | |
2859 | # - If @device does not exist, DeviceNotFound. | |
49b37c23 | 2860 | # |
1ad166b6 | 2861 | # Since: 1.1 |
49b37c23 MAL |
2862 | # |
2863 | # Example: | |
2864 | # | |
2865 | # -> { "execute": "block-stream", | |
2866 | # "arguments": { "device": "virtio0", | |
2867 | # "base": "/tmp/master.qcow2" } } | |
2868 | # <- { "return": {} } | |
1ad166b6 BC |
2869 | ## |
2870 | { 'command': 'block-stream', | |
2323322e | 2871 | 'data': { '*job-id': 'str', 'device': 'str', '*base': 'str', |
72098a3a PK |
2872 | '*base-node': 'str', '*backing-file': 'str', |
2873 | '*backing-mask-protocol': 'bool', | |
2874 | '*bottom': 'str', | |
7f4a396d | 2875 | '*speed': 'int', '*on-error': 'BlockdevOnError', |
880747a8 | 2876 | '*filter-node-name': 'str', |
f55ba801 PB |
2877 | '*auto-finalize': 'bool', '*auto-dismiss': 'bool' }, |
2878 | 'allow-preconfig': true } | |
1ad166b6 BC |
2879 | |
2880 | ## | |
2881 | # @block-job-set-speed: | |
2882 | # | |
2883 | # Set maximum speed for a background block operation. | |
2884 | # | |
2885 | # This command can only be issued when there is an active block job. | |
2886 | # | |
2887 | # Throttling can be disabled by setting the speed to 0. | |
2888 | # | |
a937b6aa MA |
2889 | # @device: The job identifier. This used to be a device name (hence |
2890 | # the name of the parameter), but since QEMU 2.7 it can have other | |
2891 | # values. | |
1ad166b6 | 2892 | # |
26ec4e53 | 2893 | # @speed: the maximum speed, in bytes per second, or 0 for unlimited. |
a937b6aa | 2894 | # Defaults to 0. |
1ad166b6 | 2895 | # |
a937b6aa MA |
2896 | # Returns: |
2897 | # - Nothing on success | |
2898 | # - If no background operation is active on this device, | |
2899 | # DeviceNotActive | |
1ad166b6 BC |
2900 | # |
2901 | # Since: 1.1 | |
2902 | ## | |
2903 | { 'command': 'block-job-set-speed', | |
f55ba801 PB |
2904 | 'data': { 'device': 'str', 'speed': 'int' }, |
2905 | 'allow-preconfig': true } | |
1ad166b6 BC |
2906 | |
2907 | ## | |
2908 | # @block-job-cancel: | |
2909 | # | |
2910 | # Stop an active background block operation. | |
2911 | # | |
a937b6aa MA |
2912 | # This command returns immediately after marking the active background |
2913 | # block operation for cancellation. It is an error to call this | |
2914 | # command if no operation is in progress. | |
1ad166b6 BC |
2915 | # |
2916 | # The operation will cancel as soon as possible and then emit the | |
a937b6aa MA |
2917 | # BLOCK_JOB_CANCELLED event. Before that happens the job is still |
2918 | # visible when enumerated using query-block-jobs. | |
2919 | # | |
2920 | # Note that if you issue 'block-job-cancel' after 'drive-mirror' has | |
2921 | # indicated (via the event BLOCK_JOB_READY) that the source and | |
2922 | # destination are synchronized, then the event triggered by this | |
2923 | # command changes to BLOCK_JOB_COMPLETED, to indicate that the | |
2924 | # mirroring has ended and the destination now has a point-in-time copy | |
2925 | # tied to the time of the cancellation. | |
2926 | # | |
2927 | # For streaming, the image file retains its backing file unless the | |
2928 | # streaming operation happens to complete just as it is being | |
2929 | # cancelled. A new streaming operation can be started at a later time | |
2930 | # to finish copying all data from the backing file. | |
2931 | # | |
2932 | # @device: The job identifier. This used to be a device name (hence | |
2933 | # the name of the parameter), but since QEMU 2.7 it can have other | |
2934 | # values. | |
2935 | # | |
2936 | # @force: If true, and the job has already emitted the event | |
2937 | # BLOCK_JOB_READY, abandon the job immediately (even if it is | |
2938 | # paused) instead of waiting for the destination to complete its | |
2939 | # final synchronization (since 1.3) | |
2940 | # | |
2941 | # Returns: | |
2942 | # - Nothing on success | |
2943 | # - If no background operation is active on this device, | |
2944 | # DeviceNotActive | |
1ad166b6 BC |
2945 | # |
2946 | # Since: 1.1 | |
2947 | ## | |
f55ba801 PB |
2948 | { 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' }, |
2949 | 'allow-preconfig': true } | |
1ad166b6 BC |
2950 | |
2951 | ## | |
2952 | # @block-job-pause: | |
2953 | # | |
2954 | # Pause an active background block operation. | |
2955 | # | |
a937b6aa MA |
2956 | # This command returns immediately after marking the active background |
2957 | # block operation for pausing. It is an error to call this command if | |
2958 | # no operation is in progress or if the job is already paused. | |
1ad166b6 | 2959 | # |
a937b6aa MA |
2960 | # The operation will pause as soon as possible. No event is emitted |
2961 | # when the operation is actually paused. Cancelling a paused job | |
2962 | # automatically resumes it. | |
1ad166b6 | 2963 | # |
a937b6aa MA |
2964 | # @device: The job identifier. This used to be a device name (hence |
2965 | # the name of the parameter), but since QEMU 2.7 it can have other | |
2966 | # values. | |
1ad166b6 | 2967 | # |
a937b6aa MA |
2968 | # Returns: |
2969 | # - Nothing on success | |
2970 | # - If no background operation is active on this device, | |
2971 | # DeviceNotActive | |
1ad166b6 BC |
2972 | # |
2973 | # Since: 1.3 | |
2974 | ## | |
f55ba801 PB |
2975 | { 'command': 'block-job-pause', 'data': { 'device': 'str' }, |
2976 | 'allow-preconfig': true } | |
1ad166b6 BC |
2977 | |
2978 | ## | |
2979 | # @block-job-resume: | |
2980 | # | |
2981 | # Resume an active background block operation. | |
2982 | # | |
a937b6aa MA |
2983 | # This command returns immediately after resuming a paused background |
2984 | # block operation. It is an error to call this command if no | |
2985 | # operation is in progress or if the job is not paused. | |
1ad166b6 BC |
2986 | # |
2987 | # This command also clears the error status of the job. | |
2988 | # | |
a937b6aa MA |
2989 | # @device: The job identifier. This used to be a device name (hence |
2990 | # the name of the parameter), but since QEMU 2.7 it can have other | |
2991 | # values. | |
1ad166b6 | 2992 | # |
a937b6aa MA |
2993 | # Returns: |
2994 | # - Nothing on success | |
2995 | # - If no background operation is active on this device, | |
2996 | # DeviceNotActive | |
1ad166b6 BC |
2997 | # |
2998 | # Since: 1.3 | |
2999 | ## | |
f55ba801 PB |
3000 | { 'command': 'block-job-resume', 'data': { 'device': 'str' }, |
3001 | 'allow-preconfig': true } | |
1ad166b6 BC |
3002 | |
3003 | ## | |
3004 | # @block-job-complete: | |
3005 | # | |
a937b6aa MA |
3006 | # Manually trigger completion of an active background block operation. |
3007 | # This is supported for drive mirroring, where it also switches the | |
3008 | # device to write to the target path only. The ability to complete is | |
3009 | # signaled with a BLOCK_JOB_READY event. | |
1ad166b6 | 3010 | # |
a937b6aa MA |
3011 | # This command completes an active background block operation |
3012 | # synchronously. The ordering of this command's return with the | |
3013 | # BLOCK_JOB_COMPLETED event is not defined. Note that if an I/O error | |
3014 | # occurs during the processing of this command: 1) the command itself | |
3015 | # will fail; 2) the error will be processed according to the | |
3016 | # rerror/werror arguments that were specified when starting the | |
3017 | # operation. | |
1ad166b6 BC |
3018 | # |
3019 | # A cancelled or paused job cannot be completed. | |
3020 | # | |
a937b6aa MA |
3021 | # @device: The job identifier. This used to be a device name (hence |
3022 | # the name of the parameter), but since QEMU 2.7 it can have other | |
3023 | # values. | |
1ad166b6 | 3024 | # |
a937b6aa MA |
3025 | # Returns: |
3026 | # - Nothing on success | |
3027 | # - If no background operation is active on this device, | |
3028 | # DeviceNotActive | |
1ad166b6 BC |
3029 | # |
3030 | # Since: 1.3 | |
3031 | ## | |
f55ba801 PB |
3032 | { 'command': 'block-job-complete', 'data': { 'device': 'str' }, |
3033 | 'allow-preconfig': true } | |
1ad166b6 | 3034 | |
75f71059 JS |
3035 | ## |
3036 | # @block-job-dismiss: | |
3037 | # | |
a937b6aa MA |
3038 | # For jobs that have already concluded, remove them from the |
3039 | # block-job-query list. This command only needs to be run for jobs | |
3040 | # which were started with QEMU 2.12+ job lifetime management | |
3041 | # semantics. | |
75f71059 | 3042 | # |
a937b6aa MA |
3043 | # This command will refuse to operate on any job that has not yet |
3044 | # reached its terminal state, JOB_STATUS_CONCLUDED. For jobs that make | |
3045 | # use of the BLOCK_JOB_READY event, block-job-cancel or | |
3046 | # block-job-complete will still need to be used as appropriate. | |
75f71059 JS |
3047 | # |
3048 | # @id: The job identifier. | |
3049 | # | |
3050 | # Returns: Nothing on success | |
3051 | # | |
3052 | # Since: 2.12 | |
3053 | ## | |
f55ba801 PB |
3054 | { 'command': 'block-job-dismiss', 'data': { 'id': 'str' }, |
3055 | 'allow-preconfig': true } | |
75f71059 | 3056 | |
11b61fbc JS |
3057 | ## |
3058 | # @block-job-finalize: | |
3059 | # | |
3060 | # Once a job that has manual=true reaches the pending state, it can be | |
a937b6aa MA |
3061 | # instructed to finalize any graph changes and do any necessary |
3062 | # cleanup via this command. For jobs in a transaction, instructing | |
3063 | # one job to finalize will force ALL jobs in the transaction to | |
3064 | # finalize, so it is only necessary to instruct a single member job to | |
3065 | # finalize. | |
11b61fbc JS |
3066 | # |
3067 | # @id: The job identifier. | |
3068 | # | |
3069 | # Returns: Nothing on success | |
3070 | # | |
3071 | # Since: 2.12 | |
3072 | ## | |
f55ba801 PB |
3073 | { 'command': 'block-job-finalize', 'data': { 'id': 'str' }, |
3074 | 'allow-preconfig': true } | |
11b61fbc | 3075 | |
2d400d15 FE |
3076 | ## |
3077 | # @BlockJobChangeOptionsMirror: | |
3078 | # | |
3079 | # @copy-mode: Switch to this copy mode. Currently, only the switch | |
3080 | # from 'background' to 'write-blocking' is implemented. | |
3081 | # | |
3082 | # Since: 8.2 | |
3083 | ## | |
3084 | { 'struct': 'BlockJobChangeOptionsMirror', | |
3085 | 'data': { 'copy-mode' : 'MirrorCopyMode' } } | |
3086 | ||
61a3a5a7 FE |
3087 | ## |
3088 | # @BlockJobChangeOptions: | |
3089 | # | |
3090 | # Block job options that can be changed after job creation. | |
3091 | # | |
3092 | # @id: The job identifier | |
3093 | # | |
3094 | # @type: The job type | |
3095 | # | |
37507c14 | 3096 | # Since: 8.2 |
61a3a5a7 FE |
3097 | ## |
3098 | { 'union': 'BlockJobChangeOptions', | |
3099 | 'base': { 'id': 'str', 'type': 'JobType' }, | |
3100 | 'discriminator': 'type', | |
2d400d15 | 3101 | 'data': { 'mirror': 'BlockJobChangeOptionsMirror' } } |
61a3a5a7 FE |
3102 | |
3103 | ## | |
3104 | # @block-job-change: | |
3105 | # | |
3106 | # Change the block job's options. | |
3107 | # | |
3108 | # Since: 8.2 | |
3109 | ## | |
3110 | { 'command': 'block-job-change', | |
3111 | 'data': 'BlockJobChangeOptions', 'boxed': true } | |
3112 | ||
1ad166b6 | 3113 | ## |
5072f7b3 | 3114 | # @BlockdevDiscardOptions: |
1ad166b6 BC |
3115 | # |
3116 | # Determines how to handle discard requests. | |
3117 | # | |
26ec4e53 | 3118 | # @ignore: Ignore the request |
a937b6aa | 3119 | # |
26ec4e53 | 3120 | # @unmap: Forward as an unmap request |
1ad166b6 | 3121 | # |
79b7a77e | 3122 | # Since: 2.9 |
1ad166b6 BC |
3123 | ## |
3124 | { 'enum': 'BlockdevDiscardOptions', | |
3125 | 'data': [ 'ignore', 'unmap' ] } | |
3126 | ||
3127 | ## | |
5072f7b3 | 3128 | # @BlockdevDetectZeroesOptions: |
1ad166b6 BC |
3129 | # |
3130 | # Describes the operation mode for the automatic conversion of plain | |
a937b6aa MA |
3131 | # zero writes by the OS to driver specific optimized zero write |
3132 | # commands. | |
1ad166b6 | 3133 | # |
26ec4e53 | 3134 | # @off: Disabled (default) |
a937b6aa | 3135 | # |
26ec4e53 | 3136 | # @on: Enabled |
a937b6aa MA |
3137 | # |
3138 | # @unmap: Enabled and even try to unmap blocks if possible. This | |
3139 | # requires also that @BlockdevDiscardOptions is set to unmap for | |
3140 | # this device. | |
1ad166b6 BC |
3141 | # |
3142 | # Since: 2.1 | |
3143 | ## | |
3144 | { 'enum': 'BlockdevDetectZeroesOptions', | |
3145 | 'data': [ 'off', 'on', 'unmap' ] } | |
3146 | ||
3147 | ## | |
5072f7b3 | 3148 | # @BlockdevAioOptions: |
1ad166b6 BC |
3149 | # |
3150 | # Selects the AIO backend to handle I/O requests | |
3151 | # | |
26ec4e53 | 3152 | # @threads: Use qemu's thread pool |
a937b6aa | 3153 | # |
26ec4e53 | 3154 | # @native: Use native AIO backend (only Linux and Windows) |
a937b6aa | 3155 | # |
26ec4e53 | 3156 | # @io_uring: Use linux io_uring (since 5.0) |
1ad166b6 | 3157 | # |
79b7a77e | 3158 | # Since: 2.9 |
1ad166b6 BC |
3159 | ## |
3160 | { 'enum': 'BlockdevAioOptions', | |
f14beaec | 3161 | 'data': [ 'threads', 'native', |
8a9f1e1d | 3162 | { 'name': 'io_uring', 'if': 'CONFIG_LINUX_IO_URING' } ] } |
1ad166b6 BC |
3163 | |
3164 | ## | |
5072f7b3 | 3165 | # @BlockdevCacheOptions: |
1ad166b6 BC |
3166 | # |
3167 | # Includes cache-related options for block devices | |
3168 | # | |
26ec4e53 | 3169 | # @direct: enables use of O_DIRECT (bypass the host page cache; |
a937b6aa MA |
3170 | # default: false) |
3171 | # | |
3172 | # @no-flush: ignore any flush requests for the device (default: false) | |
1ad166b6 | 3173 | # |
79b7a77e | 3174 | # Since: 2.9 |
1ad166b6 | 3175 | ## |
895a2a80 | 3176 | { 'struct': 'BlockdevCacheOptions', |
aaa436f9 | 3177 | 'data': { '*direct': 'bool', |
1ad166b6 BC |
3178 | '*no-flush': 'bool' } } |
3179 | ||
3180 | ## | |
5072f7b3 | 3181 | # @BlockdevDriver: |
1ad166b6 BC |
3182 | # |
3183 | # Drivers that are supported in block device operations. | |
3184 | # | |
d8e7d87e | 3185 | # @throttle: Since 2.11 |
a937b6aa | 3186 | # |
d87ee3d7 | 3187 | # @nvme: Since 2.12 |
a937b6aa | 3188 | # |
51f63ec7 | 3189 | # @copy-on-read: Since 3.0 |
a937b6aa | 3190 | # |
bfcc224e | 3191 | # @blklogwrites: Since 3.0 |
a937b6aa | 3192 | # |
35e32d9e | 3193 | # @blkreplay: Since 4.2 |
a937b6aa | 3194 | # |
f41388e0 | 3195 | # @compress: Since 5.0 |
a937b6aa | 3196 | # |
783b2825 | 3197 | # @copy-before-write: Since 6.2 |
a937b6aa | 3198 | # |
1c14eaab | 3199 | # @snapshot-access: Since 7.0 |
da92c3ff | 3200 | # |
79b7a77e | 3201 | # Since: 2.9 |
1ad166b6 BC |
3202 | ## |
3203 | { 'enum': 'BlockdevDriver', | |
35e32d9e | 3204 | 'data': [ 'blkdebug', 'blklogwrites', 'blkreplay', 'blkverify', 'bochs', |
783b2825 | 3205 | 'cloop', 'compress', 'copy-before-write', 'copy-on-read', 'dmg', |
1c14eaab | 3206 | 'file', 'snapshot-access', 'ftp', 'ftps', 'gluster', |
8a9f1e1d MAL |
3207 | {'name': 'host_cdrom', 'if': 'HAVE_HOST_BLOCK_DEVICE' }, |
3208 | {'name': 'host_device', 'if': 'HAVE_HOST_BLOCK_DEVICE' }, | |
fd66dbd4 SH |
3209 | 'http', 'https', |
3210 | { 'name': 'io_uring', 'if': 'CONFIG_BLKIO' }, | |
3211 | 'iscsi', | |
3212 | 'luks', 'nbd', 'nfs', 'null-aio', 'null-co', 'nvme', | |
3213 | { 'name': 'nvme-io_uring', 'if': 'CONFIG_BLKIO' }, | |
3214 | 'parallels', 'preallocate', 'qcow', 'qcow2', 'qed', 'quorum', | |
3215 | 'raw', 'rbd', | |
8a9f1e1d | 3216 | { 'name': 'replication', 'if': 'CONFIG_REPLICATION' }, |
fd66dbd4 | 3217 | 'ssh', 'throttle', 'vdi', 'vhdx', |
03d9e4c0 | 3218 | { 'name': 'virtio-blk-vfio-pci', 'if': 'CONFIG_BLKIO' }, |
fd66dbd4 SH |
3219 | { 'name': 'virtio-blk-vhost-user', 'if': 'CONFIG_BLKIO' }, |
3220 | { 'name': 'virtio-blk-vhost-vdpa', 'if': 'CONFIG_BLKIO' }, | |
3221 | 'vmdk', 'vpc', 'vvfat' ] } | |
1ad166b6 | 3222 | |
1ad166b6 | 3223 | ## |
5072f7b3 | 3224 | # @BlockdevOptionsFile: |
1ad166b6 | 3225 | # |
68555285 | 3226 | # Driver specific block device options for the file backend. |
1ad166b6 | 3227 | # |
26ec4e53 | 3228 | # @filename: path to the image file |
a937b6aa MA |
3229 | # |
3230 | # @pr-manager: the id for the object that will handle persistent | |
3231 | # reservations for this device (default: none, forward the | |
3232 | # commands via SG_IO; since 2.11) | |
3233 | # | |
26ec4e53 | 3234 | # @aio: AIO backend (default: threads) (since: 2.8) |
a937b6aa MA |
3235 | # |
3236 | # @aio-max-batch: maximum number of requests to batch together into a | |
3237 | # single submission in the AIO backend. The smallest value | |
3238 | # between this and the aio-max-batch value of the IOThread object | |
3239 | # is chosen. 0 means that the AIO backend will handle it | |
3240 | # automatically. (default: 0, since 6.2) | |
3241 | # | |
3242 | # @locking: whether to enable file locking. If set to 'auto', only | |
3243 | # enable when Open File Descriptor (OFD) locking API is available | |
3244 | # (default: auto, since 2.10) | |
3245 | # | |
3246 | # @drop-cache: invalidate page cache during live migration. This | |
3247 | # prevents stale data on the migration destination with | |
3248 | # cache.direct=off. Currently only supported on Linux hosts. | |
3249 | # (default: on, since: 4.0) | |
3250 | # | |
3251 | # @x-check-cache-dropped: whether to check that page cache was dropped | |
3252 | # on live migration. May cause noticeable delays if the image | |
3253 | # file is large, do not use in production. (default: off) | |
3254 | # (since: 3.0) | |
1ad166b6 | 3255 | # |
c9d40709 | 3256 | # Features: |
a937b6aa MA |
3257 | # |
3258 | # @dynamic-auto-read-only: If present, enabled auto-read-only means | |
3259 | # that the driver will open the image read-only at first, | |
3260 | # dynamically reopen the image file read-write when the first | |
3261 | # writer is attached to the node and reopen read-only when the | |
3262 | # last writer is detached. This allows giving QEMU write | |
3263 | # permissions only on demand when an operation actually needs | |
3264 | # write access. | |
3265 | # | |
9fb49daa | 3266 | # @unstable: Member x-check-cache-dropped is meant for debugging. |
c9d40709 | 3267 | # |
79b7a77e | 3268 | # Since: 2.9 |
1ad166b6 | 3269 | ## |
895a2a80 | 3270 | { 'struct': 'BlockdevOptionsFile', |
0a4279d9 | 3271 | 'data': { 'filename': 'str', |
7c9e5276 | 3272 | '*pr-manager': 'str', |
16b48d5d | 3273 | '*locking': 'OnOffAuto', |
31be8a2a | 3274 | '*aio': 'BlockdevAioOptions', |
684960d4 | 3275 | '*aio-max-batch': 'int', |
dbb28bc8 | 3276 | '*drop-cache': {'type': 'bool', |
8a9f1e1d | 3277 | 'if': 'CONFIG_LINUX'}, |
9fb49daa MA |
3278 | '*x-check-cache-dropped': { 'type': 'bool', |
3279 | 'features': [ 'unstable' ] } }, | |
c9d40709 | 3280 | 'features': [ { 'name': 'dynamic-auto-read-only', |
8a9f1e1d | 3281 | 'if': 'CONFIG_POSIX' } ] } |
1ad166b6 | 3282 | |
e819ab22 | 3283 | ## |
5072f7b3 | 3284 | # @BlockdevOptionsNull: |
e819ab22 FZ |
3285 | # |
3286 | # Driver specific block device options for the null backend. | |
3287 | # | |
26ec4e53 | 3288 | # @size: size of the device in bytes. |
a937b6aa | 3289 | # |
1d8bda12 | 3290 | # @latency-ns: emulated latency (in nanoseconds) in processing |
a937b6aa MA |
3291 | # requests. Default to zero which completes requests immediately. |
3292 | # (Since 2.4) | |
3293 | # | |
3294 | # @read-zeroes: if true, reads from the device produce zeroes; if | |
3295 | # false, the buffer is left unchanged. | |
3296 | # (default: false; since: 4.1) | |
e819ab22 | 3297 | # |
79b7a77e | 3298 | # Since: 2.9 |
e819ab22 | 3299 | ## |
895a2a80 | 3300 | { 'struct': 'BlockdevOptionsNull', |
128b05f7 | 3301 | 'data': { '*size': 'int', '*latency-ns': 'uint64', '*read-zeroes': 'bool' } } |
e819ab22 | 3302 | |
d87ee3d7 FZ |
3303 | ## |
3304 | # @BlockdevOptionsNVMe: | |
3305 | # | |
3306 | # Driver specific block device options for the NVMe backend. | |
3307 | # | |
a937b6aa MA |
3308 | # @device: PCI controller address of the NVMe device in format |
3309 | # hhhh:bb:ss.f (host:bus:slot.function) | |
3310 | # | |
d87ee3d7 FZ |
3311 | # @namespace: namespace number of the device, starting from 1. |
3312 | # | |
ecaf647f DB |
3313 | # Note that the PCI @device must have been unbound from any host |
3314 | # kernel driver before instructing QEMU to add the blockdev. | |
3315 | # | |
d87ee3d7 FZ |
3316 | # Since: 2.12 |
3317 | ## | |
3318 | { 'struct': 'BlockdevOptionsNVMe', | |
3319 | 'data': { 'device': 'str', 'namespace': 'int' } } | |
3320 | ||
1ad166b6 | 3321 | ## |
5072f7b3 | 3322 | # @BlockdevOptionsVVFAT: |
1ad166b6 BC |
3323 | # |
3324 | # Driver specific block device options for the vvfat protocol. | |
3325 | # | |
26ec4e53 | 3326 | # @dir: directory to be exported as FAT image |
a937b6aa | 3327 | # |
26ec4e53 | 3328 | # @fat-type: FAT type: 12, 16 or 32 |
a937b6aa MA |
3329 | # |
3330 | # @floppy: whether to export a floppy image (true) or partitioned hard | |
3331 | # disk (false; default) | |
3332 | # | |
3333 | # @label: set the volume label, limited to 11 bytes. FAT16 and FAT32 | |
3334 | # traditionally have some restrictions on labels, which are | |
3335 | # ignored by most operating systems. Defaults to "QEMU VVFAT". | |
3336 | # (since 2.4) | |
3337 | # | |
26ec4e53 | 3338 | # @rw: whether to allow write operations (default: false) |
1ad166b6 | 3339 | # |
79b7a77e | 3340 | # Since: 2.9 |
1ad166b6 | 3341 | ## |
895a2a80 | 3342 | { 'struct': 'BlockdevOptionsVVFAT', |
1ad166b6 | 3343 | 'data': { 'dir': 'str', '*fat-type': 'int', '*floppy': 'bool', |
d5941dda | 3344 | '*label': 'str', '*rw': 'bool' } } |
1ad166b6 BC |
3345 | |
3346 | ## | |
5072f7b3 | 3347 | # @BlockdevOptionsGenericFormat: |
1ad166b6 | 3348 | # |
a937b6aa MA |
3349 | # Driver specific block device options for image format that have no |
3350 | # option besides their data source. | |
1ad166b6 | 3351 | # |
26ec4e53 | 3352 | # @file: reference to or definition of the data source block device |
1ad166b6 | 3353 | # |
79b7a77e | 3354 | # Since: 2.9 |
1ad166b6 | 3355 | ## |
895a2a80 | 3356 | { 'struct': 'BlockdevOptionsGenericFormat', |
1ad166b6 BC |
3357 | 'data': { 'file': 'BlockdevRef' } } |
3358 | ||
78368575 | 3359 | ## |
5072f7b3 | 3360 | # @BlockdevOptionsLUKS: |
78368575 DB |
3361 | # |
3362 | # Driver specific block device options for LUKS. | |
3363 | # | |
a937b6aa MA |
3364 | # @key-secret: the ID of a QCryptoSecret object providing the |
3365 | # decryption key (since 2.6). Mandatory except when doing a | |
3366 | # metadata-only probe of the image. | |
78368575 | 3367 | # |
79b7a77e | 3368 | # Since: 2.9 |
78368575 DB |
3369 | ## |
3370 | { 'struct': 'BlockdevOptionsLUKS', | |
3371 | 'base': 'BlockdevOptionsGenericFormat', | |
3372 | 'data': { '*key-secret': 'str' } } | |
3373 | ||
1ad166b6 | 3374 | ## |
5072f7b3 | 3375 | # @BlockdevOptionsGenericCOWFormat: |
1ad166b6 | 3376 | # |
a937b6aa MA |
3377 | # Driver specific block device options for image format that have no |
3378 | # option besides their data source and an optional backing file. | |
1ad166b6 | 3379 | # |
26ec4e53 | 3380 | # @backing: reference to or definition of the backing file block |
a937b6aa MA |
3381 | # device, null disables the backing file entirely. Defaults to |
3382 | # the backing file stored the image file. | |
1ad166b6 | 3383 | # |
79b7a77e | 3384 | # Since: 2.9 |
1ad166b6 | 3385 | ## |
895a2a80 | 3386 | { 'struct': 'BlockdevOptionsGenericCOWFormat', |
1ad166b6 | 3387 | 'base': 'BlockdevOptionsGenericFormat', |
c42e8742 | 3388 | 'data': { '*backing': 'BlockdevRefOrNull' } } |
1ad166b6 | 3389 | |
f6585811 | 3390 | ## |
5072f7b3 | 3391 | # @Qcow2OverlapCheckMode: |
f6585811 HR |
3392 | # |
3393 | # General overlap check modes. | |
3394 | # | |
26ec4e53 | 3395 | # @none: Do not perform any checks |
f6585811 | 3396 | # |
a937b6aa MA |
3397 | # @constant: Perform only checks which can be done in constant time |
3398 | # and without reading anything from disk | |
f6585811 | 3399 | # |
a937b6aa MA |
3400 | # @cached: Perform only checks which can be done without reading |
3401 | # anything from disk | |
f6585811 | 3402 | # |
26ec4e53 | 3403 | # @all: Perform all available overlap checks |
f6585811 | 3404 | # |
79b7a77e | 3405 | # Since: 2.9 |
f6585811 HR |
3406 | ## |
3407 | { 'enum': 'Qcow2OverlapCheckMode', | |
3408 | 'data': [ 'none', 'constant', 'cached', 'all' ] } | |
3409 | ||
3410 | ## | |
5072f7b3 | 3411 | # @Qcow2OverlapCheckFlags: |
f6585811 | 3412 | # |
a937b6aa MA |
3413 | # Structure of flags for each metadata structure. Setting a field to |
3414 | # 'true' makes qemu guard that structure against unintended | |
3415 | # overwriting. The default value is chosen according to the template | |
3416 | # given. | |
f6585811 | 3417 | # |
a937b6aa MA |
3418 | # @template: Specifies a template mode which can be adjusted using the |
3419 | # other flags, defaults to 'cached' | |
f6585811 | 3420 | # |
0e4e4318 VSO |
3421 | # @bitmap-directory: since 3.0 |
3422 | # | |
79b7a77e | 3423 | # Since: 2.9 |
f6585811 | 3424 | ## |
895a2a80 | 3425 | { 'struct': 'Qcow2OverlapCheckFlags', |
0e4e4318 VSO |
3426 | 'data': { '*template': 'Qcow2OverlapCheckMode', |
3427 | '*main-header': 'bool', | |
3428 | '*active-l1': 'bool', | |
3429 | '*active-l2': 'bool', | |
3430 | '*refcount-table': 'bool', | |
3431 | '*refcount-block': 'bool', | |
3432 | '*snapshot-table': 'bool', | |
3433 | '*inactive-l1': 'bool', | |
3434 | '*inactive-l2': 'bool', | |
3435 | '*bitmap-directory': 'bool' } } | |
f6585811 HR |
3436 | |
3437 | ## | |
5072f7b3 | 3438 | # @Qcow2OverlapChecks: |
f6585811 | 3439 | # |
a937b6aa MA |
3440 | # Specifies which metadata structures should be guarded against |
3441 | # unintended overwriting. | |
f6585811 | 3442 | # |
a937b6aa MA |
3443 | # @flags: set of flags for separate specification of each metadata |
3444 | # structure type | |
f6585811 | 3445 | # |
26ec4e53 | 3446 | # @mode: named mode which chooses a specific set of flags |
f6585811 | 3447 | # |
79b7a77e | 3448 | # Since: 2.9 |
f6585811 | 3449 | ## |
ab916fad | 3450 | { 'alternate': 'Qcow2OverlapChecks', |
f6585811 HR |
3451 | 'data': { 'flags': 'Qcow2OverlapCheckFlags', |
3452 | 'mode': 'Qcow2OverlapCheckMode' } } | |
3453 | ||
d85f4222 DB |
3454 | ## |
3455 | # @BlockdevQcowEncryptionFormat: | |
3456 | # | |
3457 | # @aes: AES-CBC with plain64 initialization vectors | |
3458 | # | |
3459 | # Since: 2.10 | |
3460 | ## | |
3461 | { 'enum': 'BlockdevQcowEncryptionFormat', | |
3462 | 'data': [ 'aes' ] } | |
3463 | ||
3464 | ## | |
3465 | # @BlockdevQcowEncryption: | |
3466 | # | |
3467 | # Since: 2.10 | |
3468 | ## | |
3469 | { 'union': 'BlockdevQcowEncryption', | |
3470 | 'base': { 'format': 'BlockdevQcowEncryptionFormat' }, | |
3471 | 'discriminator': 'format', | |
3472 | 'data': { 'aes': 'QCryptoBlockOptionsQCow' } } | |
3473 | ||
3474 | ## | |
3475 | # @BlockdevOptionsQcow: | |
3476 | # | |
3477 | # Driver specific block device options for qcow. | |
3478 | # | |
a937b6aa MA |
3479 | # @encrypt: Image decryption options. Mandatory for encrypted images, |
3480 | # except when doing a metadata-only probe of the image. | |
d85f4222 DB |
3481 | # |
3482 | # Since: 2.10 | |
3483 | ## | |
3484 | { 'struct': 'BlockdevOptionsQcow', | |
3485 | 'base': 'BlockdevOptionsGenericCOWFormat', | |
3486 | 'data': { '*encrypt': 'BlockdevQcowEncryption' } } | |
3487 | ||
b25b387f DB |
3488 | ## |
3489 | # @BlockdevQcow2EncryptionFormat: | |
a9e2eb06 | 3490 | # |
58823a0b | 3491 | # @aes: AES-CBC with plain64 initialization vectors |
b25b387f DB |
3492 | # |
3493 | # Since: 2.10 | |
3494 | ## | |
3495 | { 'enum': 'BlockdevQcow2EncryptionFormat', | |
4652b8f3 | 3496 | 'data': [ 'aes', 'luks' ] } |
b25b387f DB |
3497 | |
3498 | ## | |
3499 | # @BlockdevQcow2Encryption: | |
3500 | # | |
3501 | # Since: 2.10 | |
3502 | ## | |
3503 | { 'union': 'BlockdevQcow2Encryption', | |
3504 | 'base': { 'format': 'BlockdevQcow2EncryptionFormat' }, | |
3505 | 'discriminator': 'format', | |
4652b8f3 DB |
3506 | 'data': { 'aes': 'QCryptoBlockOptionsQCow', |
3507 | 'luks': 'QCryptoBlockOptionsLUKS'} } | |
b25b387f | 3508 | |
33fa2222 VSO |
3509 | ## |
3510 | # @BlockdevOptionsPreallocate: | |
3511 | # | |
a937b6aa MA |
3512 | # Filter driver intended to be inserted between format and protocol |
3513 | # node and do preallocation in protocol node on write. | |
33fa2222 VSO |
3514 | # |
3515 | # @prealloc-align: on preallocation, align file length to this number, | |
a937b6aa | 3516 | # default 1048576 (1M) |
33fa2222 VSO |
3517 | # |
3518 | # @prealloc-size: how much to preallocate, default 134217728 (128M) | |
3519 | # | |
3520 | # Since: 6.0 | |
3521 | ## | |
3522 | { 'struct': 'BlockdevOptionsPreallocate', | |
3523 | 'base': 'BlockdevOptionsGenericFormat', | |
3524 | 'data': { '*prealloc-align': 'int', '*prealloc-size': 'int' } } | |
3525 | ||
1ad166b6 | 3526 | ## |
5072f7b3 | 3527 | # @BlockdevOptionsQcow2: |
1ad166b6 BC |
3528 | # |
3529 | # Driver specific block device options for qcow2. | |
3530 | # | |
a937b6aa MA |
3531 | # @lazy-refcounts: whether to enable the lazy refcounts feature |
3532 | # (default is taken from the image file) | |
1ad166b6 | 3533 | # |
a937b6aa MA |
3534 | # @pass-discard-request: whether discard requests to the qcow2 device |
3535 | # should be forwarded to the data source | |
1ad166b6 | 3536 | # |
1d8bda12 | 3537 | # @pass-discard-snapshot: whether discard requests for the data source |
a937b6aa MA |
3538 | # should be issued when a snapshot operation (e.g. deleting a |
3539 | # snapshot) frees clusters in the qcow2 file | |
1ad166b6 | 3540 | # |
26ec4e53 | 3541 | # @pass-discard-other: whether discard requests for the data source |
a937b6aa | 3542 | # should be issued on other occasions where a cluster gets freed |
1ad166b6 | 3543 | # |
b2b10904 JLD |
3544 | # @discard-no-unref: when enabled, data clusters will remain |
3545 | # preallocated when they are no longer used, e.g. because they are | |
3546 | # discarded or converted to zero clusters. As usual, whether the | |
3547 | # old data is discarded or kept on the protocol level (i.e. in the | |
3548 | # image file) depends on the setting of the pass-discard-request | |
3549 | # option. Keeping the clusters preallocated prevents qcow2 | |
3550 | # fragmentation that would otherwise be caused by freeing and | |
3551 | # re-allocating them later. Besides potential performance | |
3552 | # degradation, such fragmentation can lead to increased allocation | |
3553 | # of clusters past the end of the image file, resulting in image | |
3554 | # files whose file length can grow much larger than their guest disk | |
3555 | # size would suggest. If image file length is of concern (e.g. when | |
3556 | # storing qcow2 images directly on block devices), you should | |
3557 | # consider enabling this option. (since 8.1) | |
42a2890a | 3558 | # |
a937b6aa MA |
3559 | # @overlap-check: which overlap checks to perform for writes to the |
3560 | # image, defaults to 'cached' (since 2.2) | |
f6585811 | 3561 | # |
a937b6aa MA |
3562 | # @cache-size: the maximum total size of the L2 table and refcount |
3563 | # block caches in bytes (since 2.2) | |
f6585811 | 3564 | # |
a937b6aa MA |
3565 | # @l2-cache-size: the maximum size of the L2 table cache in bytes |
3566 | # (since 2.2) | |
f6585811 | 3567 | # |
26ec4e53 | 3568 | # @l2-cache-entry-size: the size of each entry in the L2 cache in |
a937b6aa MA |
3569 | # bytes. It must be a power of two between 512 and the cluster |
3570 | # size. The default value is the cluster size (since 2.12) | |
1221fe6f | 3571 | # |
26ec4e53 | 3572 | # @refcount-cache-size: the maximum size of the refcount block cache |
a937b6aa | 3573 | # in bytes (since 2.2) |
f6585811 | 3574 | # |
26ec4e53 | 3575 | # @cache-clean-interval: clean unused entries in the L2 and refcount |
a937b6aa MA |
3576 | # caches. The interval is in seconds. The default value is 600 |
3577 | # on supporting platforms, and 0 on other platforms. 0 disables | |
3578 | # this feature. (since 2.5) | |
e957b50b | 3579 | # |
a937b6aa MA |
3580 | # @encrypt: Image decryption options. Mandatory for encrypted images, |
3581 | # except when doing a metadata-only probe of the image. (since | |
3582 | # 2.10) | |
279621c0 | 3583 | # |
26ec4e53 | 3584 | # @data-file: reference to or definition of the external data file. |
a937b6aa MA |
3585 | # This may only be specified for images that require an external |
3586 | # data file. If it is not specified for such an image, the data | |
3587 | # file name is loaded from the image file. (since 4.0) | |
0e8c08be | 3588 | # |
79b7a77e | 3589 | # Since: 2.9 |
1ad166b6 | 3590 | ## |
895a2a80 | 3591 | { 'struct': 'BlockdevOptionsQcow2', |
1ad166b6 BC |
3592 | 'base': 'BlockdevOptionsGenericCOWFormat', |
3593 | 'data': { '*lazy-refcounts': 'bool', | |
3594 | '*pass-discard-request': 'bool', | |
3595 | '*pass-discard-snapshot': 'bool', | |
f6585811 | 3596 | '*pass-discard-other': 'bool', |
42a2890a | 3597 | '*discard-no-unref': 'bool', |
f6585811 HR |
3598 | '*overlap-check': 'Qcow2OverlapChecks', |
3599 | '*cache-size': 'int', | |
3600 | '*l2-cache-size': 'int', | |
1221fe6f | 3601 | '*l2-cache-entry-size': 'int', |
279621c0 | 3602 | '*refcount-cache-size': 'int', |
b25b387f | 3603 | '*cache-clean-interval': 'int', |
0e8c08be KW |
3604 | '*encrypt': 'BlockdevQcow2Encryption', |
3605 | '*data-file': 'BlockdevRef' } } | |
b1de5f43 | 3606 | |
ec2f5418 KW |
3607 | ## |
3608 | # @SshHostKeyCheckMode: | |
3609 | # | |
f5627506 | 3610 | # @none: Don't check the host key at all |
a937b6aa | 3611 | # |
f5627506 | 3612 | # @hash: Compare the host key with a given hash |
a937b6aa | 3613 | # |
f5627506 | 3614 | # @known_hosts: Check the host key against the known_hosts file |
ec2f5418 KW |
3615 | # |
3616 | # Since: 2.12 | |
3617 | ## | |
3618 | { 'enum': 'SshHostKeyCheckMode', | |
3619 | 'data': [ 'none', 'hash', 'known_hosts' ] } | |
3620 | ||
3621 | ## | |
3622 | # @SshHostKeyCheckHashType: | |
3623 | # | |
f5627506 | 3624 | # @md5: The given hash is an md5 hash |
a937b6aa | 3625 | # |
f5627506 | 3626 | # @sha1: The given hash is an sha1 hash |
a937b6aa | 3627 | # |
bf783261 | 3628 | # @sha256: The given hash is an sha256 hash |
ec2f5418 KW |
3629 | # |
3630 | # Since: 2.12 | |
3631 | ## | |
3632 | { 'enum': 'SshHostKeyCheckHashType', | |
bf783261 | 3633 | 'data': [ 'md5', 'sha1', 'sha256' ] } |
ec2f5418 KW |
3634 | |
3635 | ## | |
3636 | # @SshHostKeyHash: | |
3637 | # | |
f5627506 | 3638 | # @type: The hash algorithm used for the hash |
a937b6aa | 3639 | # |
f5627506 | 3640 | # @hash: The expected hash value |
ec2f5418 KW |
3641 | # |
3642 | # Since: 2.12 | |
3643 | ## | |
3644 | { 'struct': 'SshHostKeyHash', | |
3645 | 'data': { 'type': 'SshHostKeyCheckHashType', | |
3646 | 'hash': 'str' }} | |
3647 | ||
ec2f5418 KW |
3648 | ## |
3649 | # @SshHostKeyCheck: | |
3650 | # | |
3651 | # Since: 2.12 | |
3652 | ## | |
3653 | { 'union': 'SshHostKeyCheck', | |
3654 | 'base': { 'mode': 'SshHostKeyCheckMode' }, | |
3655 | 'discriminator': 'mode', | |
29cd0403 | 3656 | 'data': { 'hash': 'SshHostKeyHash' } } |
ec2f5418 | 3657 | |
ad0e90a6 | 3658 | ## |
5072f7b3 | 3659 | # @BlockdevOptionsSsh: |
ad0e90a6 | 3660 | # |
c0ac533b | 3661 | # @server: host address |
ad0e90a6 | 3662 | # |
c0ac533b | 3663 | # @path: path to the image on the host |
ad0e90a6 | 3664 | # |
c0ac533b | 3665 | # @user: user as which to connect, defaults to current local user name |
ad0e90a6 | 3666 | # |
c0ac533b | 3667 | # @host-key-check: Defines how and what to check the host key against |
a937b6aa | 3668 | # (default: known_hosts) |
ad0e90a6 | 3669 | # |
79b7a77e | 3670 | # Since: 2.9 |
ad0e90a6 AA |
3671 | ## |
3672 | { 'struct': 'BlockdevOptionsSsh', | |
3673 | 'data': { 'server': 'InetSocketAddress', | |
3674 | 'path': 'str', | |
ec2f5418 KW |
3675 | '*user': 'str', |
3676 | '*host-key-check': 'SshHostKeyCheck' } } | |
ad0e90a6 | 3677 | |
1ad166b6 | 3678 | ## |
5072f7b3 | 3679 | # @BlkdebugEvent: |
1ad166b6 BC |
3680 | # |
3681 | # Trigger events supported by blkdebug. | |
a31939e6 | 3682 | # |
26ec4e53 | 3683 | # @l1_shrink_write_table: write zeros to the l1 table to shrink image. |
a937b6aa | 3684 | # (since 2.11) |
46b732cd | 3685 | # |
a937b6aa | 3686 | # @l1_shrink_free_l2_clusters: discard the l2 tables. (since 2.11) |
46b732cd | 3687 | # |
d855ebcd EB |
3688 | # @cor_write: a write due to copy-on-read (since 2.11) |
3689 | # | |
a937b6aa MA |
3690 | # @cluster_alloc_space: an allocation of file space for a cluster |
3691 | # (since 4.1) | |
c8bb23cb | 3692 | # |
f8cec157 HR |
3693 | # @none: triggers once at creation of the blkdebug node (since 4.1) |
3694 | # | |
79b7a77e | 3695 | # Since: 2.9 |
1ad166b6 | 3696 | ## |
a31939e6 | 3697 | { 'enum': 'BlkdebugEvent', 'prefix': 'BLKDBG', |
5be5b776 EB |
3698 | 'data': [ 'l1_update', 'l1_grow_alloc_table', 'l1_grow_write_table', |
3699 | 'l1_grow_activate_table', 'l2_load', 'l2_update', | |
3700 | 'l2_update_compressed', 'l2_alloc_cow_read', 'l2_alloc_write', | |
1ad166b6 BC |
3701 | 'read_aio', 'read_backing_aio', 'read_compressed', 'write_aio', |
3702 | 'write_compressed', 'vmstate_load', 'vmstate_save', 'cow_read', | |
3703 | 'cow_write', 'reftable_load', 'reftable_grow', 'reftable_update', | |
3704 | 'refblock_load', 'refblock_update', 'refblock_update_part', | |
5be5b776 EB |
3705 | 'refblock_alloc', 'refblock_alloc_hookup', 'refblock_alloc_write', |
3706 | 'refblock_alloc_write_blocks', 'refblock_alloc_write_table', | |
3707 | 'refblock_alloc_switch_table', 'cluster_alloc', | |
1ad166b6 | 3708 | 'cluster_alloc_bytes', 'cluster_free', 'flush_to_os', |
5be5b776 EB |
3709 | 'flush_to_disk', 'pwritev_rmw_head', 'pwritev_rmw_after_head', |
3710 | 'pwritev_rmw_tail', 'pwritev_rmw_after_tail', 'pwritev', | |
46b732cd | 3711 | 'pwritev_zero', 'pwritev_done', 'empty_image_prepare', |
d855ebcd | 3712 | 'l1_shrink_write_table', 'l1_shrink_free_l2_clusters', |
f8cec157 | 3713 | 'cor_write', 'cluster_alloc_space', 'none'] } |
1ad166b6 | 3714 | |
16789db3 HR |
3715 | ## |
3716 | # @BlkdebugIOType: | |
3717 | # | |
3718 | # Kinds of I/O that blkdebug can inject errors in. | |
3719 | # | |
3720 | # @read: .bdrv_co_preadv() | |
3721 | # | |
3722 | # @write: .bdrv_co_pwritev() | |
3723 | # | |
3724 | # @write-zeroes: .bdrv_co_pwrite_zeroes() | |
3725 | # | |
3726 | # @discard: .bdrv_co_pdiscard() | |
3727 | # | |
3728 | # @flush: .bdrv_co_flush_to_disk() | |
3729 | # | |
1adb0b5e HR |
3730 | # @block-status: .bdrv_co_block_status() |
3731 | # | |
16789db3 HR |
3732 | # Since: 4.1 |
3733 | ## | |
3734 | { 'enum': 'BlkdebugIOType', 'prefix': 'BLKDEBUG_IO_TYPE', | |
1adb0b5e HR |
3735 | 'data': [ 'read', 'write', 'write-zeroes', 'discard', 'flush', |
3736 | 'block-status' ] } | |
16789db3 | 3737 | |
1ad166b6 | 3738 | ## |
5072f7b3 | 3739 | # @BlkdebugInjectErrorOptions: |
1ad166b6 BC |
3740 | # |
3741 | # Describes a single error injection for blkdebug. | |
3742 | # | |
26ec4e53 | 3743 | # @event: trigger event |
1ad166b6 | 3744 | # |
a937b6aa MA |
3745 | # @state: the state identifier blkdebug needs to be in to actually |
3746 | # trigger the event; defaults to "any" | |
1ad166b6 | 3747 | # |
a937b6aa MA |
3748 | # @iotype: the type of I/O operations on which this error should be |
3749 | # injected; defaults to "all read, write, write-zeroes, discard, | |
3750 | # and flush operations" (since: 4.1) | |
16789db3 | 3751 | # |
a937b6aa | 3752 | # @errno: error identifier (errno) to be returned; defaults to EIO |
1ad166b6 | 3753 | # |
a937b6aa MA |
3754 | # @sector: specifies the sector index which has to be affected in |
3755 | # order to actually trigger the event; defaults to "any sector" | |
1ad166b6 | 3756 | # |
a937b6aa MA |
3757 | # @once: disables further events after this one has been triggered; |
3758 | # defaults to false | |
1ad166b6 | 3759 | # |
1d8bda12 | 3760 | # @immediately: fail immediately; defaults to false |
1ad166b6 | 3761 | # |
79b7a77e | 3762 | # Since: 2.9 |
1ad166b6 | 3763 | ## |
895a2a80 | 3764 | { 'struct': 'BlkdebugInjectErrorOptions', |
1ad166b6 BC |
3765 | 'data': { 'event': 'BlkdebugEvent', |
3766 | '*state': 'int', | |
16789db3 | 3767 | '*iotype': 'BlkdebugIOType', |
1ad166b6 BC |
3768 | '*errno': 'int', |
3769 | '*sector': 'int', | |
3770 | '*once': 'bool', | |
3771 | '*immediately': 'bool' } } | |
3772 | ||
3773 | ## | |
5072f7b3 | 3774 | # @BlkdebugSetStateOptions: |
1ad166b6 BC |
3775 | # |
3776 | # Describes a single state-change event for blkdebug. | |
3777 | # | |
26ec4e53 | 3778 | # @event: trigger event |
1ad166b6 | 3779 | # |
26ec4e53 | 3780 | # @state: the current state identifier blkdebug needs to be in; |
a937b6aa | 3781 | # defaults to "any" |
1ad166b6 | 3782 | # |
26ec4e53 | 3783 | # @new_state: the state identifier blkdebug is supposed to assume if |
a937b6aa | 3784 | # this event is triggered |
1ad166b6 | 3785 | # |
79b7a77e | 3786 | # Since: 2.9 |
1ad166b6 | 3787 | ## |
895a2a80 | 3788 | { 'struct': 'BlkdebugSetStateOptions', |
1ad166b6 BC |
3789 | 'data': { 'event': 'BlkdebugEvent', |
3790 | '*state': 'int', | |
3791 | 'new_state': 'int' } } | |
3792 | ||
3793 | ## | |
5072f7b3 | 3794 | # @BlockdevOptionsBlkdebug: |
1ad166b6 BC |
3795 | # |
3796 | # Driver specific block device options for blkdebug. | |
3797 | # | |
26ec4e53 | 3798 | # @image: underlying raw block device (or image file) |
1ad166b6 | 3799 | # |
26ec4e53 | 3800 | # @config: filename of the configuration file |
1ad166b6 | 3801 | # |
a937b6aa MA |
3802 | # @align: required alignment for requests in bytes, must be positive |
3803 | # power of 2, or 0 for default | |
430b26a8 | 3804 | # |
26ec4e53 | 3805 | # @max-transfer: maximum size for I/O transfers in bytes, must be |
a937b6aa MA |
3806 | # positive multiple of @align and of the underlying file's request |
3807 | # alignment (but need not be a power of 2), or 0 for default | |
3808 | # (since 2.10) | |
430b26a8 | 3809 | # |
a937b6aa MA |
3810 | # @opt-write-zero: preferred alignment for write zero requests in |
3811 | # bytes, must be positive multiple of @align and of the underlying | |
3812 | # file's request alignment (but need not be a power of 2), or 0 | |
3813 | # for default (since 2.10) | |
430b26a8 | 3814 | # |
a937b6aa MA |
3815 | # @max-write-zero: maximum size for write zero requests in bytes, must |
3816 | # be positive multiple of @align, of @opt-write-zero, and of the | |
3817 | # underlying file's request alignment (but need not be a power of | |
3818 | # 2), or 0 for default (since 2.10) | |
430b26a8 | 3819 | # |
a937b6aa MA |
3820 | # @opt-discard: preferred alignment for discard requests in bytes, |
3821 | # must be positive multiple of @align and of the underlying file's | |
3822 | # request alignment (but need not be a power of 2), or 0 for | |
3823 | # default (since 2.10) | |
430b26a8 | 3824 | # |
26ec4e53 | 3825 | # @max-discard: maximum size for discard requests in bytes, must be |
a937b6aa MA |
3826 | # positive multiple of @align, of @opt-discard, and of the |
3827 | # underlying file's request alignment (but need not be a power of | |
3828 | # 2), or 0 for default (since 2.10) | |
1ad166b6 | 3829 | # |
26ec4e53 | 3830 | # @inject-error: array of error injection descriptions |
1ad166b6 | 3831 | # |
26ec4e53 | 3832 | # @set-state: array of state-change descriptions |
1ad166b6 | 3833 | # |
69c6449f | 3834 | # @take-child-perms: Permissions to take on @image in addition to what |
a937b6aa MA |
3835 | # is necessary anyway (which depends on how the blkdebug node is |
3836 | # used). Defaults to none. (since 5.0) | |
69c6449f HR |
3837 | # |
3838 | # @unshare-child-perms: Permissions not to share on @image in addition | |
a937b6aa MA |
3839 | # to what cannot be shared anyway (which depends on how the |
3840 | # blkdebug node is used). Defaults to none. (since 5.0) | |
69c6449f | 3841 | # |
79b7a77e | 3842 | # Since: 2.9 |
1ad166b6 | 3843 | ## |
895a2a80 | 3844 | { 'struct': 'BlockdevOptionsBlkdebug', |
1ad166b6 BC |
3845 | 'data': { 'image': 'BlockdevRef', |
3846 | '*config': 'str', | |
430b26a8 EB |
3847 | '*align': 'int', '*max-transfer': 'int32', |
3848 | '*opt-write-zero': 'int32', '*max-write-zero': 'int32', | |
3849 | '*opt-discard': 'int32', '*max-discard': 'int32', | |
1ad166b6 | 3850 | '*inject-error': ['BlkdebugInjectErrorOptions'], |
69c6449f HR |
3851 | '*set-state': ['BlkdebugSetStateOptions'], |
3852 | '*take-child-perms': ['BlockPermission'], | |
3853 | '*unshare-child-perms': ['BlockPermission'] } } | |
1ad166b6 | 3854 | |
bfcc224e AV |
3855 | ## |
3856 | # @BlockdevOptionsBlklogwrites: | |
3857 | # | |
3858 | # Driver specific block device options for blklogwrites. | |
3859 | # | |
26ec4e53 | 3860 | # @file: block device |
bfcc224e | 3861 | # |
26ec4e53 | 3862 | # @log: block device used to log writes to @file |
bfcc224e | 3863 | # |
a937b6aa MA |
3864 | # @log-sector-size: sector size used in logging writes to @file, |
3865 | # determines granularity of offsets and sizes of writes | |
3866 | # (default: 512) | |
bfcc224e | 3867 | # |
26ec4e53 | 3868 | # @log-append: append to an existing log (default: false) |
7769eaa5 | 3869 | # |
a937b6aa MA |
3870 | # @log-super-update-interval: interval of write requests after which |
3871 | # the log super block is updated to disk (default: 4096) | |
1dce698e | 3872 | # |
bfcc224e AV |
3873 | # Since: 3.0 |
3874 | ## | |
3875 | { 'struct': 'BlockdevOptionsBlklogwrites', | |
3876 | 'data': { 'file': 'BlockdevRef', | |
3877 | 'log': 'BlockdevRef', | |
0878b3c1 | 3878 | '*log-sector-size': 'uint32', |
1dce698e AS |
3879 | '*log-append': 'bool', |
3880 | '*log-super-update-interval': 'uint64' } } | |
bfcc224e | 3881 | |
1ad166b6 | 3882 | ## |
5072f7b3 | 3883 | # @BlockdevOptionsBlkverify: |
1ad166b6 BC |
3884 | # |
3885 | # Driver specific block device options for blkverify. | |
3886 | # | |
26ec4e53 | 3887 | # @test: block device to be tested |
1ad166b6 | 3888 | # |
26ec4e53 | 3889 | # @raw: raw image used for verification |
1ad166b6 | 3890 | # |
79b7a77e | 3891 | # Since: 2.9 |
1ad166b6 | 3892 | ## |
895a2a80 | 3893 | { 'struct': 'BlockdevOptionsBlkverify', |
1ad166b6 BC |
3894 | 'data': { 'test': 'BlockdevRef', |
3895 | 'raw': 'BlockdevRef' } } | |
3896 | ||
35e32d9e PD |
3897 | ## |
3898 | # @BlockdevOptionsBlkreplay: | |
3899 | # | |
3900 | # Driver specific block device options for blkreplay. | |
3901 | # | |
26ec4e53 | 3902 | # @image: disk image which should be controlled with blkreplay |
35e32d9e PD |
3903 | # |
3904 | # Since: 4.2 | |
3905 | ## | |
3906 | { 'struct': 'BlockdevOptionsBlkreplay', | |
3907 | 'data': { 'image': 'BlockdevRef' } } | |
3908 | ||
62c6031f | 3909 | ## |
5072f7b3 | 3910 | # @QuorumReadPattern: |
62c6031f LY |
3911 | # |
3912 | # An enumeration of quorum read patterns. | |
3913 | # | |
3914 | # @quorum: read all the children and do a quorum vote on reads | |
3915 | # | |
3916 | # @fifo: read only from the first child that has not failed | |
3917 | # | |
79b7a77e | 3918 | # Since: 2.9 |
62c6031f LY |
3919 | ## |
3920 | { 'enum': 'QuorumReadPattern', 'data': [ 'quorum', 'fifo' ] } | |
3921 | ||
1ad166b6 | 3922 | ## |
5072f7b3 | 3923 | # @BlockdevOptionsQuorum: |
1ad166b6 BC |
3924 | # |
3925 | # Driver specific block device options for Quorum | |
3926 | # | |
a937b6aa MA |
3927 | # @blkverify: true if the driver must print content mismatch set to |
3928 | # false by default | |
1ad166b6 | 3929 | # |
26ec4e53 | 3930 | # @children: the children block devices to use |
1ad166b6 BC |
3931 | # |
3932 | # @vote-threshold: the vote limit under which a read will fail | |
3933 | # | |
1d8bda12 | 3934 | # @rewrite-corrupted: rewrite corrupted data when quorum is reached |
a937b6aa | 3935 | # (Since 2.1) |
cf29a570 | 3936 | # |
1d8bda12 | 3937 | # @read-pattern: choose read pattern and set to quorum by default |
a937b6aa | 3938 | # (Since 2.2) |
62c6031f | 3939 | # |
79b7a77e | 3940 | # Since: 2.9 |
1ad166b6 | 3941 | ## |
895a2a80 | 3942 | { 'struct': 'BlockdevOptionsQuorum', |
1ad166b6 BC |
3943 | 'data': { '*blkverify': 'bool', |
3944 | 'children': [ 'BlockdevRef' ], | |
62c6031f LY |
3945 | 'vote-threshold': 'int', |
3946 | '*rewrite-corrupted': 'bool', | |
3947 | '*read-pattern': 'QuorumReadPattern' } } | |
1ad166b6 | 3948 | |
7edac2dd | 3949 | ## |
5072f7b3 | 3950 | # @BlockdevOptionsGluster: |
7edac2dd PKK |
3951 | # |
3952 | # Driver specific block device options for Gluster | |
3953 | # | |
26ec4e53 | 3954 | # @volume: name of gluster volume where VM image resides |
7edac2dd | 3955 | # |
26ec4e53 | 3956 | # @path: absolute path to image file in gluster volume |
7edac2dd | 3957 | # |
26ec4e53 | 3958 | # @server: gluster servers description |
7edac2dd | 3959 | # |
a937b6aa | 3960 | # @debug: libgfapi log level (default '4' which is Error) (Since 2.8) |
7edac2dd | 3961 | # |
26ec4e53 | 3962 | # @logfile: libgfapi log file (default /dev/stderr) (Since 2.8) |
e9db8ff3 | 3963 | # |
79b7a77e | 3964 | # Since: 2.9 |
7edac2dd PKK |
3965 | ## |
3966 | { 'struct': 'BlockdevOptionsGluster', | |
3967 | 'data': { 'volume': 'str', | |
3968 | 'path': 'str', | |
62cf396b | 3969 | 'server': ['SocketAddress'], |
1a417e46 | 3970 | '*debug': 'int', |
e9db8ff3 | 3971 | '*logfile': 'str' } } |
7edac2dd | 3972 | |
fd66dbd4 SH |
3973 | ## |
3974 | # @BlockdevOptionsIoUring: | |
3975 | # | |
3976 | # Driver specific block device options for the io_uring backend. | |
3977 | # | |
3978 | # @filename: path to the image file | |
3979 | # | |
3980 | # Since: 7.2 | |
3981 | ## | |
3982 | { 'struct': 'BlockdevOptionsIoUring', | |
3983 | 'data': { 'filename': 'str' }, | |
3984 | 'if': 'CONFIG_BLKIO' } | |
3985 | ||
3986 | ## | |
3987 | # @BlockdevOptionsNvmeIoUring: | |
3988 | # | |
3989 | # Driver specific block device options for the nvme-io_uring backend. | |
3990 | # | |
a937b6aa MA |
3991 | # @path: path to the NVMe namespace's character device (e.g. |
3992 | # /dev/ng0n1). | |
fd66dbd4 SH |
3993 | # |
3994 | # Since: 7.2 | |
3995 | ## | |
3996 | { 'struct': 'BlockdevOptionsNvmeIoUring', | |
6c32fc0d | 3997 | 'data': { 'path': 'str' }, |
fd66dbd4 SH |
3998 | 'if': 'CONFIG_BLKIO' } |
3999 | ||
03d9e4c0 AF |
4000 | ## |
4001 | # @BlockdevOptionsVirtioBlkVfioPci: | |
4002 | # | |
a937b6aa MA |
4003 | # Driver specific block device options for the virtio-blk-vfio-pci |
4004 | # backend. | |
03d9e4c0 AF |
4005 | # |
4006 | # @path: path to the PCI device's sysfs directory (e.g. | |
a937b6aa | 4007 | # /sys/bus/pci/devices/0000:00:01.0). |
03d9e4c0 AF |
4008 | # |
4009 | # Since: 7.2 | |
4010 | ## | |
4011 | { 'struct': 'BlockdevOptionsVirtioBlkVfioPci', | |
4012 | 'data': { 'path': 'str' }, | |
4013 | 'if': 'CONFIG_BLKIO' } | |
4014 | ||
fd66dbd4 SH |
4015 | ## |
4016 | # @BlockdevOptionsVirtioBlkVhostUser: | |
4017 | # | |
a937b6aa MA |
4018 | # Driver specific block device options for the virtio-blk-vhost-user |
4019 | # backend. | |
fd66dbd4 SH |
4020 | # |
4021 | # @path: path to the vhost-user UNIX domain socket. | |
4022 | # | |
4023 | # Since: 7.2 | |
4024 | ## | |
4025 | { 'struct': 'BlockdevOptionsVirtioBlkVhostUser', | |
4026 | 'data': { 'path': 'str' }, | |
4027 | 'if': 'CONFIG_BLKIO' } | |
4028 | ||
4029 | ## | |
4030 | # @BlockdevOptionsVirtioBlkVhostVdpa: | |
4031 | # | |
a937b6aa MA |
4032 | # Driver specific block device options for the virtio-blk-vhost-vdpa |
4033 | # backend. | |
fd66dbd4 SH |
4034 | # |
4035 | # @path: path to the vhost-vdpa character device. | |
4036 | # | |
98b126f5 SG |
4037 | # Features: |
4038 | # @fdset: Member @path supports the special "/dev/fdset/N" path | |
4039 | # (since 8.1) | |
4040 | # | |
fd66dbd4 SH |
4041 | # Since: 7.2 |
4042 | ## | |
4043 | { 'struct': 'BlockdevOptionsVirtioBlkVhostVdpa', | |
4044 | 'data': { 'path': 'str' }, | |
98b126f5 SG |
4045 | 'features': [ { 'name' :'fdset', |
4046 | 'if': 'CONFIG_BLKIO_VHOST_VDPA_FD' } ], | |
fd66dbd4 SH |
4047 | 'if': 'CONFIG_BLKIO' } |
4048 | ||
31eb1202 KW |
4049 | ## |
4050 | # @IscsiTransport: | |
4051 | # | |
4052 | # An enumeration of libiscsi transport types | |
4053 | # | |
4054 | # Since: 2.9 | |
4055 | ## | |
4056 | { 'enum': 'IscsiTransport', | |
4057 | 'data': [ 'tcp', 'iser' ] } | |
4058 | ||
4059 | ## | |
4060 | # @IscsiHeaderDigest: | |
4061 | # | |
4062 | # An enumeration of header digests supported by libiscsi | |
4063 | # | |
4064 | # Since: 2.9 | |
4065 | ## | |
4066 | { 'enum': 'IscsiHeaderDigest', | |
4067 | 'prefix': 'QAPI_ISCSI_HEADER_DIGEST', | |
4068 | 'data': [ 'crc32c', 'none', 'crc32c-none', 'none-crc32c' ] } | |
4069 | ||
4070 | ## | |
4071 | # @BlockdevOptionsIscsi: | |
4072 | # | |
26ec4e53 | 4073 | # @transport: The iscsi transport type |
31eb1202 | 4074 | # |
26ec4e53 | 4075 | # @portal: The address of the iscsi portal |
31eb1202 | 4076 | # |
26ec4e53 | 4077 | # @target: The target iqn name |
31eb1202 | 4078 | # |
a937b6aa | 4079 | # @lun: LUN to connect to. Defaults to 0. |
31eb1202 | 4080 | # |
a937b6aa MA |
4081 | # @user: User name to log in with. If omitted, no CHAP authentication |
4082 | # is performed. | |
31eb1202 | 4083 | # |
a937b6aa MA |
4084 | # @password-secret: The ID of a QCryptoSecret object providing the |
4085 | # password for the login. This option is required if @user is | |
4086 | # specified. | |
31eb1202 | 4087 | # |
a937b6aa MA |
4088 | # @initiator-name: The iqn name we want to identify to the target as. |
4089 | # If this option is not specified, an initiator name is generated | |
4090 | # automatically. | |
31eb1202 | 4091 | # |
a937b6aa | 4092 | # @header-digest: The desired header digest. Defaults to none-crc32c. |
31eb1202 | 4093 | # |
a937b6aa MA |
4094 | # @timeout: Timeout in seconds after which a request will timeout. 0 |
4095 | # means no timeout and is the default. | |
31eb1202 KW |
4096 | # |
4097 | # Driver specific block device options for iscsi | |
4098 | # | |
4099 | # Since: 2.9 | |
4100 | ## | |
4101 | { 'struct': 'BlockdevOptionsIscsi', | |
4102 | 'data': { 'transport': 'IscsiTransport', | |
4103 | 'portal': 'str', | |
4104 | 'target': 'str', | |
4105 | '*lun': 'int', | |
4106 | '*user': 'str', | |
4107 | '*password-secret': 'str', | |
4108 | '*initiator-name': 'str', | |
4109 | '*header-digest': 'IscsiHeaderDigest', | |
4110 | '*timeout': 'int' } } | |
4111 | ||
a3699de4 MA |
4112 | ## |
4113 | # @RbdAuthMode: | |
4114 | # | |
4115 | # Since: 3.0 | |
4116 | ## | |
4117 | { 'enum': 'RbdAuthMode', | |
4118 | 'data': [ 'cephx', 'none' ] } | |
4119 | ||
42e4ac9e OO |
4120 | ## |
4121 | # @RbdImageEncryptionFormat: | |
4122 | # | |
b8f218ef OO |
4123 | # @luks-any: Used for opening either luks or luks2 (Since 8.0) |
4124 | # | |
42e4ac9e OO |
4125 | # Since: 6.1 |
4126 | ## | |
4127 | { 'enum': 'RbdImageEncryptionFormat', | |
b8f218ef | 4128 | 'data': [ 'luks', 'luks2', 'luks-any' ] } |
42e4ac9e OO |
4129 | |
4130 | ## | |
4131 | # @RbdEncryptionOptionsLUKSBase: | |
4132 | # | |
a937b6aa MA |
4133 | # @key-secret: ID of a QCryptoSecret object providing a passphrase for |
4134 | # unlocking the encryption | |
42e4ac9e OO |
4135 | # |
4136 | # Since: 6.1 | |
4137 | ## | |
4138 | { 'struct': 'RbdEncryptionOptionsLUKSBase', | |
4139 | 'data': { 'key-secret': 'str' } } | |
4140 | ||
4141 | ## | |
4142 | # @RbdEncryptionCreateOptionsLUKSBase: | |
4143 | # | |
4144 | # @cipher-alg: The encryption algorithm | |
4145 | # | |
4146 | # Since: 6.1 | |
4147 | ## | |
4148 | { 'struct': 'RbdEncryptionCreateOptionsLUKSBase', | |
4149 | 'base': 'RbdEncryptionOptionsLUKSBase', | |
4150 | 'data': { '*cipher-alg': 'QCryptoCipherAlgorithm' } } | |
4151 | ||
4152 | ## | |
4153 | # @RbdEncryptionOptionsLUKS: | |
4154 | # | |
4155 | # Since: 6.1 | |
4156 | ## | |
4157 | { 'struct': 'RbdEncryptionOptionsLUKS', | |
4158 | 'base': 'RbdEncryptionOptionsLUKSBase', | |
4159 | 'data': { } } | |
4160 | ||
4161 | ## | |
4162 | # @RbdEncryptionOptionsLUKS2: | |
4163 | # | |
4164 | # Since: 6.1 | |
4165 | ## | |
4166 | { 'struct': 'RbdEncryptionOptionsLUKS2', | |
4167 | 'base': 'RbdEncryptionOptionsLUKSBase', | |
4168 | 'data': { } } | |
4169 | ||
b8f218ef OO |
4170 | ## |
4171 | # @RbdEncryptionOptionsLUKSAny: | |
4172 | # | |
4173 | # Since: 8.0 | |
4174 | ## | |
4175 | { 'struct': 'RbdEncryptionOptionsLUKSAny', | |
4176 | 'base': 'RbdEncryptionOptionsLUKSBase', | |
4177 | 'data': { } } | |
4178 | ||
42e4ac9e OO |
4179 | ## |
4180 | # @RbdEncryptionCreateOptionsLUKS: | |
4181 | # | |
4182 | # Since: 6.1 | |
4183 | ## | |
4184 | { 'struct': 'RbdEncryptionCreateOptionsLUKS', | |
4185 | 'base': 'RbdEncryptionCreateOptionsLUKSBase', | |
4186 | 'data': { } } | |
4187 | ||
4188 | ## | |
4189 | # @RbdEncryptionCreateOptionsLUKS2: | |
4190 | # | |
4191 | # Since: 6.1 | |
4192 | ## | |
4193 | { 'struct': 'RbdEncryptionCreateOptionsLUKS2', | |
4194 | 'base': 'RbdEncryptionCreateOptionsLUKSBase', | |
4195 | 'data': { } } | |
4196 | ||
4197 | ## | |
4198 | # @RbdEncryptionOptions: | |
4199 | # | |
0f385a24 OO |
4200 | # @format: Encryption format. |
4201 | # | |
a937b6aa MA |
4202 | # @parent: Parent image encryption options (for cloned images). Can |
4203 | # be left unspecified if this cloned image is encrypted using the | |
4204 | # same format and secret as its parent image (i.e. not explicitly | |
4205 | # formatted) or if its parent image is not encrypted. (Since 8.0) | |
0f385a24 | 4206 | # |
42e4ac9e OO |
4207 | # Since: 6.1 |
4208 | ## | |
4209 | { 'union': 'RbdEncryptionOptions', | |
0f385a24 OO |
4210 | 'base': { 'format': 'RbdImageEncryptionFormat', |
4211 | '*parent': 'RbdEncryptionOptions' }, | |
42e4ac9e OO |
4212 | 'discriminator': 'format', |
4213 | 'data': { 'luks': 'RbdEncryptionOptionsLUKS', | |
b8f218ef OO |
4214 | 'luks2': 'RbdEncryptionOptionsLUKS2', |
4215 | 'luks-any': 'RbdEncryptionOptionsLUKSAny'} } | |
42e4ac9e OO |
4216 | |
4217 | ## | |
4218 | # @RbdEncryptionCreateOptions: | |
4219 | # | |
4220 | # Since: 6.1 | |
4221 | ## | |
4222 | { 'union': 'RbdEncryptionCreateOptions', | |
4223 | 'base': { 'format': 'RbdImageEncryptionFormat' }, | |
4224 | 'discriminator': 'format', | |
4225 | 'data': { 'luks': 'RbdEncryptionCreateOptionsLUKS', | |
4226 | 'luks2': 'RbdEncryptionCreateOptionsLUKS2' } } | |
4227 | ||
8a47e8eb JC |
4228 | ## |
4229 | # @BlockdevOptionsRbd: | |
4230 | # | |
26ec4e53 | 4231 | # @pool: Ceph pool name. |
8a47e8eb | 4232 | # |
a937b6aa | 4233 | # @namespace: Rados namespace name in the Ceph pool. (Since 5.0) |
19ae9ae0 | 4234 | # |
26ec4e53 | 4235 | # @image: Image name in the Ceph pool. |
8a47e8eb | 4236 | # |
a937b6aa MA |
4237 | # @conf: path to Ceph configuration file. Values in the configuration |
4238 | # file will be overridden by options specified via QAPI. | |
8a47e8eb | 4239 | # |
26ec4e53 | 4240 | # @snapshot: Ceph snapshot name. |
8a47e8eb | 4241 | # |
a937b6aa | 4242 | # @encrypt: Image encryption options. (Since 6.1) |
42e4ac9e | 4243 | # |
26ec4e53 | 4244 | # @user: Ceph id name. |
8a47e8eb | 4245 | # |
a937b6aa MA |
4246 | # @auth-client-required: Acceptable authentication modes. This maps |
4247 | # to Ceph configuration option "auth_client_required". (Since | |
4248 | # 3.0) | |
a3699de4 | 4249 | # |
a937b6aa MA |
4250 | # @key-secret: ID of a QCryptoSecret object providing a key for cephx |
4251 | # authentication. This maps to Ceph configuration option "key". | |
4252 | # (Since 3.0) | |
d083f954 | 4253 | # |
a937b6aa MA |
4254 | # @server: Monitor host address and port. This maps to the "mon_host" |
4255 | # Ceph option. | |
0a55679b | 4256 | # |
8a47e8eb JC |
4257 | # Since: 2.9 |
4258 | ## | |
4259 | { 'struct': 'BlockdevOptionsRbd', | |
4260 | 'data': { 'pool': 'str', | |
19ae9ae0 | 4261 | '*namespace': 'str', |
8a47e8eb JC |
4262 | 'image': 'str', |
4263 | '*conf': 'str', | |
4264 | '*snapshot': 'str', | |
42e4ac9e | 4265 | '*encrypt': 'RbdEncryptionOptions', |
8a47e8eb | 4266 | '*user': 'str', |
a3699de4 | 4267 | '*auth-client-required': ['RbdAuthMode'], |
d083f954 | 4268 | '*key-secret': 'str', |
577d8c9a | 4269 | '*server': ['InetSocketAddressBase'] } } |
8a47e8eb | 4270 | |
190b9a8b | 4271 | ## |
5072f7b3 | 4272 | # @ReplicationMode: |
190b9a8b CX |
4273 | # |
4274 | # An enumeration of replication modes. | |
4275 | # | |
a937b6aa MA |
4276 | # @primary: Primary mode, the vm's state will be sent to secondary |
4277 | # QEMU. | |
190b9a8b | 4278 | # |
a937b6aa MA |
4279 | # @secondary: Secondary mode, receive the vm's state from primary |
4280 | # QEMU. | |
190b9a8b | 4281 | # |
79b7a77e | 4282 | # Since: 2.9 |
190b9a8b | 4283 | ## |
335d10cd | 4284 | { 'enum' : 'ReplicationMode', 'data' : [ 'primary', 'secondary' ], |
8a9f1e1d | 4285 | 'if': 'CONFIG_REPLICATION' } |
190b9a8b | 4286 | |
82ac5543 | 4287 | ## |
5072f7b3 | 4288 | # @BlockdevOptionsReplication: |
82ac5543 WC |
4289 | # |
4290 | # Driver specific block device options for replication | |
4291 | # | |
4292 | # @mode: the replication mode | |
4293 | # | |
a937b6aa MA |
4294 | # @top-id: In secondary mode, node name or device ID of the root node |
4295 | # who owns the replication node chain. Must not be given in | |
4296 | # primary mode. | |
82ac5543 | 4297 | # |
79b7a77e | 4298 | # Since: 2.9 |
82ac5543 WC |
4299 | ## |
4300 | { 'struct': 'BlockdevOptionsReplication', | |
4301 | 'base': 'BlockdevOptionsGenericFormat', | |
4302 | 'data': { 'mode': 'ReplicationMode', | |
335d10cd | 4303 | '*top-id': 'str' }, |
8a9f1e1d | 4304 | 'if': 'CONFIG_REPLICATION' } |
82ac5543 | 4305 | |
aa2623d8 | 4306 | ## |
5072f7b3 | 4307 | # @NFSTransport: |
aa2623d8 AA |
4308 | # |
4309 | # An enumeration of NFS transport types | |
4310 | # | |
26ec4e53 | 4311 | # @inet: TCP transport |
aa2623d8 | 4312 | # |
79b7a77e | 4313 | # Since: 2.9 |
aa2623d8 AA |
4314 | ## |
4315 | { 'enum': 'NFSTransport', | |
4316 | 'data': [ 'inet' ] } | |
4317 | ||
4318 | ## | |
5072f7b3 | 4319 | # @NFSServer: |
aa2623d8 AA |
4320 | # |
4321 | # Captures the address of the socket | |
4322 | # | |
26ec4e53 | 4323 | # @type: transport type used for NFS (only TCP supported) |
aa2623d8 | 4324 | # |
26ec4e53 | 4325 | # @host: host address for NFS server |
aa2623d8 | 4326 | # |
79b7a77e | 4327 | # Since: 2.9 |
aa2623d8 AA |
4328 | ## |
4329 | { 'struct': 'NFSServer', | |
4330 | 'data': { 'type': 'NFSTransport', | |
4331 | 'host': 'str' } } | |
4332 | ||
4333 | ## | |
5072f7b3 | 4334 | # @BlockdevOptionsNfs: |
aa2623d8 AA |
4335 | # |
4336 | # Driver specific block device option for NFS | |
4337 | # | |
26ec4e53 | 4338 | # @server: host address |
aa2623d8 | 4339 | # |
26ec4e53 | 4340 | # @path: path of the image on the host |
aa2623d8 | 4341 | # |
a937b6aa MA |
4342 | # @user: UID value to use when talking to the server (defaults to |
4343 | # 65534 on Windows and getuid() on unix) | |
aa2623d8 | 4344 | # |
a937b6aa MA |
4345 | # @group: GID value to use when talking to the server (defaults to |
4346 | # 65534 on Windows and getgid() in unix) | |
aa2623d8 | 4347 | # |
a937b6aa MA |
4348 | # @tcp-syn-count: number of SYNs during the session establishment |
4349 | # (defaults to libnfs default) | |
aa2623d8 | 4350 | # |
a937b6aa MA |
4351 | # @readahead-size: set the readahead size in bytes (defaults to libnfs |
4352 | # default) | |
aa2623d8 | 4353 | # |
a937b6aa MA |
4354 | # @page-cache-size: set the pagecache size in bytes (defaults to |
4355 | # libnfs default) | |
aa2623d8 | 4356 | # |
a937b6aa | 4357 | # @debug: set the NFS debug level (max 2) (defaults to libnfs default) |
aa2623d8 | 4358 | # |
79b7a77e | 4359 | # Since: 2.9 |
aa2623d8 AA |
4360 | ## |
4361 | { 'struct': 'BlockdevOptionsNfs', | |
4362 | 'data': { 'server': 'NFSServer', | |
4363 | 'path': 'str', | |
4364 | '*user': 'int', | |
4365 | '*group': 'int', | |
4366 | '*tcp-syn-count': 'int', | |
4367 | '*readahead-size': 'int', | |
4368 | '*page-cache-size': 'int', | |
7103d916 | 4369 | '*debug': 'int' } } |
aa2623d8 | 4370 | |
68555285 | 4371 | ## |
6b9d62db | 4372 | # @BlockdevOptionsCurlBase: |
68555285 | 4373 | # |
a937b6aa MA |
4374 | # Driver specific block device options shared by all protocols |
4375 | # supported by the curl backend. | |
68555285 | 4376 | # |
26ec4e53 | 4377 | # @url: URL of the image file |
6b9d62db | 4378 | # |
a937b6aa MA |
4379 | # @readahead: Size of the read-ahead cache; must be a multiple of 512 |
4380 | # (defaults to 256 kB) | |
6b9d62db | 4381 | # |
26ec4e53 | 4382 | # @timeout: Timeout for connections, in seconds (defaults to 5) |
6b9d62db | 4383 | # |
26ec4e53 | 4384 | # @username: Username for authentication (defaults to none) |
6b9d62db | 4385 | # |
26ec4e53 | 4386 | # @password-secret: ID of a QCryptoSecret object providing a password |
a937b6aa | 4387 | # for authentication (defaults to no password) |
6b9d62db | 4388 | # |
a937b6aa MA |
4389 | # @proxy-username: Username for proxy authentication (defaults to |
4390 | # none) | |
6b9d62db | 4391 | # |
a937b6aa MA |
4392 | # @proxy-password-secret: ID of a QCryptoSecret object providing a |
4393 | # password for proxy authentication (defaults to no password) | |
6b9d62db HR |
4394 | # |
4395 | # Since: 2.9 | |
4396 | ## | |
4397 | { 'struct': 'BlockdevOptionsCurlBase', | |
4398 | 'data': { 'url': 'str', | |
4399 | '*readahead': 'int', | |
4400 | '*timeout': 'int', | |
4401 | '*username': 'str', | |
4402 | '*password-secret': 'str', | |
4403 | '*proxy-username': 'str', | |
4404 | '*proxy-password-secret': 'str' } } | |
4405 | ||
4406 | ## | |
4407 | # @BlockdevOptionsCurlHttp: | |
4408 | # | |
a937b6aa MA |
4409 | # Driver specific block device options for HTTP connections over the |
4410 | # curl backend. URLs must start with "http://". | |
6b9d62db | 4411 | # |
a937b6aa MA |
4412 | # @cookie: List of cookies to set; format is "name1=content1; |
4413 | # name2=content2;" as explained by CURLOPT_COOKIE(3). Defaults to | |
4414 | # no cookies. | |
6b9d62db | 4415 | # |
a937b6aa MA |
4416 | # @cookie-secret: ID of a QCryptoSecret object providing the cookie |
4417 | # data in a secure way. See @cookie for the format. (since 2.10) | |
327c8ebd | 4418 | # |
6b9d62db HR |
4419 | # Since: 2.9 |
4420 | ## | |
4421 | { 'struct': 'BlockdevOptionsCurlHttp', | |
4422 | 'base': 'BlockdevOptionsCurlBase', | |
327c8ebd PK |
4423 | 'data': { '*cookie': 'str', |
4424 | '*cookie-secret': 'str'} } | |
6b9d62db HR |
4425 | |
4426 | ## | |
4427 | # @BlockdevOptionsCurlHttps: | |
4428 | # | |
a937b6aa MA |
4429 | # Driver specific block device options for HTTPS connections over the |
4430 | # curl backend. URLs must start with "https://". | |
6b9d62db | 4431 | # |
a937b6aa MA |
4432 | # @cookie: List of cookies to set; format is "name1=content1; |
4433 | # name2=content2;" as explained by CURLOPT_COOKIE(3). Defaults to | |
4434 | # no cookies. | |
6b9d62db | 4435 | # |
a937b6aa MA |
4436 | # @sslverify: Whether to verify the SSL certificate's validity |
4437 | # (defaults to true) | |
6b9d62db | 4438 | # |
a937b6aa MA |
4439 | # @cookie-secret: ID of a QCryptoSecret object providing the cookie |
4440 | # data in a secure way. See @cookie for the format. (since 2.10) | |
327c8ebd | 4441 | # |
6b9d62db HR |
4442 | # Since: 2.9 |
4443 | ## | |
4444 | { 'struct': 'BlockdevOptionsCurlHttps', | |
4445 | 'base': 'BlockdevOptionsCurlBase', | |
4446 | 'data': { '*cookie': 'str', | |
327c8ebd PK |
4447 | '*sslverify': 'bool', |
4448 | '*cookie-secret': 'str'} } | |
6b9d62db HR |
4449 | |
4450 | ## | |
4451 | # @BlockdevOptionsCurlFtp: | |
4452 | # | |
a937b6aa MA |
4453 | # Driver specific block device options for FTP connections over the |
4454 | # curl backend. URLs must start with "ftp://". | |
6b9d62db HR |
4455 | # |
4456 | # Since: 2.9 | |
4457 | ## | |
4458 | { 'struct': 'BlockdevOptionsCurlFtp', | |
4459 | 'base': 'BlockdevOptionsCurlBase', | |
4460 | 'data': { } } | |
4461 | ||
4462 | ## | |
4463 | # @BlockdevOptionsCurlFtps: | |
4464 | # | |
a937b6aa MA |
4465 | # Driver specific block device options for FTPS connections over the |
4466 | # curl backend. URLs must start with "ftps://". | |
6b9d62db | 4467 | # |
a937b6aa MA |
4468 | # @sslverify: Whether to verify the SSL certificate's validity |
4469 | # (defaults to true) | |
68555285 | 4470 | # |
79b7a77e | 4471 | # Since: 2.9 |
68555285 | 4472 | ## |
6b9d62db HR |
4473 | { 'struct': 'BlockdevOptionsCurlFtps', |
4474 | 'base': 'BlockdevOptionsCurlBase', | |
4475 | 'data': { '*sslverify': 'bool' } } | |
68555285 | 4476 | |
6b02b1f0 | 4477 | ## |
5072f7b3 | 4478 | # @BlockdevOptionsNbd: |
6b02b1f0 HR |
4479 | # |
4480 | # Driver specific block device options for NBD. | |
4481 | # | |
26ec4e53 | 4482 | # @server: NBD server address |
6b02b1f0 | 4483 | # |
26ec4e53 | 4484 | # @export: export name |
6b02b1f0 | 4485 | # |
26ec4e53 | 4486 | # @tls-creds: TLS credentials ID |
6b02b1f0 | 4487 | # |
a937b6aa MA |
4488 | # @tls-hostname: TLS hostname override for certificate validation |
4489 | # (Since 7.0) | |
4490 | # | |
4491 | # @x-dirty-bitmap: A metadata context name such as | |
4492 | # "qemu:dirty-bitmap:NAME" or "qemu:allocation-depth" to query in | |
4493 | # place of the traditional "base:allocation" block status (see | |
4494 | # NBD_OPT_LIST_META_CONTEXT in the NBD protocol; and yes, naming | |
4495 | # this option x-context would have made more sense) (since 3.0) | |
4496 | # | |
4497 | # @reconnect-delay: On an unexpected disconnect, the nbd client tries | |
4498 | # to connect again until succeeding or encountering a serious | |
4499 | # error. During the first @reconnect-delay seconds, all requests | |
4500 | # are paused and will be rerun on a successful reconnect. After | |
4501 | # that time, any delayed requests and all future requests before a | |
4502 | # successful reconnect will immediately fail. Default 0 (Since | |
4503 | # 4.2) | |
4504 | # | |
4505 | # @open-timeout: In seconds. If zero, the nbd driver tries the | |
4506 | # connection only once, and fails to open if the connection fails. | |
4507 | # If non-zero, the nbd driver will repeat connection attempts | |
4508 | # until successful or until @open-timeout seconds have elapsed. | |
4509 | # Default 0 (Since 7.0) | |
be16b8bf | 4510 | # |
9fb49daa | 4511 | # Features: |
a937b6aa | 4512 | # |
9fb49daa MA |
4513 | # @unstable: Member @x-dirty-bitmap is experimental. |
4514 | # | |
79b7a77e | 4515 | # Since: 2.9 |
6b02b1f0 HR |
4516 | ## |
4517 | { 'struct': 'BlockdevOptionsNbd', | |
62cf396b | 4518 | 'data': { 'server': 'SocketAddress', |
6b02b1f0 | 4519 | '*export': 'str', |
216ee365 | 4520 | '*tls-creds': 'str', |
a0cd6d29 | 4521 | '*tls-hostname': 'str', |
9fb49daa | 4522 | '*x-dirty-bitmap': { 'type': 'str', 'features': [ 'unstable' ] }, |
be16b8bf VSO |
4523 | '*reconnect-delay': 'uint32', |
4524 | '*open-timeout': 'uint32' } } | |
6b02b1f0 | 4525 | |
2fdc7045 | 4526 | ## |
5072f7b3 | 4527 | # @BlockdevOptionsRaw: |
2fdc7045 TG |
4528 | # |
4529 | # Driver specific block device options for the raw driver. | |
4530 | # | |
26ec4e53 | 4531 | # @offset: position where the block device starts |
a937b6aa | 4532 | # |
26ec4e53 | 4533 | # @size: the assumed size of the device |
2fdc7045 | 4534 | # |
79b7a77e | 4535 | # Since: 2.9 |
2fdc7045 TG |
4536 | ## |
4537 | { 'struct': 'BlockdevOptionsRaw', | |
4538 | 'base': 'BlockdevOptionsGenericFormat', | |
4539 | 'data': { '*offset': 'int', '*size': 'int' } } | |
4540 | ||
1ad166b6 | 4541 | ## |
d8e7d87e MP |
4542 | # @BlockdevOptionsThrottle: |
4543 | # | |
4544 | # Driver specific block device options for the throttle driver | |
4545 | # | |
a937b6aa MA |
4546 | # @throttle-group: the name of the throttle-group object to use. It |
4547 | # must already exist. | |
4548 | # | |
26ec4e53 | 4549 | # @file: reference to or definition of the data source block device |
4ae65a52 | 4550 | # |
d8e7d87e MP |
4551 | # Since: 2.11 |
4552 | ## | |
4553 | { 'struct': 'BlockdevOptionsThrottle', | |
4554 | 'data': { 'throttle-group': 'str', | |
4555 | 'file' : 'BlockdevRef' | |
4556 | } } | |
e4c8fddd AS |
4557 | |
4558 | ## | |
4559 | # @BlockdevOptionsCor: | |
4560 | # | |
4561 | # Driver specific block device options for the copy-on-read driver. | |
4562 | # | |
a937b6aa MA |
4563 | # @bottom: The name of a non-filter node (allocation-bearing layer) |
4564 | # that limits the COR operations in the backing chain (inclusive), | |
4565 | # so that no data below this node will be copied by this filter. | |
4566 | # If option is absent, the limit is not applied, so that data from | |
4567 | # all backing layers may be copied. | |
e4c8fddd AS |
4568 | # |
4569 | # Since: 6.0 | |
4570 | ## | |
4571 | { 'struct': 'BlockdevOptionsCor', | |
4572 | 'base': 'BlockdevOptionsGenericFormat', | |
4573 | 'data': { '*bottom': 'str' } } | |
4574 | ||
f1bb39a8 VSO |
4575 | ## |
4576 | # @OnCbwError: | |
4577 | # | |
4578 | # An enumeration of possible behaviors for copy-before-write operation | |
4579 | # failures. | |
4580 | # | |
a937b6aa MA |
4581 | # @break-guest-write: report the error to the guest. This way, the |
4582 | # guest will not be able to overwrite areas that cannot be backed | |
4583 | # up, so the backup process remains valid. | |
f1bb39a8 | 4584 | # |
a937b6aa MA |
4585 | # @break-snapshot: continue guest write. Doing so will make the |
4586 | # provided snapshot state invalid and any backup or export process | |
4587 | # based on it will finally fail. | |
f1bb39a8 VSO |
4588 | # |
4589 | # Since: 7.1 | |
4590 | ## | |
4591 | { 'enum': 'OnCbwError', | |
4592 | 'data': [ 'break-guest-write', 'break-snapshot' ] } | |
4593 | ||
783b2825 VSO |
4594 | ## |
4595 | # @BlockdevOptionsCbw: | |
4596 | # | |
a937b6aa MA |
4597 | # Driver specific block device options for the copy-before-write |
4598 | # driver, which does so called copy-before-write operations: when data | |
4599 | # is written to the filter, the filter first reads corresponding | |
4600 | # blocks from its file child and copies them to @target child. After | |
4601 | # successfully copying, the write request is propagated to file child. | |
4602 | # If copying fails, the original write request is failed too and no | |
4603 | # data is written to file child. | |
783b2825 VSO |
4604 | # |
4605 | # @target: The target for copy-before-write operations. | |
4606 | # | |
5f3a3cd7 | 4607 | # @bitmap: If specified, copy-before-write filter will do |
a937b6aa MA |
4608 | # copy-before-write operations only for dirty regions of the |
4609 | # bitmap. Bitmap size must be equal to length of file and target | |
4610 | # child of the filter. Note also, that bitmap is used only to | |
4611 | # initialize internal bitmap of the process, so further | |
4612 | # modifications (or removing) of specified bitmap doesn't | |
4613 | # influence the filter. (Since 7.0) | |
5f3a3cd7 | 4614 | # |
f1bb39a8 | 4615 | # @on-cbw-error: Behavior on failure of copy-before-write operation. |
a937b6aa | 4616 | # Default is @break-guest-write. (Since 7.1) |
f1bb39a8 | 4617 | # |
a937b6aa MA |
4618 | # @cbw-timeout: Zero means no limit. Non-zero sets the timeout in |
4619 | # seconds for copy-before-write operation. When a timeout occurs, | |
4620 | # the respective copy-before-write operation will fail, and the | |
4621 | # @on-cbw-error parameter will decide how this failure is handled. | |
4622 | # Default 0. (Since 7.1) | |
6db7fd1c | 4623 | # |
783b2825 VSO |
4624 | # Since: 6.2 |
4625 | ## | |
4626 | { 'struct': 'BlockdevOptionsCbw', | |
4627 | 'base': 'BlockdevOptionsGenericFormat', | |
f1bb39a8 | 4628 | 'data': { 'target': 'BlockdevRef', '*bitmap': 'BlockDirtyBitmap', |
6db7fd1c | 4629 | '*on-cbw-error': 'OnCbwError', '*cbw-timeout': 'uint32' } } |
783b2825 | 4630 | |
d8e7d87e | 4631 | ## |
5072f7b3 | 4632 | # @BlockdevOptions: |
1ad166b6 | 4633 | # |
a937b6aa MA |
4634 | # Options for creating a block device. Many options are available for |
4635 | # all block devices, independent of the block driver: | |
3666a97f | 4636 | # |
26ec4e53 | 4637 | # @driver: block driver name |
a937b6aa MA |
4638 | # |
4639 | # @node-name: the node name of the new node (Since 2.0). This option | |
4640 | # is required on the top level of blockdev-add. Valid node names | |
4641 | # start with an alphabetic character and may contain only | |
4642 | # alphanumeric characters, '-', '.' and '_'. Their maximum length | |
4643 | # is 31 characters. | |
4644 | # | |
26ec4e53 | 4645 | # @discard: discard-related options (default: ignore) |
a937b6aa | 4646 | # |
26ec4e53 | 4647 | # @cache: cache-related options |
a937b6aa MA |
4648 | # |
4649 | # @read-only: whether the block device should be read-only (default: | |
4650 | # false). Note that some block drivers support only read-only | |
4651 | # access, either generally or in certain configurations. In this | |
4652 | # case, the default value does not work and the option must be | |
4653 | # specified explicitly. | |
4654 | # | |
4655 | # @auto-read-only: if true and @read-only is false, QEMU may | |
4656 | # automatically decide not to open the image read-write as | |
4657 | # requested, but fall back to read-only instead (and switch | |
4658 | # between the modes later), e.g. depending on whether the image | |
4659 | # file is writable or whether a writing user is attached to the | |
4660 | # node (default: false, since 3.1) | |
4661 | # | |
1d8bda12 | 4662 | # @detect-zeroes: detect and optimize zero writes (Since 2.1) |
a937b6aa MA |
4663 | # (default: off) |
4664 | # | |
4665 | # @force-share: force share all permission on added nodes. Requires | |
4666 | # read-only=true. (Since 2.10) | |
3666a97f EB |
4667 | # |
4668 | # Remaining options are determined by the block driver. | |
1ad166b6 | 4669 | # |
79b7a77e | 4670 | # Since: 2.9 |
1ad166b6 BC |
4671 | ## |
4672 | { 'union': 'BlockdevOptions', | |
3666a97f | 4673 | 'base': { 'driver': 'BlockdevDriver', |
3666a97f EB |
4674 | '*node-name': 'str', |
4675 | '*discard': 'BlockdevDiscardOptions', | |
4676 | '*cache': 'BlockdevCacheOptions', | |
3666a97f | 4677 | '*read-only': 'bool', |
e35bdc12 | 4678 | '*auto-read-only': 'bool', |
5a9347c6 | 4679 | '*force-share': 'bool', |
3666a97f | 4680 | '*detect-zeroes': 'BlockdevDetectZeroesOptions' }, |
1ad166b6 BC |
4681 | 'discriminator': 'driver', |
4682 | 'data': { | |
db866be9 | 4683 | 'blkdebug': 'BlockdevOptionsBlkdebug', |
bfcc224e | 4684 | 'blklogwrites':'BlockdevOptionsBlklogwrites', |
db866be9 | 4685 | 'blkverify': 'BlockdevOptionsBlkverify', |
35e32d9e | 4686 | 'blkreplay': 'BlockdevOptionsBlkreplay', |
db866be9 FZ |
4687 | 'bochs': 'BlockdevOptionsGenericFormat', |
4688 | 'cloop': 'BlockdevOptionsGenericFormat', | |
f41388e0 | 4689 | 'compress': 'BlockdevOptionsGenericFormat', |
783b2825 | 4690 | 'copy-before-write':'BlockdevOptionsCbw', |
e4c8fddd | 4691 | 'copy-on-read':'BlockdevOptionsCor', |
db866be9 | 4692 | 'dmg': 'BlockdevOptionsGenericFormat', |
1ad166b6 | 4693 | 'file': 'BlockdevOptionsFile', |
6b9d62db HR |
4694 | 'ftp': 'BlockdevOptionsCurlFtp', |
4695 | 'ftps': 'BlockdevOptionsCurlFtps', | |
7edac2dd | 4696 | 'gluster': 'BlockdevOptionsGluster', |
14176c8d | 4697 | 'host_cdrom': { 'type': 'BlockdevOptionsFile', |
8a9f1e1d | 4698 | 'if': 'HAVE_HOST_BLOCK_DEVICE' }, |
14176c8d | 4699 | 'host_device': { 'type': 'BlockdevOptionsFile', |
8a9f1e1d | 4700 | 'if': 'HAVE_HOST_BLOCK_DEVICE' }, |
6b9d62db HR |
4701 | 'http': 'BlockdevOptionsCurlHttp', |
4702 | 'https': 'BlockdevOptionsCurlHttps', | |
fd66dbd4 SH |
4703 | 'io_uring': { 'type': 'BlockdevOptionsIoUring', |
4704 | 'if': 'CONFIG_BLKIO' }, | |
31eb1202 | 4705 | 'iscsi': 'BlockdevOptionsIscsi', |
78368575 | 4706 | 'luks': 'BlockdevOptionsLUKS', |
6b02b1f0 | 4707 | 'nbd': 'BlockdevOptionsNbd', |
aa2623d8 | 4708 | 'nfs': 'BlockdevOptionsNfs', |
db866be9 FZ |
4709 | 'null-aio': 'BlockdevOptionsNull', |
4710 | 'null-co': 'BlockdevOptionsNull', | |
d87ee3d7 | 4711 | 'nvme': 'BlockdevOptionsNVMe', |
fd66dbd4 SH |
4712 | 'nvme-io_uring': { 'type': 'BlockdevOptionsNvmeIoUring', |
4713 | 'if': 'CONFIG_BLKIO' }, | |
1ad166b6 | 4714 | 'parallels': 'BlockdevOptionsGenericFormat', |
33fa2222 | 4715 | 'preallocate':'BlockdevOptionsPreallocate', |
1ad166b6 | 4716 | 'qcow2': 'BlockdevOptionsQcow2', |
d85f4222 | 4717 | 'qcow': 'BlockdevOptionsQcow', |
1ad166b6 | 4718 | 'qed': 'BlockdevOptionsGenericCOWFormat', |
db866be9 | 4719 | 'quorum': 'BlockdevOptionsQuorum', |
2fdc7045 | 4720 | 'raw': 'BlockdevOptionsRaw', |
8a47e8eb | 4721 | 'rbd': 'BlockdevOptionsRbd', |
335d10cd | 4722 | 'replication': { 'type': 'BlockdevOptionsReplication', |
8a9f1e1d | 4723 | 'if': 'CONFIG_REPLICATION' }, |
1c14eaab | 4724 | 'snapshot-access': 'BlockdevOptionsGenericFormat', |
ad0e90a6 | 4725 | 'ssh': 'BlockdevOptionsSsh', |
d8e7d87e | 4726 | 'throttle': 'BlockdevOptionsThrottle', |
1ad166b6 BC |
4727 | 'vdi': 'BlockdevOptionsGenericFormat', |
4728 | 'vhdx': 'BlockdevOptionsGenericFormat', | |
03d9e4c0 AF |
4729 | 'virtio-blk-vfio-pci': |
4730 | { 'type': 'BlockdevOptionsVirtioBlkVfioPci', | |
4731 | 'if': 'CONFIG_BLKIO' }, | |
fd66dbd4 SH |
4732 | 'virtio-blk-vhost-user': |
4733 | { 'type': 'BlockdevOptionsVirtioBlkVhostUser', | |
4734 | 'if': 'CONFIG_BLKIO' }, | |
4735 | 'virtio-blk-vhost-vdpa': | |
4736 | { 'type': 'BlockdevOptionsVirtioBlkVhostVdpa', | |
4737 | 'if': 'CONFIG_BLKIO' }, | |
1ad166b6 BC |
4738 | 'vmdk': 'BlockdevOptionsGenericCOWFormat', |
4739 | 'vpc': 'BlockdevOptionsGenericFormat', | |
a0846452 | 4740 | 'vvfat': 'BlockdevOptionsVVFAT' |
1ad166b6 BC |
4741 | } } |
4742 | ||
4743 | ## | |
5072f7b3 | 4744 | # @BlockdevRef: |
1ad166b6 BC |
4745 | # |
4746 | # Reference to a block device. | |
4747 | # | |
26ec4e53 | 4748 | # @definition: defines a new block device inline |
a937b6aa | 4749 | # |
26ec4e53 | 4750 | # @reference: references the ID of an existing block device |
1ad166b6 | 4751 | # |
79b7a77e | 4752 | # Since: 2.9 |
1ad166b6 | 4753 | ## |
ab916fad | 4754 | { 'alternate': 'BlockdevRef', |
1ad166b6 BC |
4755 | 'data': { 'definition': 'BlockdevOptions', |
4756 | 'reference': 'str' } } | |
4757 | ||
c42e8742 MA |
4758 | ## |
4759 | # @BlockdevRefOrNull: | |
4760 | # | |
4761 | # Reference to a block device. | |
4762 | # | |
26ec4e53 | 4763 | # @definition: defines a new block device inline |
a937b6aa MA |
4764 | # |
4765 | # @reference: references the ID of an existing block device. An empty | |
4766 | # string means that no block device should be referenced. | |
4767 | # Deprecated; use null instead. | |
4768 | # | |
26ec4e53 | 4769 | # @null: No block device should be referenced (since 2.10) |
c42e8742 MA |
4770 | # |
4771 | # Since: 2.9 | |
4772 | ## | |
4773 | { 'alternate': 'BlockdevRefOrNull', | |
4774 | 'data': { 'definition': 'BlockdevOptions', | |
4775 | 'reference': 'str', | |
4776 | 'null': 'null' } } | |
4777 | ||
1ad166b6 BC |
4778 | ## |
4779 | # @blockdev-add: | |
4780 | # | |
e947e9c8 | 4781 | # Creates a new block device. |
1ad166b6 | 4782 | # |
79b7a77e | 4783 | # Since: 2.9 |
b4749948 | 4784 | # |
37fa48a4 | 4785 | # Examples: |
b4749948 | 4786 | # |
b4749948 MAL |
4787 | # -> { "execute": "blockdev-add", |
4788 | # "arguments": { | |
b1660997 JC |
4789 | # "driver": "qcow2", |
4790 | # "node-name": "test1", | |
34f58df5 | 4791 | # "file": { |
b1660997 JC |
4792 | # "driver": "file", |
4793 | # "filename": "test.qcow2" | |
4794 | # } | |
4795 | # } | |
4796 | # } | |
b4749948 MAL |
4797 | # <- { "return": {} } |
4798 | # | |
b4749948 MAL |
4799 | # -> { "execute": "blockdev-add", |
4800 | # "arguments": { | |
b1660997 JC |
4801 | # "driver": "qcow2", |
4802 | # "node-name": "node0", | |
4803 | # "discard": "unmap", | |
4804 | # "cache": { | |
4805 | # "direct": true | |
b4749948 | 4806 | # }, |
34f58df5 | 4807 | # "file": { |
b1660997 JC |
4808 | # "driver": "file", |
4809 | # "filename": "/tmp/test.qcow2" | |
b4749948 MAL |
4810 | # }, |
4811 | # "backing": { | |
b1660997 JC |
4812 | # "driver": "raw", |
4813 | # "file": { | |
4814 | # "driver": "file", | |
4815 | # "filename": "/dev/fdset/4" | |
b4749948 MAL |
4816 | # } |
4817 | # } | |
b4749948 MAL |
4818 | # } |
4819 | # } | |
4820 | # | |
4821 | # <- { "return": {} } | |
1ad166b6 | 4822 | ## |
f55ba801 PB |
4823 | { 'command': 'blockdev-add', 'data': 'BlockdevOptions', 'boxed': true, |
4824 | 'allow-preconfig': true } | |
1ad166b6 | 4825 | |
1479c730 | 4826 | ## |
e60edf69 | 4827 | # @blockdev-reopen: |
1479c730 | 4828 | # |
3908b7a8 | 4829 | # Reopens one or more block devices using the given set of options. |
a937b6aa MA |
4830 | # Any option not specified will be reset to its default value |
4831 | # regardless of its previous status. If an option cannot be changed | |
4832 | # or a particular driver does not support reopening then the command | |
4833 | # will return an error. All devices in the list are reopened in one | |
4834 | # transaction, so if one of them fails then the whole transaction is | |
4835 | # cancelled. | |
4836 | # | |
4837 | # The command receives a list of block devices to reopen. For each | |
4838 | # one of them, the top-level @node-name option (from BlockdevOptions) | |
4839 | # must be specified and is used to select the block device to be | |
4840 | # reopened. Other @node-name options must be either omitted or set to | |
4841 | # the current name of the appropriate node. This command won't change | |
4842 | # any node name and any attempt to do it will result in an error. | |
1479c730 AG |
4843 | # |
4844 | # In the case of options that refer to child nodes, the behavior of | |
4845 | # this command depends on the value: | |
4846 | # | |
4847 | # 1) A set of options (BlockdevOptions): the child is reopened with | |
4848 | # the specified set of options. | |
4849 | # | |
4850 | # 2) A reference to the current child: the child is reopened using | |
4851 | # its existing set of options. | |
4852 | # | |
4853 | # 3) A reference to a different node: the current child is replaced | |
4854 | # with the specified one. | |
4855 | # | |
4856 | # 4) NULL: the current child (if any) is detached. | |
4857 | # | |
a937b6aa | 4858 | # Options (1) and (2) are supported in all cases. Option (3) is |
3908b7a8 | 4859 | # supported for @file and @backing, and option (4) for @backing only. |
1479c730 AG |
4860 | # |
4861 | # Unlike with blockdev-add, the @backing option must always be present | |
4862 | # unless the node being reopened does not have a backing file and its | |
4863 | # image does not have a default backing file name as part of its | |
4864 | # metadata. | |
4865 | # | |
e60edf69 | 4866 | # Since: 6.1 |
1479c730 | 4867 | ## |
e60edf69 | 4868 | { 'command': 'blockdev-reopen', |
f55ba801 PB |
4869 | 'data': { 'options': ['BlockdevOptions'] }, |
4870 | 'allow-preconfig': true } | |
1479c730 | 4871 | |
81b936ae | 4872 | ## |
79b7a77e | 4873 | # @blockdev-del: |
81b936ae | 4874 | # |
a937b6aa MA |
4875 | # Deletes a block device that has been added using blockdev-add. The |
4876 | # command will fail if the node is attached to a device or is | |
9ec8873e | 4877 | # otherwise being used. |
81b936ae | 4878 | # |
7a305384 MAL |
4879 | # @node-name: Name of the graph node to delete. |
4880 | # | |
79b7a77e | 4881 | # Since: 2.9 |
915a213f MAL |
4882 | # |
4883 | # Example: | |
4884 | # | |
4885 | # -> { "execute": "blockdev-add", | |
4886 | # "arguments": { | |
b1660997 JC |
4887 | # "driver": "qcow2", |
4888 | # "node-name": "node0", | |
34f58df5 | 4889 | # "file": { |
b1660997 JC |
4890 | # "driver": "file", |
4891 | # "filename": "test.qcow2" | |
4892 | # } | |
915a213f MAL |
4893 | # } |
4894 | # } | |
4895 | # <- { "return": {} } | |
4896 | # | |
79b7a77e | 4897 | # -> { "execute": "blockdev-del", |
915a213f MAL |
4898 | # "arguments": { "node-name": "node0" } |
4899 | # } | |
4900 | # <- { "return": {} } | |
81b936ae | 4901 | ## |
f55ba801 PB |
4902 | { 'command': 'blockdev-del', 'data': { 'node-name': 'str' }, |
4903 | 'allow-preconfig': true } | |
81b936ae | 4904 | |
927f11e1 KW |
4905 | ## |
4906 | # @BlockdevCreateOptionsFile: | |
4907 | # | |
4908 | # Driver specific image creation options for file. | |
4909 | # | |
f5627506 | 4910 | # @filename: Filename for the new image file |
a937b6aa | 4911 | # |
f5627506 | 4912 | # @size: Size of the virtual disk in bytes |
a937b6aa | 4913 | # |
f5627506 | 4914 | # @preallocation: Preallocation mode for the new image (default: off; |
a937b6aa MA |
4915 | # allowed values: off, falloc (if CONFIG_POSIX_FALLOCATE), full |
4916 | # (if CONFIG_POSIX)) | |
4917 | # | |
f5627506 | 4918 | # @nocow: Turn off copy-on-write (valid only on btrfs; default: off) |
a937b6aa MA |
4919 | # |
4920 | # @extent-size-hint: Extent size hint to add to the image file; 0 for | |
4921 | # not adding an extent size hint (default: 1 MB, since 5.1) | |
927f11e1 KW |
4922 | # |
4923 | # Since: 2.12 | |
4924 | ## | |
4925 | { 'struct': 'BlockdevCreateOptionsFile', | |
ffa244c8 KW |
4926 | 'data': { 'filename': 'str', |
4927 | 'size': 'size', | |
4928 | '*preallocation': 'PreallocMode', | |
4929 | '*nocow': 'bool', | |
4930 | '*extent-size-hint': 'size'} } | |
927f11e1 | 4931 | |
ab8bda76 KW |
4932 | ## |
4933 | # @BlockdevCreateOptionsGluster: | |
4934 | # | |
4935 | # Driver specific image creation options for gluster. | |
4936 | # | |
f5627506 | 4937 | # @location: Where to store the new image file |
a937b6aa | 4938 | # |
f5627506 | 4939 | # @size: Size of the virtual disk in bytes |
a937b6aa | 4940 | # |
f5627506 | 4941 | # @preallocation: Preallocation mode for the new image (default: off; |
a937b6aa MA |
4942 | # allowed values: off, falloc (if CONFIG_GLUSTERFS_FALLOCATE), |
4943 | # full (if CONFIG_GLUSTERFS_ZEROFILL)) | |
ab8bda76 KW |
4944 | # |
4945 | # Since: 2.12 | |
4946 | ## | |
4947 | { 'struct': 'BlockdevCreateOptionsGluster', | |
4948 | 'data': { 'location': 'BlockdevOptionsGluster', | |
4949 | 'size': 'size', | |
4950 | '*preallocation': 'PreallocMode' } } | |
4951 | ||
1bedcaf1 KW |
4952 | ## |
4953 | # @BlockdevCreateOptionsLUKS: | |
4954 | # | |
4955 | # Driver specific image creation options for LUKS. | |
4956 | # | |
f5627506 | 4957 | # @file: Node to create the image format on |
a937b6aa | 4958 | # |
f5627506 | 4959 | # @size: Size of the virtual disk in bytes |
a937b6aa MA |
4960 | # |
4961 | # @preallocation: Preallocation mode for the new image (since: 4.2) | |
4962 | # (default: off; allowed values: off, metadata, falloc, full) | |
1bedcaf1 KW |
4963 | # |
4964 | # Since: 2.12 | |
4965 | ## | |
4966 | { 'struct': 'BlockdevCreateOptionsLUKS', | |
4967 | 'base': 'QCryptoBlockCreateOptionsLUKS', | |
4968 | 'data': { 'file': 'BlockdevRef', | |
672de729 ML |
4969 | 'size': 'size', |
4970 | '*preallocation': 'PreallocMode' } } | |
1bedcaf1 | 4971 | |
a1a42af4 KW |
4972 | ## |
4973 | # @BlockdevCreateOptionsNfs: | |
4974 | # | |
4975 | # Driver specific image creation options for NFS. | |
4976 | # | |
f5627506 | 4977 | # @location: Where to store the new image file |
a937b6aa | 4978 | # |
f5627506 | 4979 | # @size: Size of the virtual disk in bytes |
a1a42af4 KW |
4980 | # |
4981 | # Since: 2.12 | |
4982 | ## | |
4983 | { 'struct': 'BlockdevCreateOptionsNfs', | |
4984 | 'data': { 'location': 'BlockdevOptionsNfs', | |
4985 | 'size': 'size' } } | |
4986 | ||
1511b490 KW |
4987 | ## |
4988 | # @BlockdevCreateOptionsParallels: | |
4989 | # | |
4990 | # Driver specific image creation options for parallels. | |
4991 | # | |
f5627506 | 4992 | # @file: Node to create the image format on |
a937b6aa | 4993 | # |
f5627506 | 4994 | # @size: Size of the virtual disk in bytes |
a937b6aa | 4995 | # |
f5627506 | 4996 | # @cluster-size: Cluster size in bytes (default: 1 MB) |
1511b490 KW |
4997 | # |
4998 | # Since: 2.12 | |
4999 | ## | |
5000 | { 'struct': 'BlockdevCreateOptionsParallels', | |
5001 | 'data': { 'file': 'BlockdevRef', | |
5002 | 'size': 'size', | |
5003 | '*cluster-size': 'size' } } | |
5004 | ||
42a3e1ab KW |
5005 | ## |
5006 | # @BlockdevCreateOptionsQcow: | |
5007 | # | |
5008 | # Driver specific image creation options for qcow. | |
5009 | # | |
f5627506 | 5010 | # @file: Node to create the image format on |
a937b6aa | 5011 | # |
f5627506 | 5012 | # @size: Size of the virtual disk in bytes |
a937b6aa | 5013 | # |
f5627506 | 5014 | # @backing-file: File name of the backing file if a backing file |
a937b6aa MA |
5015 | # should be used |
5016 | # | |
f5627506 | 5017 | # @encrypt: Encryption options if the image should be encrypted |
42a3e1ab KW |
5018 | # |
5019 | # Since: 2.12 | |
5020 | ## | |
5021 | { 'struct': 'BlockdevCreateOptionsQcow', | |
5022 | 'data': { 'file': 'BlockdevRef', | |
5023 | 'size': 'size', | |
5024 | '*backing-file': 'str', | |
5025 | '*encrypt': 'QCryptoBlockCreateOptions' } } | |
5026 | ||
c2808aba KW |
5027 | ## |
5028 | # @BlockdevQcow2Version: | |
5029 | # | |
a937b6aa MA |
5030 | # @v2: The original QCOW2 format as introduced in qemu 0.10 (version |
5031 | # 2) | |
5032 | # | |
23e46452 | 5033 | # @v3: The extended QCOW2 format as introduced in qemu 1.1 (version 3) |
c2808aba KW |
5034 | # |
5035 | # Since: 2.12 | |
5036 | ## | |
5037 | { 'enum': 'BlockdevQcow2Version', | |
5038 | 'data': [ 'v2', 'v3' ] } | |
5039 | ||
572ad978 DP |
5040 | ## |
5041 | # @Qcow2CompressionType: | |
5042 | # | |
5043 | # Compression type used in qcow2 image file | |
5044 | # | |
5045 | # @zlib: zlib compression, see <http://zlib.net/> | |
a937b6aa | 5046 | # |
d298ac10 | 5047 | # @zstd: zstd compression, see <http://github.com/facebook/zstd> |
572ad978 DP |
5048 | # |
5049 | # Since: 5.1 | |
5050 | ## | |
5051 | { 'enum': 'Qcow2CompressionType', | |
8a9f1e1d | 5052 | 'data': [ 'zlib', { 'name': 'zstd', 'if': 'CONFIG_ZSTD' } ] } |
572ad978 | 5053 | |
c2808aba KW |
5054 | ## |
5055 | # @BlockdevCreateOptionsQcow2: | |
5056 | # | |
5057 | # Driver specific image creation options for qcow2. | |
5058 | # | |
f5627506 | 5059 | # @file: Node to create the image format on |
a937b6aa | 5060 | # |
f5627506 | 5061 | # @data-file: Node to use as an external data file in which all guest |
a937b6aa MA |
5062 | # data is stored so that only metadata remains in the qcow2 file |
5063 | # (since: 4.0) | |
5064 | # | |
f5627506 | 5065 | # @data-file-raw: True if the external data file must stay valid as a |
a937b6aa MA |
5066 | # standalone (read-only) raw image without looking at qcow2 |
5067 | # metadata (default: false; since: 4.0) | |
5068 | # | |
826bd069 | 5069 | # @extended-l2: True to make the image have extended L2 entries |
a937b6aa MA |
5070 | # (default: false; since 5.2) |
5071 | # | |
f5627506 | 5072 | # @size: Size of the virtual disk in bytes |
a937b6aa | 5073 | # |
f5627506 | 5074 | # @version: Compatibility level (default: v3) |
a937b6aa | 5075 | # |
f5627506 | 5076 | # @backing-file: File name of the backing file if a backing file |
a937b6aa MA |
5077 | # should be used |
5078 | # | |
f5627506 | 5079 | # @backing-fmt: Name of the block driver to use for the backing file |
a937b6aa | 5080 | # |
f5627506 | 5081 | # @encrypt: Encryption options if the image should be encrypted |
a937b6aa | 5082 | # |
f5627506 | 5083 | # @cluster-size: qcow2 cluster size in bytes (default: 65536) |
a937b6aa | 5084 | # |
f5627506 | 5085 | # @preallocation: Preallocation mode for the new image (default: off; |
a937b6aa MA |
5086 | # allowed values: off, falloc, full, metadata) |
5087 | # | |
5088 | # @lazy-refcounts: True if refcounts may be updated lazily | |
5089 | # (default: off) | |
5090 | # | |
f5627506 | 5091 | # @refcount-bits: Width of reference counts in bits (default: 16) |
a937b6aa | 5092 | # |
572ad978 | 5093 | # @compression-type: The image cluster compression method |
a937b6aa | 5094 | # (default: zlib, since 5.1) |
c2808aba KW |
5095 | # |
5096 | # Since: 2.12 | |
5097 | ## | |
5098 | { 'struct': 'BlockdevCreateOptionsQcow2', | |
5099 | 'data': { 'file': 'BlockdevRef', | |
dcc98687 | 5100 | '*data-file': 'BlockdevRef', |
6c3944dc | 5101 | '*data-file-raw': 'bool', |
7be20252 | 5102 | '*extended-l2': 'bool', |
c2808aba KW |
5103 | 'size': 'size', |
5104 | '*version': 'BlockdevQcow2Version', | |
5105 | '*backing-file': 'str', | |
5106 | '*backing-fmt': 'BlockdevDriver', | |
5107 | '*encrypt': 'QCryptoBlockCreateOptions', | |
5108 | '*cluster-size': 'size', | |
5109 | '*preallocation': 'PreallocMode', | |
5110 | '*lazy-refcounts': 'bool', | |
572ad978 DP |
5111 | '*refcount-bits': 'int', |
5112 | '*compression-type':'Qcow2CompressionType' } } | |
c2808aba | 5113 | |
959355a4 KW |
5114 | ## |
5115 | # @BlockdevCreateOptionsQed: | |
5116 | # | |
5117 | # Driver specific image creation options for qed. | |
5118 | # | |
f5627506 | 5119 | # @file: Node to create the image format on |
a937b6aa | 5120 | # |
f5627506 | 5121 | # @size: Size of the virtual disk in bytes |
a937b6aa | 5122 | # |
f5627506 | 5123 | # @backing-file: File name of the backing file if a backing file |
a937b6aa MA |
5124 | # should be used |
5125 | # | |
f5627506 | 5126 | # @backing-fmt: Name of the block driver to use for the backing file |
a937b6aa | 5127 | # |
f5627506 | 5128 | # @cluster-size: Cluster size in bytes (default: 65536) |
a937b6aa | 5129 | # |
f5627506 | 5130 | # @table-size: L1/L2 table size (in clusters) |
959355a4 KW |
5131 | # |
5132 | # Since: 2.12 | |
5133 | ## | |
5134 | { 'struct': 'BlockdevCreateOptionsQed', | |
5135 | 'data': { 'file': 'BlockdevRef', | |
5136 | 'size': 'size', | |
5137 | '*backing-file': 'str', | |
5138 | '*backing-fmt': 'BlockdevDriver', | |
5139 | '*cluster-size': 'size', | |
5140 | '*table-size': 'int' } } | |
5141 | ||
1bebea37 KW |
5142 | ## |
5143 | # @BlockdevCreateOptionsRbd: | |
5144 | # | |
5145 | # Driver specific image creation options for rbd/Ceph. | |
5146 | # | |
a937b6aa MA |
5147 | # @location: Where to store the new image file. This location cannot |
5148 | # point to a snapshot. | |
5149 | # | |
f5627506 | 5150 | # @size: Size of the virtual disk in bytes |
a937b6aa | 5151 | # |
f5627506 | 5152 | # @cluster-size: RBD object size |
a937b6aa MA |
5153 | # |
5154 | # @encrypt: Image encryption options. (Since 6.1) | |
1bebea37 KW |
5155 | # |
5156 | # Since: 2.12 | |
5157 | ## | |
5158 | { 'struct': 'BlockdevCreateOptionsRbd', | |
5159 | 'data': { 'location': 'BlockdevOptionsRbd', | |
5160 | 'size': 'size', | |
42e4ac9e OO |
5161 | '*cluster-size' : 'size', |
5162 | '*encrypt' : 'RbdEncryptionCreateOptions' } } | |
1bebea37 | 5163 | |
3015372d FZ |
5164 | ## |
5165 | # @BlockdevVmdkSubformat: | |
5166 | # | |
5167 | # Subformat options for VMDK images | |
5168 | # | |
c0ac533b | 5169 | # @monolithicSparse: Single file image with sparse cluster allocation |
3015372d | 5170 | # |
c0ac533b | 5171 | # @monolithicFlat: Single flat data image and a descriptor file |
3015372d | 5172 | # |
a937b6aa MA |
5173 | # @twoGbMaxExtentSparse: Data is split into 2GB (per virtual LBA) |
5174 | # sparse extent files, in addition to a descriptor file | |
3015372d | 5175 | # |
a937b6aa MA |
5176 | # @twoGbMaxExtentFlat: Data is split into 2GB (per virtual LBA) flat |
5177 | # extent files, in addition to a descriptor file | |
3015372d | 5178 | # |
a937b6aa MA |
5179 | # @streamOptimized: Single file image sparse cluster allocation, |
5180 | # optimized for streaming over network. | |
3015372d FZ |
5181 | # |
5182 | # Since: 4.0 | |
5183 | ## | |
5184 | { 'enum': 'BlockdevVmdkSubformat', | |
5185 | 'data': [ 'monolithicSparse', 'monolithicFlat', 'twoGbMaxExtentSparse', | |
5186 | 'twoGbMaxExtentFlat', 'streamOptimized'] } | |
5187 | ||
5188 | ## | |
5189 | # @BlockdevVmdkAdapterType: | |
5190 | # | |
5191 | # Adapter type info for VMDK images | |
5192 | # | |
5193 | # Since: 4.0 | |
5194 | ## | |
5195 | { 'enum': 'BlockdevVmdkAdapterType', | |
5196 | 'data': [ 'ide', 'buslogic', 'lsilogic', 'legacyESX'] } | |
5197 | ||
5198 | ## | |
5199 | # @BlockdevCreateOptionsVmdk: | |
5200 | # | |
5201 | # Driver specific image creation options for VMDK. | |
5202 | # | |
a937b6aa MA |
5203 | # @file: Where to store the new image file. This refers to the image |
5204 | # file for monolithcSparse and streamOptimized format, or the | |
5205 | # descriptor file for other formats. | |
5206 | # | |
f5627506 | 5207 | # @size: Size of the virtual disk in bytes |
a937b6aa MA |
5208 | # |
5209 | # @extents: Where to store the data extents. Required for | |
5210 | # monolithcFlat, twoGbMaxExtentSparse and twoGbMaxExtentFlat | |
5211 | # formats. For monolithicFlat, only one entry is required; for | |
5212 | # twoGbMaxExtent* formats, the number of entries required is | |
5213 | # calculated as extent_number = virtual_size / 2GB. Providing more | |
5214 | # extents than will be used is an error. | |
5215 | # | |
5216 | # @subformat: The subformat of the VMDK image. Default: | |
5217 | # "monolithicSparse". | |
5218 | # | |
5219 | # @backing-file: The path of backing file. Default: no backing file | |
5220 | # is used. | |
5221 | # | |
5222 | # @adapter-type: The adapter type used to fill in the descriptor. | |
5223 | # Default: ide. | |
5224 | # | |
5225 | # @hwversion: Hardware version. The meaningful options are "4" or | |
5226 | # "6". Default: "4". | |
5227 | # | |
5228 | # @toolsversion: VMware guest tools version. Default: "2147483647" | |
5229 | # (Since 6.2) | |
5230 | # | |
5231 | # @zeroed-grain: Whether to enable zeroed-grain feature for sparse | |
5232 | # subformats. Default: false. | |
3015372d FZ |
5233 | # |
5234 | # Since: 4.0 | |
5235 | ## | |
5236 | { 'struct': 'BlockdevCreateOptionsVmdk', | |
5237 | 'data': { 'file': 'BlockdevRef', | |
5238 | 'size': 'size', | |
5239 | '*extents': ['BlockdevRef'], | |
5240 | '*subformat': 'BlockdevVmdkSubformat', | |
5241 | '*backing-file': 'str', | |
5242 | '*adapter-type': 'BlockdevVmdkAdapterType', | |
5243 | '*hwversion': 'str', | |
f3d43dfd | 5244 | '*toolsversion': 'str', |
3015372d FZ |
5245 | '*zeroed-grain': 'bool' } } |
5246 | ||
4906da7e KW |
5247 | ## |
5248 | # @BlockdevCreateOptionsSsh: | |
5249 | # | |
5250 | # Driver specific image creation options for SSH. | |
5251 | # | |
f5627506 | 5252 | # @location: Where to store the new image file |
a937b6aa | 5253 | # |
f5627506 | 5254 | # @size: Size of the virtual disk in bytes |
4906da7e KW |
5255 | # |
5256 | # Since: 2.12 | |
5257 | ## | |
5258 | { 'struct': 'BlockdevCreateOptionsSsh', | |
5259 | 'data': { 'location': 'BlockdevOptionsSsh', | |
5260 | 'size': 'size' } } | |
5261 | ||
49858b50 HR |
5262 | ## |
5263 | # @BlockdevCreateOptionsVdi: | |
5264 | # | |
5265 | # Driver specific image creation options for VDI. | |
5266 | # | |
f5627506 | 5267 | # @file: Node to create the image format on |
a937b6aa | 5268 | # |
f5627506 | 5269 | # @size: Size of the virtual disk in bytes |
a937b6aa | 5270 | # |
f5627506 | 5271 | # @preallocation: Preallocation mode for the new image (default: off; |
a937b6aa | 5272 | # allowed values: off, metadata) |
49858b50 HR |
5273 | # |
5274 | # Since: 2.12 | |
5275 | ## | |
5276 | { 'struct': 'BlockdevCreateOptionsVdi', | |
5277 | 'data': { 'file': 'BlockdevRef', | |
5278 | 'size': 'size', | |
61fa6487 | 5279 | '*preallocation': 'PreallocMode' } } |
49858b50 | 5280 | |
09b68dab KW |
5281 | ## |
5282 | # @BlockdevVhdxSubformat: | |
5283 | # | |
5284 | # @dynamic: Growing image file | |
a937b6aa | 5285 | # |
c0ac533b | 5286 | # @fixed: Preallocated fixed-size image file |
09b68dab KW |
5287 | # |
5288 | # Since: 2.12 | |
5289 | ## | |
5290 | { 'enum': 'BlockdevVhdxSubformat', | |
5291 | 'data': [ 'dynamic', 'fixed' ] } | |
5292 | ||
5293 | ## | |
5294 | # @BlockdevCreateOptionsVhdx: | |
5295 | # | |
5296 | # Driver specific image creation options for vhdx. | |
5297 | # | |
f5627506 | 5298 | # @file: Node to create the image format on |
a937b6aa | 5299 | # |
f5627506 | 5300 | # @size: Size of the virtual disk in bytes |
a937b6aa MA |
5301 | # |
5302 | # @log-size: Log size in bytes, must be a multiple of 1 MB (default: 1 | |
5303 | # MB) | |
5304 | # | |
f5627506 | 5305 | # @block-size: Block size in bytes, must be a multiple of 1 MB and not |
a937b6aa MA |
5306 | # larger than 256 MB (default: automatically choose a block size |
5307 | # depending on the image size) | |
5308 | # | |
f5627506 | 5309 | # @subformat: vhdx subformat (default: dynamic) |
a937b6aa | 5310 | # |
9e272073 MA |
5311 | # @block-state-zero: Force use of payload blocks of type 'ZERO'. |
5312 | # Non-standard, but default. Do not set to 'off' when using | |
5313 | # 'qemu-img convert' with subformat=dynamic. | |
09b68dab KW |
5314 | # |
5315 | # Since: 2.12 | |
5316 | ## | |
5317 | { 'struct': 'BlockdevCreateOptionsVhdx', | |
5318 | 'data': { 'file': 'BlockdevRef', | |
5319 | 'size': 'size', | |
5320 | '*log-size': 'size', | |
5321 | '*block-size': 'size', | |
5322 | '*subformat': 'BlockdevVhdxSubformat', | |
5323 | '*block-state-zero': 'bool' } } | |
5324 | ||
182c8835 KW |
5325 | ## |
5326 | # @BlockdevVpcSubformat: | |
5327 | # | |
5328 | # @dynamic: Growing image file | |
a937b6aa | 5329 | # |
c0ac533b | 5330 | # @fixed: Preallocated fixed-size image file |
182c8835 KW |
5331 | # |
5332 | # Since: 2.12 | |
5333 | ## | |
5334 | { 'enum': 'BlockdevVpcSubformat', | |
5335 | 'data': [ 'dynamic', 'fixed' ] } | |
5336 | ||
5337 | ## | |
5338 | # @BlockdevCreateOptionsVpc: | |
5339 | # | |
5340 | # Driver specific image creation options for vpc (VHD). | |
5341 | # | |
f5627506 | 5342 | # @file: Node to create the image format on |
a937b6aa | 5343 | # |
f5627506 | 5344 | # @size: Size of the virtual disk in bytes |
a937b6aa | 5345 | # |
f5627506 | 5346 | # @subformat: vhdx subformat (default: dynamic) |
a937b6aa MA |
5347 | # |
5348 | # @force-size: Force use of the exact byte size instead of rounding to | |
5349 | # the next size that can be represented in CHS geometry | |
5350 | # (default: false) | |
182c8835 KW |
5351 | # |
5352 | # Since: 2.12 | |
5353 | ## | |
5354 | { 'struct': 'BlockdevCreateOptionsVpc', | |
5355 | 'data': { 'file': 'BlockdevRef', | |
5356 | 'size': 'size', | |
5357 | '*subformat': 'BlockdevVpcSubformat', | |
5358 | '*force-size': 'bool' } } | |
5359 | ||
53614689 KW |
5360 | ## |
5361 | # @BlockdevCreateOptions: | |
5362 | # | |
5363 | # Options for creating an image format on a given node. | |
5364 | # | |
f5627506 | 5365 | # @driver: block driver to create the image format |
53614689 KW |
5366 | # |
5367 | # Since: 2.12 | |
5368 | ## | |
5369 | { 'union': 'BlockdevCreateOptions', | |
5370 | 'base': { | |
5371 | 'driver': 'BlockdevDriver' }, | |
5372 | 'discriminator': 'driver', | |
5373 | 'data': { | |
927f11e1 | 5374 | 'file': 'BlockdevCreateOptionsFile', |
ab8bda76 | 5375 | 'gluster': 'BlockdevCreateOptionsGluster', |
1bedcaf1 | 5376 | 'luks': 'BlockdevCreateOptionsLUKS', |
a1a42af4 | 5377 | 'nfs': 'BlockdevCreateOptionsNfs', |
1511b490 | 5378 | 'parallels': 'BlockdevCreateOptionsParallels', |
42a3e1ab | 5379 | 'qcow': 'BlockdevCreateOptionsQcow', |
c2808aba | 5380 | 'qcow2': 'BlockdevCreateOptionsQcow2', |
959355a4 | 5381 | 'qed': 'BlockdevCreateOptionsQed', |
1bebea37 | 5382 | 'rbd': 'BlockdevCreateOptionsRbd', |
4906da7e | 5383 | 'ssh': 'BlockdevCreateOptionsSsh', |
e3810574 | 5384 | 'vdi': 'BlockdevCreateOptionsVdi', |
09b68dab | 5385 | 'vhdx': 'BlockdevCreateOptionsVhdx', |
3015372d | 5386 | 'vmdk': 'BlockdevCreateOptionsVmdk', |
29cd0403 | 5387 | 'vpc': 'BlockdevCreateOptionsVpc' |
53614689 KW |
5388 | } } |
5389 | ||
b0292b85 | 5390 | ## |
3fb588a0 | 5391 | # @blockdev-create: |
b0292b85 | 5392 | # |
a937b6aa | 5393 | # Starts a job to create an image format on a given node. The job is |
e5ab4347 | 5394 | # automatically finalized, but a manual job-dismiss is required. |
b0292b85 | 5395 | # |
c0ac533b | 5396 | # @job-id: Identifier for the newly created job. |
e5ab4347 | 5397 | # |
c0ac533b | 5398 | # @options: Options for the image creation. |
e5ab4347 KW |
5399 | # |
5400 | # Since: 3.0 | |
b0292b85 | 5401 | ## |
3fb588a0 | 5402 | { 'command': 'blockdev-create', |
e5ab4347 | 5403 | 'data': { 'job-id': 'str', |
f55ba801 PB |
5404 | 'options': 'BlockdevCreateOptions' }, |
5405 | 'allow-preconfig': true } | |
b0292b85 | 5406 | |
30da9dd8 ML |
5407 | ## |
5408 | # @BlockdevAmendOptionsLUKS: | |
5409 | # | |
5410 | # Driver specific image amend options for LUKS. | |
5411 | # | |
5412 | # Since: 5.1 | |
5413 | ## | |
5414 | { 'struct': 'BlockdevAmendOptionsLUKS', | |
5415 | 'base': 'QCryptoBlockAmendOptionsLUKS', | |
5416 | 'data': { } | |
5417 | } | |
5418 | ||
8ea1613d ML |
5419 | ## |
5420 | # @BlockdevAmendOptionsQcow2: | |
5421 | # | |
a937b6aa MA |
5422 | # Driver specific image amend options for qcow2. For now, only |
5423 | # encryption options can be amended | |
8ea1613d | 5424 | # |
91577c47 | 5425 | # @encrypt: Encryption options to be amended |
8ea1613d ML |
5426 | # |
5427 | # Since: 5.1 | |
5428 | ## | |
5429 | { 'struct': 'BlockdevAmendOptionsQcow2', | |
5430 | 'data': { '*encrypt': 'QCryptoBlockAmendOptions' } } | |
5431 | ||
ced914d0 ML |
5432 | ## |
5433 | # @BlockdevAmendOptions: | |
5434 | # | |
5435 | # Options for amending an image format | |
5436 | # | |
23e46452 | 5437 | # @driver: Block driver of the node to amend. |
ced914d0 ML |
5438 | # |
5439 | # Since: 5.1 | |
5440 | ## | |
5441 | { 'union': 'BlockdevAmendOptions', | |
5442 | 'base': { | |
5443 | 'driver': 'BlockdevDriver' }, | |
5444 | 'discriminator': 'driver', | |
5445 | 'data': { | |
8ea1613d ML |
5446 | 'luks': 'BlockdevAmendOptionsLUKS', |
5447 | 'qcow2': 'BlockdevAmendOptionsQcow2' } } | |
ced914d0 ML |
5448 | |
5449 | ## | |
5450 | # @x-blockdev-amend: | |
5451 | # | |
a937b6aa MA |
5452 | # Starts a job to amend format specific options of an existing open |
5453 | # block device The job is automatically finalized, but a manual | |
5454 | # job-dismiss is required. | |
ced914d0 | 5455 | # |
c0ac533b | 5456 | # @job-id: Identifier for the newly created job. |
ced914d0 | 5457 | # |
c0ac533b | 5458 | # @node-name: Name of the block node to work on |
ced914d0 | 5459 | # |
c0ac533b | 5460 | # @options: Options (driver specific) |
ced914d0 | 5461 | # |
a937b6aa MA |
5462 | # @force: Allow unsafe operations, format specific For luks that |
5463 | # allows erase of the last active keyslot (permanent loss of | |
5464 | # data), and replacement of an active keyslot (possible loss of | |
5465 | # data if IO error happens) | |
ced914d0 | 5466 | # |
9fb49daa | 5467 | # Features: |
a937b6aa | 5468 | # |
9fb49daa MA |
5469 | # @unstable: This command is experimental. |
5470 | # | |
ced914d0 ML |
5471 | # Since: 5.1 |
5472 | ## | |
5473 | { 'command': 'x-blockdev-amend', | |
5474 | 'data': { 'job-id': 'str', | |
5475 | 'node-name': 'str', | |
5476 | 'options': 'BlockdevAmendOptions', | |
9fb49daa | 5477 | '*force': 'bool' }, |
f55ba801 PB |
5478 | 'features': [ 'unstable' ], |
5479 | 'allow-preconfig': true } | |
ced914d0 | 5480 | |
a589569f | 5481 | ## |
5072f7b3 | 5482 | # @BlockErrorAction: |
a589569f WX |
5483 | # |
5484 | # An enumeration of action that has been taken when a DISK I/O occurs | |
5485 | # | |
5486 | # @ignore: error has been ignored | |
5487 | # | |
5488 | # @report: error has been reported to the device | |
5489 | # | |
5490 | # @stop: error caused VM to be stopped | |
5491 | # | |
5492 | # Since: 2.1 | |
5493 | ## | |
5494 | { 'enum': 'BlockErrorAction', | |
5495 | 'data': [ 'ignore', 'report', 'stop' ] } | |
5a2d2cbd | 5496 | |
c120f0fa | 5497 | ## |
5072f7b3 | 5498 | # @BLOCK_IMAGE_CORRUPTED: |
c120f0fa | 5499 | # |
a937b6aa MA |
5500 | # Emitted when a disk image is being marked corrupt. The image can be |
5501 | # identified by its device or node name. The 'device' field is always | |
370d4eba MAL |
5502 | # present for compatibility reasons, but it can be empty ("") if the |
5503 | # image does not have a device name associated. | |
c120f0fa | 5504 | # |
a937b6aa MA |
5505 | # @device: device name. This is always present for compatibility |
5506 | # reasons, but it can be empty ("") if the image does not have a | |
5507 | # device name associated. | |
dc881b44 | 5508 | # |
1d8bda12 | 5509 | # @node-name: node name (Since: 2.4) |
c120f0fa WX |
5510 | # |
5511 | # @msg: informative message for human consumption, such as the kind of | |
a937b6aa MA |
5512 | # corruption being detected. It should not be parsed by machine |
5513 | # as it is not guaranteed to be stable | |
c120f0fa | 5514 | # |
1d8bda12 | 5515 | # @offset: if the corruption resulted from an image access, this is |
a937b6aa | 5516 | # the host's access offset into the image |
c120f0fa | 5517 | # |
a937b6aa MA |
5518 | # @size: if the corruption resulted from an image access, this is the |
5519 | # access size | |
c120f0fa | 5520 | # |
a937b6aa MA |
5521 | # @fatal: if set, the image is marked corrupt and therefore unusable |
5522 | # after this event and must be repaired (Since 2.2; before, every | |
5523 | # BLOCK_IMAGE_CORRUPTED event was fatal) | |
9bf040b9 | 5524 | # |
07c9f583 | 5525 | # Note: If action is "stop", a STOP event will eventually follow the |
a937b6aa | 5526 | # BLOCK_IO_ERROR event. |
07c9f583 | 5527 | # |
370d4eba MAL |
5528 | # Example: |
5529 | # | |
5530 | # <- { "event": "BLOCK_IMAGE_CORRUPTED", | |
abbf0473 VT |
5531 | # "data": { "device": "", "node-name": "drive", "fatal": false, |
5532 | # "msg": "L2 table offset 0x2a2a2a00 unaligned (L1 index: 0)" }, | |
5533 | # "timestamp": { "seconds": 1648243240, "microseconds": 906060 } } | |
370d4eba | 5534 | # |
c120f0fa WX |
5535 | # Since: 1.7 |
5536 | ## | |
5537 | { 'event': 'BLOCK_IMAGE_CORRUPTED', | |
dc881b44 AG |
5538 | 'data': { 'device' : 'str', |
5539 | '*node-name' : 'str', | |
5540 | 'msg' : 'str', | |
5541 | '*offset' : 'int', | |
5542 | '*size' : 'int', | |
5543 | 'fatal' : 'bool' } } | |
c120f0fa | 5544 | |
5a2d2cbd | 5545 | ## |
5072f7b3 | 5546 | # @BLOCK_IO_ERROR: |
5a2d2cbd WX |
5547 | # |
5548 | # Emitted when a disk I/O error occurs | |
5549 | # | |
a937b6aa MA |
5550 | # @device: device name. This is always present for compatibility |
5551 | # reasons, but it can be empty ("") if the image does not have a | |
5552 | # device name associated. | |
2bf7e10f | 5553 | # |
a937b6aa MA |
5554 | # @node-name: node name. Note that errors may be reported for the |
5555 | # root node that is directly attached to a guest device rather | |
5556 | # than for the node where the error occurred. The node name is | |
5557 | # not present if the drive is empty. (Since: 2.8) | |
5a2d2cbd WX |
5558 | # |
5559 | # @operation: I/O operation | |
5560 | # | |
5561 | # @action: action that has been taken | |
5562 | # | |
a937b6aa MA |
5563 | # @nospace: true if I/O error was caused due to a no-space condition. |
5564 | # This key is only present if query-block's io-status is present, | |
5565 | # please see query-block documentation for more information | |
5566 | # (since: 2.2) | |
c7c2ff0c | 5567 | # |
a937b6aa MA |
5568 | # @reason: human readable string describing the error cause. (This |
5569 | # field is a debugging aid for humans, it should not be parsed by | |
5570 | # applications) (since: 2.2) | |
624ff573 | 5571 | # |
5a2d2cbd | 5572 | # Note: If action is "stop", a STOP event will eventually follow the |
a937b6aa | 5573 | # BLOCK_IO_ERROR event |
5a2d2cbd | 5574 | # |
9bc6e893 | 5575 | # Since: 0.13 |
07c9f583 MAL |
5576 | # |
5577 | # Example: | |
5578 | # | |
5579 | # <- { "event": "BLOCK_IO_ERROR", | |
5580 | # "data": { "device": "ide0-hd1", | |
5581 | # "node-name": "#block212", | |
5582 | # "operation": "write", | |
39e8bb22 VT |
5583 | # "action": "stop", |
5584 | # "reason": "No space left on device" }, | |
07c9f583 | 5585 | # "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } |
5a2d2cbd WX |
5586 | ## |
5587 | { 'event': 'BLOCK_IO_ERROR', | |
bfe1a14c KW |
5588 | 'data': { 'device': 'str', '*node-name': 'str', |
5589 | 'operation': 'IoOperationType', | |
624ff573 LC |
5590 | 'action': 'BlockErrorAction', '*nospace': 'bool', |
5591 | 'reason': 'str' } } | |
5a2d2cbd | 5592 | |
bcada37b | 5593 | ## |
5072f7b3 | 5594 | # @BLOCK_JOB_COMPLETED: |
bcada37b WX |
5595 | # |
5596 | # Emitted when a block job has completed | |
5597 | # | |
5598 | # @type: job type | |
5599 | # | |
a937b6aa MA |
5600 | # @device: The job identifier. Originally the device name but other |
5601 | # values are allowed since QEMU 2.7 | |
bcada37b WX |
5602 | # |
5603 | # @len: maximum progress value | |
5604 | # | |
a937b6aa MA |
5605 | # @offset: current progress value. On success this is equal to len. |
5606 | # On failure this is less than len | |
bcada37b WX |
5607 | # |
5608 | # @speed: rate limit, bytes per second | |
5609 | # | |
a937b6aa MA |
5610 | # @error: error message. Only present on failure. This field |
5611 | # contains a human-readable error message. There are no semantics | |
5612 | # other than that streaming has failed and clients should not try | |
5613 | # to interpret the error string | |
bcada37b WX |
5614 | # |
5615 | # Since: 1.1 | |
e21e65b2 MAL |
5616 | # |
5617 | # Example: | |
5618 | # | |
5619 | # <- { "event": "BLOCK_JOB_COMPLETED", | |
5620 | # "data": { "type": "stream", "device": "virtio-disk0", | |
5621 | # "len": 10737418240, "offset": 10737418240, | |
5622 | # "speed": 0 }, | |
5623 | # "timestamp": { "seconds": 1267061043, "microseconds": 959568 } } | |
bcada37b WX |
5624 | ## |
5625 | { 'event': 'BLOCK_JOB_COMPLETED', | |
8e4c8700 | 5626 | 'data': { 'type' : 'JobType', |
bcada37b WX |
5627 | 'device': 'str', |
5628 | 'len' : 'int', | |
5629 | 'offset': 'int', | |
5630 | 'speed' : 'int', | |
5631 | '*error': 'str' } } | |
5632 | ||
5633 | ## | |
5072f7b3 | 5634 | # @BLOCK_JOB_CANCELLED: |
bcada37b WX |
5635 | # |
5636 | # Emitted when a block job has been cancelled | |
5637 | # | |
5638 | # @type: job type | |
5639 | # | |
a937b6aa MA |
5640 | # @device: The job identifier. Originally the device name but other |
5641 | # values are allowed since QEMU 2.7 | |
bcada37b WX |
5642 | # |
5643 | # @len: maximum progress value | |
5644 | # | |
a937b6aa MA |
5645 | # @offset: current progress value. On success this is equal to len. |
5646 | # On failure this is less than len | |
bcada37b WX |
5647 | # |
5648 | # @speed: rate limit, bytes per second | |
5649 | # | |
5650 | # Since: 1.1 | |
e161df39 MAL |
5651 | # |
5652 | # Example: | |
5653 | # | |
5654 | # <- { "event": "BLOCK_JOB_CANCELLED", | |
5655 | # "data": { "type": "stream", "device": "virtio-disk0", | |
5656 | # "len": 10737418240, "offset": 134217728, | |
5657 | # "speed": 0 }, | |
5658 | # "timestamp": { "seconds": 1267061043, "microseconds": 959568 } } | |
bcada37b WX |
5659 | ## |
5660 | { 'event': 'BLOCK_JOB_CANCELLED', | |
8e4c8700 | 5661 | 'data': { 'type' : 'JobType', |
bcada37b WX |
5662 | 'device': 'str', |
5663 | 'len' : 'int', | |
5664 | 'offset': 'int', | |
5665 | 'speed' : 'int' } } | |
5666 | ||
5a2d2cbd | 5667 | ## |
5072f7b3 | 5668 | # @BLOCK_JOB_ERROR: |
5a2d2cbd WX |
5669 | # |
5670 | # Emitted when a block job encounters an error | |
5671 | # | |
a937b6aa MA |
5672 | # @device: The job identifier. Originally the device name but other |
5673 | # values are allowed since QEMU 2.7 | |
5a2d2cbd WX |
5674 | # |
5675 | # @operation: I/O operation | |
5676 | # | |
5677 | # @action: action that has been taken | |
5678 | # | |
5679 | # Since: 1.3 | |
af0e0910 MAL |
5680 | # |
5681 | # Example: | |
5682 | # | |
5683 | # <- { "event": "BLOCK_JOB_ERROR", | |
5684 | # "data": { "device": "ide0-hd1", | |
5685 | # "operation": "write", | |
5686 | # "action": "stop" }, | |
5687 | # "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } | |
5a2d2cbd WX |
5688 | ## |
5689 | { 'event': 'BLOCK_JOB_ERROR', | |
5690 | 'data': { 'device' : 'str', | |
5691 | 'operation': 'IoOperationType', | |
823c6863 | 5692 | 'action' : 'BlockErrorAction' } } |
bcada37b WX |
5693 | |
5694 | ## | |
5072f7b3 | 5695 | # @BLOCK_JOB_READY: |
bcada37b WX |
5696 | # |
5697 | # Emitted when a block job is ready to complete | |
5698 | # | |
518848a2 MA |
5699 | # @type: job type |
5700 | # | |
a937b6aa MA |
5701 | # @device: The job identifier. Originally the device name but other |
5702 | # values are allowed since QEMU 2.7 | |
bcada37b | 5703 | # |
518848a2 MA |
5704 | # @len: maximum progress value |
5705 | # | |
a937b6aa MA |
5706 | # @offset: current progress value. On success this is equal to len. |
5707 | # On failure this is less than len | |
518848a2 MA |
5708 | # |
5709 | # @speed: rate limit, bytes per second | |
5710 | # | |
a937b6aa MA |
5711 | # Note: The "ready to complete" status is always reset by a |
5712 | # @BLOCK_JOB_ERROR event | |
bcada37b WX |
5713 | # |
5714 | # Since: 1.3 | |
11a3dee1 MAL |
5715 | # |
5716 | # Example: | |
5717 | # | |
5718 | # <- { "event": "BLOCK_JOB_READY", | |
5719 | # "data": { "device": "drive0", "type": "mirror", "speed": 0, | |
ccc9ddbc | 5720 | # "len": 2097152, "offset": 2097152 }, |
11a3dee1 | 5721 | # "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } |
bcada37b WX |
5722 | ## |
5723 | { 'event': 'BLOCK_JOB_READY', | |
8e4c8700 | 5724 | 'data': { 'type' : 'JobType', |
518848a2 MA |
5725 | 'device': 'str', |
5726 | 'len' : 'int', | |
5727 | 'offset': 'int', | |
5728 | 'speed' : 'int' } } | |
ffeaac9b | 5729 | |
5f241594 JS |
5730 | ## |
5731 | # @BLOCK_JOB_PENDING: | |
5732 | # | |
a937b6aa MA |
5733 | # Emitted when a block job is awaiting explicit authorization to |
5734 | # finalize graph changes via @block-job-finalize. If this job is part | |
5735 | # of a transaction, it will not emit this event until the transaction | |
5736 | # has converged first. | |
5f241594 JS |
5737 | # |
5738 | # @type: job type | |
5739 | # | |
5740 | # @id: The job identifier. | |
5741 | # | |
5742 | # Since: 2.12 | |
5743 | # | |
5744 | # Example: | |
5745 | # | |
2c29d9b0 VT |
5746 | # <- { "event": "BLOCK_JOB_PENDING", |
5747 | # "data": { "type": "mirror", "id": "backup_1" }, | |
5f241594 | 5748 | # "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } |
5f241594 JS |
5749 | ## |
5750 | { 'event': 'BLOCK_JOB_PENDING', | |
8e4c8700 | 5751 | 'data': { 'type' : 'JobType', |
5f241594 JS |
5752 | 'id' : 'str' } } |
5753 | ||
49687ace | 5754 | ## |
5072f7b3 | 5755 | # @PreallocMode: |
ffeaac9b HT |
5756 | # |
5757 | # Preallocation mode of QEMU image file | |
5758 | # | |
5759 | # @off: no preallocation | |
a937b6aa | 5760 | # |
ffeaac9b | 5761 | # @metadata: preallocate only for metadata |
a937b6aa | 5762 | # |
ffeaac9b | 5763 | # @falloc: like @full preallocation but allocate disk space by |
a937b6aa MA |
5764 | # posix_fallocate() rather than writing data. |
5765 | # | |
fa27c478 | 5766 | # @full: preallocate all data by writing it to the device to ensure |
a937b6aa MA |
5767 | # disk space is really available. This data may or may not be |
5768 | # zero, depending on the image format and storage. @full | |
5769 | # preallocation also sets up metadata correctly. | |
ffeaac9b | 5770 | # |
5072f7b3 | 5771 | # Since: 2.2 |
ffeaac9b HT |
5772 | ## |
5773 | { 'enum': 'PreallocMode', | |
5774 | 'data': [ 'off', 'metadata', 'falloc', 'full' ] } | |
e2462113 FR |
5775 | |
5776 | ## | |
5072f7b3 | 5777 | # @BLOCK_WRITE_THRESHOLD: |
e2462113 FR |
5778 | # |
5779 | # Emitted when writes on block device reaches or exceeds the | |
a937b6aa MA |
5780 | # configured write threshold. For thin-provisioned devices, this |
5781 | # means the device should be extended to avoid pausing for disk | |
5782 | # exhaustion. The event is one shot. Once triggered, it needs to be | |
f85d66f4 | 5783 | # re-registered with another block-set-write-threshold command. |
e2462113 FR |
5784 | # |
5785 | # @node-name: graph node name on which the threshold was exceeded. | |
5786 | # | |
a937b6aa MA |
5787 | # @amount-exceeded: amount of data which exceeded the threshold, in |
5788 | # bytes. | |
e2462113 FR |
5789 | # |
5790 | # @write-threshold: last configured threshold, in bytes. | |
5791 | # | |
5792 | # Since: 2.3 | |
5793 | ## | |
5794 | { 'event': 'BLOCK_WRITE_THRESHOLD', | |
5795 | 'data': { 'node-name': 'str', | |
5796 | 'amount-exceeded': 'uint64', | |
5797 | 'write-threshold': 'uint64' } } | |
5798 | ||
5799 | ## | |
5072f7b3 | 5800 | # @block-set-write-threshold: |
e2462113 | 5801 | # |
a937b6aa | 5802 | # Change the write threshold for a block drive. An event will be |
e817862b | 5803 | # delivered if a write to this block drive crosses the configured |
a937b6aa MA |
5804 | # threshold. The threshold is an offset, thus must be non-negative. |
5805 | # Default is no write threshold. Setting the threshold to zero | |
5806 | # disables it. | |
e817862b | 5807 | # |
a937b6aa MA |
5808 | # This is useful to transparently resize thin-provisioned drives |
5809 | # without the guest OS noticing. | |
e2462113 FR |
5810 | # |
5811 | # @node-name: graph node name on which the threshold must be set. | |
5812 | # | |
5813 | # @write-threshold: configured threshold for the block device, bytes. | |
a937b6aa | 5814 | # Use 0 to disable the threshold. |
e2462113 | 5815 | # |
e2462113 | 5816 | # Since: 2.3 |
e817862b MAL |
5817 | # |
5818 | # Example: | |
5819 | # | |
5820 | # -> { "execute": "block-set-write-threshold", | |
5821 | # "arguments": { "node-name": "mydev", | |
5822 | # "write-threshold": 17179869184 } } | |
5823 | # <- { "return": {} } | |
e2462113 FR |
5824 | ## |
5825 | { 'command': 'block-set-write-threshold', | |
f55ba801 PB |
5826 | 'data': { 'node-name': 'str', 'write-threshold': 'uint64' }, |
5827 | 'allow-preconfig': true } | |
7f821597 WC |
5828 | |
5829 | ## | |
5072f7b3 | 5830 | # @x-blockdev-change: |
7f821597 | 5831 | # |
a937b6aa MA |
5832 | # Dynamically reconfigure the block driver state graph. It can be |
5833 | # used to add, remove, insert or replace a graph node. Currently only | |
5834 | # the Quorum driver implements this feature to add or remove its | |
5835 | # child. This is useful to fix a broken quorum child. | |
7f821597 | 5836 | # |
a937b6aa MA |
5837 | # If @node is specified, it will be inserted under @parent. @child |
5838 | # may not be specified in this case. If both @parent and @child are | |
7f821597 WC |
5839 | # specified but @node is not, @child will be detached from @parent. |
5840 | # | |
5841 | # @parent: the id or name of the parent node. | |
5842 | # | |
1d8bda12 | 5843 | # @child: the name of a child under the given parent node. |
7f821597 | 5844 | # |
1d8bda12 | 5845 | # @node: the name of the node that will be added. |
7f821597 | 5846 | # |
9fb49daa | 5847 | # Features: |
7f821597 | 5848 | # |
a937b6aa MA |
5849 | # @unstable: This command is experimental, and its API is not stable. |
5850 | # It does not support all kinds of operations, all kinds of | |
5851 | # children, nor all block drivers. | |
5852 | # | |
5853 | # FIXME Removing children from a quorum node means introducing | |
5854 | # gaps in the child indices. This cannot be represented in the | |
5855 | # 'children' list of BlockdevOptionsQuorum, as returned by | |
5856 | # .bdrv_refresh_filename(). | |
6b4738ce | 5857 | # |
a937b6aa MA |
5858 | # Warning: The data in a new quorum child MUST be consistent with |
5859 | # that of the rest of the array. | |
7f821597 WC |
5860 | # |
5861 | # Since: 2.7 | |
bd77ea2e | 5862 | # |
37fa48a4 | 5863 | # Examples: |
bd77ea2e MAL |
5864 | # |
5865 | # 1. Add a new node to a quorum | |
a937b6aa | 5866 | # |
bd77ea2e MAL |
5867 | # -> { "execute": "blockdev-add", |
5868 | # "arguments": { | |
244d04db EB |
5869 | # "driver": "raw", |
5870 | # "node-name": "new_node", | |
5871 | # "file": { "driver": "file", | |
5872 | # "filename": "test.raw" } } } | |
bd77ea2e MAL |
5873 | # <- { "return": {} } |
5874 | # -> { "execute": "x-blockdev-change", | |
5875 | # "arguments": { "parent": "disk1", | |
5876 | # "node": "new_node" } } | |
5877 | # <- { "return": {} } | |
5878 | # | |
5879 | # 2. Delete a quorum's node | |
a937b6aa | 5880 | # |
bd77ea2e MAL |
5881 | # -> { "execute": "x-blockdev-change", |
5882 | # "arguments": { "parent": "disk1", | |
5883 | # "child": "children.1" } } | |
5884 | # <- { "return": {} } | |
7f821597 WC |
5885 | ## |
5886 | { 'command': 'x-blockdev-change', | |
5887 | 'data' : { 'parent': 'str', | |
5888 | '*child': 'str', | |
9fb49daa | 5889 | '*node': 'str' }, |
f55ba801 PB |
5890 | 'features': [ 'unstable' ], |
5891 | 'allow-preconfig': true } | |
ca00bbb1 SH |
5892 | |
5893 | ## | |
5894 | # @x-blockdev-set-iothread: | |
5895 | # | |
a937b6aa MA |
5896 | # Move @node and its children into the @iothread. If @iothread is |
5897 | # null then move @node and its children into the main loop. | |
ca00bbb1 SH |
5898 | # |
5899 | # The node must not be attached to a BlockBackend. | |
5900 | # | |
5901 | # @node-name: the name of the block driver node | |
5902 | # | |
5903 | # @iothread: the name of the IOThread object or null for the main loop | |
5904 | # | |
a937b6aa MA |
5905 | # @force: true if the node and its children should be moved when a |
5906 | # BlockBackend is already attached | |
882e9b89 | 5907 | # |
9fb49daa | 5908 | # Features: |
a937b6aa MA |
5909 | # |
5910 | # @unstable: This command is experimental and intended for test cases | |
5911 | # that need control over IOThreads only. | |
ca00bbb1 SH |
5912 | # |
5913 | # Since: 2.12 | |
5914 | # | |
37fa48a4 | 5915 | # Examples: |
ca00bbb1 SH |
5916 | # |
5917 | # 1. Move a node into an IOThread | |
a937b6aa | 5918 | # |
ca00bbb1 SH |
5919 | # -> { "execute": "x-blockdev-set-iothread", |
5920 | # "arguments": { "node-name": "disk1", | |
5921 | # "iothread": "iothread0" } } | |
5922 | # <- { "return": {} } | |
5923 | # | |
5924 | # 2. Move a node into the main loop | |
a937b6aa | 5925 | # |
ca00bbb1 SH |
5926 | # -> { "execute": "x-blockdev-set-iothread", |
5927 | # "arguments": { "node-name": "disk1", | |
5928 | # "iothread": null } } | |
5929 | # <- { "return": {} } | |
ca00bbb1 SH |
5930 | ## |
5931 | { 'command': 'x-blockdev-set-iothread', | |
5932 | 'data' : { 'node-name': 'str', | |
882e9b89 | 5933 | 'iothread': 'StrOrNull', |
9fb49daa | 5934 | '*force': 'bool' }, |
f55ba801 PB |
5935 | 'features': [ 'unstable' ], |
5936 | 'allow-preconfig': true } | |
b3cf1ec0 | 5937 | |
b3cf1ec0 KW |
5938 | ## |
5939 | # @QuorumOpType: | |
5940 | # | |
5941 | # An enumeration of the quorum operation types | |
5942 | # | |
5943 | # @read: read operation | |
5944 | # | |
5945 | # @write: write operation | |
5946 | # | |
5947 | # @flush: flush operation | |
5948 | # | |
5949 | # Since: 2.6 | |
5950 | ## | |
5951 | { 'enum': 'QuorumOpType', | |
5952 | 'data': [ 'read', 'write', 'flush' ] } | |
5953 | ||
5954 | ## | |
5955 | # @QUORUM_FAILURE: | |
5956 | # | |
5957 | # Emitted by the Quorum block driver if it fails to establish a quorum | |
5958 | # | |
5959 | # @reference: device name if defined else node name | |
5960 | # | |
5961 | # @sector-num: number of the first sector of the failed read operation | |
5962 | # | |
5963 | # @sectors-count: failed read operation sector count | |
5964 | # | |
5965 | # Note: This event is rate-limited. | |
5966 | # | |
5967 | # Since: 2.0 | |
5968 | # | |
5969 | # Example: | |
5970 | # | |
5971 | # <- { "event": "QUORUM_FAILURE", | |
5972 | # "data": { "reference": "usr1", "sector-num": 345435, "sectors-count": 5 }, | |
5973 | # "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } | |
b3cf1ec0 KW |
5974 | ## |
5975 | { 'event': 'QUORUM_FAILURE', | |
5976 | 'data': { 'reference': 'str', 'sector-num': 'int', 'sectors-count': 'int' } } | |
5977 | ||
5978 | ## | |
5979 | # @QUORUM_REPORT_BAD: | |
5980 | # | |
5981 | # Emitted to report a corruption of a Quorum file | |
5982 | # | |
5983 | # @type: quorum operation type (Since 2.6) | |
5984 | # | |
a937b6aa MA |
5985 | # @error: error message. Only present on failure. This field |
5986 | # contains a human-readable error message. There are no semantics | |
5987 | # other than that the block layer reported an error and clients | |
5988 | # should not try to interpret the error string. | |
b3cf1ec0 KW |
5989 | # |
5990 | # @node-name: the graph node name of the block driver state | |
5991 | # | |
5992 | # @sector-num: number of the first sector of the failed read operation | |
5993 | # | |
5994 | # @sectors-count: failed read operation sector count | |
5995 | # | |
5996 | # Note: This event is rate-limited. | |
5997 | # | |
5998 | # Since: 2.0 | |
5999 | # | |
37fa48a4 | 6000 | # Examples: |
b3cf1ec0 KW |
6001 | # |
6002 | # 1. Read operation | |
6003 | # | |
37fa48a4 | 6004 | # <- { "event": "QUORUM_REPORT_BAD", |
b3cf1ec0 KW |
6005 | # "data": { "node-name": "node0", "sector-num": 345435, "sectors-count": 5, |
6006 | # "type": "read" }, | |
6007 | # "timestamp": { "seconds": 1344522075, "microseconds": 745528 } } | |
6008 | # | |
6009 | # 2. Flush operation | |
6010 | # | |
37fa48a4 | 6011 | # <- { "event": "QUORUM_REPORT_BAD", |
b3cf1ec0 KW |
6012 | # "data": { "node-name": "node0", "sector-num": 0, "sectors-count": 2097120, |
6013 | # "type": "flush", "error": "Broken pipe" }, | |
6014 | # "timestamp": { "seconds": 1456406829, "microseconds": 291763 } } | |
b3cf1ec0 KW |
6015 | ## |
6016 | { 'event': 'QUORUM_REPORT_BAD', | |
6017 | 'data': { 'type': 'QuorumOpType', '*error': 'str', 'node-name': 'str', | |
6018 | 'sector-num': 'int', 'sectors-count': 'int' } } | |
6019 | ||
6020 | ## | |
6021 | # @BlockdevSnapshotInternal: | |
6022 | # | |
a937b6aa MA |
6023 | # @device: the device name or node-name of a root node to generate the |
6024 | # snapshot from | |
b3cf1ec0 KW |
6025 | # |
6026 | # @name: the name of the internal snapshot to be created | |
6027 | # | |
a937b6aa MA |
6028 | # Notes: In transaction, if @name is empty, or any snapshot matching |
6029 | # @name exists, the operation will fail. Only some image formats | |
6030 | # support it, for example, qcow2, and rbd. | |
b3cf1ec0 KW |
6031 | # |
6032 | # Since: 1.7 | |
6033 | ## | |
6034 | { 'struct': 'BlockdevSnapshotInternal', | |
6035 | 'data': { 'device': 'str', 'name': 'str' } } | |
6036 | ||
6037 | ## | |
6038 | # @blockdev-snapshot-internal-sync: | |
6039 | # | |
6040 | # Synchronously take an internal snapshot of a block device, when the | |
a937b6aa | 6041 | # format of the image used supports it. If the name is an empty |
b3cf1ec0 KW |
6042 | # string, or a snapshot with name already exists, the operation will |
6043 | # fail. | |
6044 | # | |
a937b6aa MA |
6045 | # For the arguments, see the documentation of |
6046 | # BlockdevSnapshotInternal. | |
b3cf1ec0 | 6047 | # |
a937b6aa MA |
6048 | # Returns: |
6049 | # - nothing on success | |
6050 | # - If @device is not a valid block device, GenericError | |
6051 | # - If any snapshot matching @name exists, or @name is empty, | |
6052 | # GenericError | |
6053 | # - If the format of the image used does not support it, | |
6054 | # GenericError | |
b3cf1ec0 KW |
6055 | # |
6056 | # Since: 1.7 | |
6057 | # | |
6058 | # Example: | |
6059 | # | |
6060 | # -> { "execute": "blockdev-snapshot-internal-sync", | |
6061 | # "arguments": { "device": "ide-hd0", | |
6062 | # "name": "snapshot0" } | |
6063 | # } | |
6064 | # <- { "return": {} } | |
b3cf1ec0 KW |
6065 | ## |
6066 | { 'command': 'blockdev-snapshot-internal-sync', | |
f55ba801 PB |
6067 | 'data': 'BlockdevSnapshotInternal', |
6068 | 'allow-preconfig': true } | |
b3cf1ec0 KW |
6069 | |
6070 | ## | |
6071 | # @blockdev-snapshot-delete-internal-sync: | |
6072 | # | |
a937b6aa MA |
6073 | # Synchronously delete an internal snapshot of a block device, when |
6074 | # the format of the image used support it. The snapshot is identified | |
6075 | # by name or id or both. One of the name or id is required. Return | |
6076 | # SnapshotInfo for the successfully deleted snapshot. | |
b3cf1ec0 | 6077 | # |
a937b6aa MA |
6078 | # @device: the device name or node-name of a root node to delete the |
6079 | # snapshot from | |
b3cf1ec0 KW |
6080 | # |
6081 | # @id: optional the snapshot's ID to be deleted | |
6082 | # | |
6083 | # @name: optional the snapshot's name to be deleted | |
6084 | # | |
a937b6aa MA |
6085 | # Returns: |
6086 | # - SnapshotInfo on success | |
6087 | # - If @device is not a valid block device, GenericError | |
6088 | # - If snapshot not found, GenericError | |
6089 | # - If the format of the image used does not support it, | |
6090 | # GenericError | |
6091 | # - If @id and @name are both not specified, GenericError | |
b3cf1ec0 KW |
6092 | # |
6093 | # Since: 1.7 | |
6094 | # | |
6095 | # Example: | |
6096 | # | |
6097 | # -> { "execute": "blockdev-snapshot-delete-internal-sync", | |
6098 | # "arguments": { "device": "ide-hd0", | |
6099 | # "name": "snapshot0" } | |
6100 | # } | |
6101 | # <- { "return": { | |
6102 | # "id": "1", | |
6103 | # "name": "snapshot0", | |
6104 | # "vm-state-size": 0, | |
6105 | # "date-sec": 1000012, | |
6106 | # "date-nsec": 10, | |
6107 | # "vm-clock-sec": 100, | |
b39847a5 PD |
6108 | # "vm-clock-nsec": 20, |
6109 | # "icount": 220414 | |
b3cf1ec0 KW |
6110 | # } |
6111 | # } | |
b3cf1ec0 KW |
6112 | ## |
6113 | { 'command': 'blockdev-snapshot-delete-internal-sync', | |
6114 | 'data': { 'device': 'str', '*id': 'str', '*name': 'str'}, | |
f55ba801 PB |
6115 | 'returns': 'SnapshotInfo', |
6116 | 'allow-preconfig': true } | |
456e7517 HR |
6117 | |
6118 | ## | |
6119 | # @DummyBlockCoreForceArrays: | |
6120 | # | |
c04d0ab0 | 6121 | # Not used by QMP; hack to let us use BlockGraphInfoList internally |
456e7517 HR |
6122 | # |
6123 | # Since: 8.0 | |
6124 | ## | |
6125 | { 'struct': 'DummyBlockCoreForceArrays', | |
c04d0ab0 | 6126 | 'data': { 'unused-block-graph-info': ['BlockGraphInfo'] } } |