Merge remote-tracking branch 'remotes/amarkovic/tags/mips-queue-dec-16-2019' into...
[qemu/ar7.git] / qapi / block.json
blob145c268bb64639a139d215dac2fd2fbe36e43a27
1 # -*- Mode: Python -*-
3 ##
4 # = Block devices
5 ##
7 { 'include': 'block-core.json' }
9 ##
10 # == Additional block stuff (VM related)
14 # @BiosAtaTranslation:
16 # Policy that BIOS should use to interpret cylinder/head/sector
17 # addresses.  Note that Bochs BIOS and SeaBIOS will not actually
18 # translate logical CHS to physical; instead, they will use logical
19 # block addressing.
21 # @auto: If cylinder/heads/sizes are passed, choose between none and LBA
22 #        depending on the size of the disk.  If they are not passed,
23 #        choose none if QEMU can guess that the disk had 16 or fewer
24 #        heads, large if QEMU can guess that the disk had 131072 or
25 #        fewer tracks across all heads (i.e. cylinders*heads<131072),
26 #        otherwise LBA.
28 # @none: The physical disk geometry is equal to the logical geometry.
30 # @lba: Assume 63 sectors per track and one of 16, 32, 64, 128 or 255
31 #       heads (if fewer than 255 are enough to cover the whole disk
32 #       with 1024 cylinders/head).  The number of cylinders/head is
33 #       then computed based on the number of sectors and heads.
35 # @large: The number of cylinders per head is scaled down to 1024
36 #         by correspondingly scaling up the number of heads.
38 # @rechs: Same as @large, but first convert a 16-head geometry to
39 #         15-head, by proportionally scaling up the number of
40 #         cylinders/head.
42 # Since: 2.0
44 { 'enum': 'BiosAtaTranslation',
45   'data': ['auto', 'none', 'lba', 'large', 'rechs']}
48 # @FloppyDriveType:
50 # Type of Floppy drive to be emulated by the Floppy Disk Controller.
52 # @144:  1.44MB 3.5" drive
53 # @288:  2.88MB 3.5" drive
54 # @120:  1.2MB 5.25" drive
55 # @none: No drive connected
56 # @auto: Automatically determined by inserted media at boot
58 # Since: 2.6
60 { 'enum': 'FloppyDriveType',
61   'data': ['144', '288', '120', 'none', 'auto']}
64 # @BlockdevSnapshotInternal:
66 # @device: the device name or node-name of a root node to generate the snapshot
67 #          from
69 # @name: the name of the internal snapshot to be created
71 # Notes: In transaction, if @name is empty, or any snapshot matching @name
72 #        exists, the operation will fail. Only some image formats support it,
73 #        for example, qcow2, rbd, and sheepdog.
75 # Since: 1.7
77 { 'struct': 'BlockdevSnapshotInternal',
78   'data': { 'device': 'str', 'name': 'str' } }
81 # @PRManagerInfo:
83 # Information about a persistent reservation manager
85 # @id: the identifier of the persistent reservation manager
87 # @connected: true if the persistent reservation manager is connected to
88 #             the underlying storage or helper
90 # Since: 3.0
92 { 'struct': 'PRManagerInfo',
93   'data': {'id': 'str', 'connected': 'bool'} }
96 # @query-pr-managers:
98 # Returns a list of information about each persistent reservation manager.
100 # Returns: a list of @PRManagerInfo for each persistent reservation manager
102 # Since: 3.0
104 { 'command': 'query-pr-managers', 'returns': ['PRManagerInfo'],
105   'allow-preconfig': true }
109 # @blockdev-snapshot-internal-sync:
111 # Synchronously take an internal snapshot of a block device, when the
112 # format of the image used supports it. If the name is an empty
113 # string, or a snapshot with name already exists, the operation will
114 # fail.
116 # For the arguments, see the documentation of BlockdevSnapshotInternal.
118 # Returns: nothing on success
120 #          If @device is not a valid block device, GenericError
122 #          If any snapshot matching @name exists, or @name is empty,
123 #          GenericError
125 #          If the format of the image used does not support it,
126 #          BlockFormatFeatureNotSupported
128 # Since: 1.7
130 # Example:
132 # -> { "execute": "blockdev-snapshot-internal-sync",
133 #      "arguments": { "device": "ide-hd0",
134 #                     "name": "snapshot0" }
135 #    }
136 # <- { "return": {} }
139 { 'command': 'blockdev-snapshot-internal-sync',
140   'data': 'BlockdevSnapshotInternal' }
143 # @blockdev-snapshot-delete-internal-sync:
145 # Synchronously delete an internal snapshot of a block device, when the format
146 # of the image used support it. The snapshot is identified by name or id or
147 # both. One of the name or id is required. Return SnapshotInfo for the
148 # successfully deleted snapshot.
150 # @device: the device name or node-name of a root node to delete the snapshot
151 #          from
153 # @id: optional the snapshot's ID to be deleted
155 # @name: optional the snapshot's name to be deleted
157 # Returns: SnapshotInfo on success
158 #          If @device is not a valid block device, GenericError
159 #          If snapshot not found, GenericError
160 #          If the format of the image used does not support it,
161 #          BlockFormatFeatureNotSupported
162 #          If @id and @name are both not specified, GenericError
164 # Since: 1.7
166 # Example:
168 # -> { "execute": "blockdev-snapshot-delete-internal-sync",
169 #      "arguments": { "device": "ide-hd0",
170 #                     "name": "snapshot0" }
171 #    }
172 # <- { "return": {
173 #                    "id": "1",
174 #                    "name": "snapshot0",
175 #                    "vm-state-size": 0,
176 #                    "date-sec": 1000012,
177 #                    "date-nsec": 10,
178 #                    "vm-clock-sec": 100,
179 #                    "vm-clock-nsec": 20
180 #      }
181 #    }
184 { 'command': 'blockdev-snapshot-delete-internal-sync',
185   'data': { 'device': 'str', '*id': 'str', '*name': 'str'},
186   'returns': 'SnapshotInfo' }
189 # @eject:
191 # Ejects a device from a removable drive.
193 # @device:  Block device name (deprecated, use @id instead)
195 # @id:      The name or QOM path of the guest device (since: 2.8)
197 # @force:   If true, eject regardless of whether the drive is locked.
198 #           If not specified, the default value is false.
200 # Returns:  Nothing on success
202 #           If @device is not a valid block device, DeviceNotFound
204 # Notes:    Ejecting a device with no media results in success
206 # Since: 0.14.0
208 # Example:
210 # -> { "execute": "eject", "arguments": { "id": "ide1-0-1" } }
211 # <- { "return": {} }
213 { 'command': 'eject',
214   'data': { '*device': 'str',
215             '*id': 'str',
216             '*force': 'bool' } }
219 # @nbd-server-start:
221 # Start an NBD server listening on the given host and port.  Block
222 # devices can then be exported using @nbd-server-add.  The NBD
223 # server will present them as named exports; for example, another
224 # QEMU instance could refer to them as "nbd:HOST:PORT:exportname=NAME".
226 # @addr: Address on which to listen.
227 # @tls-creds: ID of the TLS credentials object (since 2.6).
228 # @tls-authz: ID of the QAuthZ authorization object used to validate
229 #             the client's x509 distinguished name. This object is
230 #             is only resolved at time of use, so can be deleted and
231 #             recreated on the fly while the NBD server is active.
232 #             If missing, it will default to denying access (since 4.0).
234 # Returns: error if the server is already running.
236 # Since: 1.3.0
238 { 'command': 'nbd-server-start',
239   'data': { 'addr': 'SocketAddressLegacy',
240             '*tls-creds': 'str',
241             '*tls-authz': 'str'} }
244 # @nbd-server-add:
246 # Export a block node to QEMU's embedded NBD server.
248 # @device: The device name or node name of the node to be exported
250 # @name: Export name. If unspecified, the @device parameter is used as the
251 #        export name. (Since 2.12)
253 # @writable: Whether clients should be able to write to the device via the
254 #     NBD connection (default false).
256 # @bitmap: Also export the dirty bitmap reachable from @device, so the
257 #          NBD client can use NBD_OPT_SET_META_CONTEXT with
258 #          "qemu:dirty-bitmap:NAME" to inspect the bitmap. (since 4.0)
260 # Returns: error if the server is not running, or export with the same name
261 #          already exists.
263 # Since: 1.3.0
265 { 'command': 'nbd-server-add',
266   'data': {'device': 'str', '*name': 'str', '*writable': 'bool',
267            '*bitmap': 'str' } }
270 # @NbdServerRemoveMode:
272 # Mode for removing an NBD export.
274 # @safe: Remove export if there are no existing connections, fail otherwise.
276 # @hard: Drop all connections immediately and remove export.
278 # Potential additional modes to be added in the future:
280 # hide: Just hide export from new clients, leave existing connections as is.
281 #       Remove export after all clients are disconnected.
283 # soft: Hide export from new clients, answer with ESHUTDOWN for all further
284 #       requests from existing clients.
286 # Since: 2.12
288 {'enum': 'NbdServerRemoveMode', 'data': ['safe', 'hard']}
291 # @nbd-server-remove:
293 # Remove NBD export by name.
295 # @name: Export name.
297 # @mode: Mode of command operation. See @NbdServerRemoveMode description.
298 #        Default is 'safe'.
300 # Returns: error if
301 #            - the server is not running
302 #            - export is not found
303 #            - mode is 'safe' and there are existing connections
305 # Since: 2.12
307 { 'command': 'nbd-server-remove',
308   'data': {'name': 'str', '*mode': 'NbdServerRemoveMode'} }
311 # @nbd-server-stop:
313 # Stop QEMU's embedded NBD server, and unregister all devices previously
314 # added via @nbd-server-add.
316 # Since: 1.3.0
318 { 'command': 'nbd-server-stop' }
321 # @DEVICE_TRAY_MOVED:
323 # Emitted whenever the tray of a removable device is moved by the guest or by
324 # HMP/QMP commands
326 # @device: Block device name. This is always present for compatibility
327 #          reasons, but it can be empty ("") if the image does not
328 #          have a device name associated.
330 # @id: The name or QOM path of the guest device (since 2.8)
332 # @tray-open: true if the tray has been opened or false if it has been closed
334 # Since: 1.1
336 # Example:
338 # <- { "event": "DEVICE_TRAY_MOVED",
339 #      "data": { "device": "ide1-cd0",
340 #                "id": "/machine/unattached/device[22]",
341 #                "tray-open": true
342 #      },
343 #      "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
346 { 'event': 'DEVICE_TRAY_MOVED',
347   'data': { 'device': 'str', 'id': 'str', 'tray-open': 'bool' } }
350 # @PR_MANAGER_STATUS_CHANGED:
352 # Emitted whenever the connected status of a persistent reservation
353 # manager changes.
355 # @id: The id of the PR manager object
357 # @connected: true if the PR manager is connected to a backend
359 # Since: 3.0
361 # Example:
363 # <- { "event": "PR_MANAGER_STATUS_CHANGED",
364 #      "data": { "id": "pr-helper0",
365 #                "connected": true
366 #      },
367 #      "timestamp": { "seconds": 1519840375, "microseconds": 450486 } }
370 { 'event': 'PR_MANAGER_STATUS_CHANGED',
371   'data': { 'id': 'str', 'connected': 'bool' } }
374 # @QuorumOpType:
376 # An enumeration of the quorum operation types
378 # @read: read operation
380 # @write: write operation
382 # @flush: flush operation
384 # Since: 2.6
386 { 'enum': 'QuorumOpType',
387   'data': [ 'read', 'write', 'flush' ] }
390 # @QUORUM_FAILURE:
392 # Emitted by the Quorum block driver if it fails to establish a quorum
394 # @reference: device name if defined else node name
396 # @sector-num: number of the first sector of the failed read operation
398 # @sectors-count: failed read operation sector count
400 # Note: This event is rate-limited.
402 # Since: 2.0
404 # Example:
406 # <- { "event": "QUORUM_FAILURE",
407 #      "data": { "reference": "usr1", "sector-num": 345435, "sectors-count": 5 },
408 #      "timestamp": { "seconds": 1344522075, "microseconds": 745528 } }
411 { 'event': 'QUORUM_FAILURE',
412   'data': { 'reference': 'str', 'sector-num': 'int', 'sectors-count': 'int' } }
415 # @QUORUM_REPORT_BAD:
417 # Emitted to report a corruption of a Quorum file
419 # @type: quorum operation type (Since 2.6)
421 # @error: error message. Only present on failure. This field
422 #         contains a human-readable error message. There are no semantics other
423 #         than that the block layer reported an error and clients should not
424 #         try to interpret the error string.
426 # @node-name: the graph node name of the block driver state
428 # @sector-num: number of the first sector of the failed read operation
430 # @sectors-count: failed read operation sector count
432 # Note: This event is rate-limited.
434 # Since: 2.0
436 # Example:
438 # 1. Read operation
440 # { "event": "QUORUM_REPORT_BAD",
441 #      "data": { "node-name": "node0", "sector-num": 345435, "sectors-count": 5,
442 #                "type": "read" },
443 #      "timestamp": { "seconds": 1344522075, "microseconds": 745528 } }
445 # 2. Flush operation
447 # { "event": "QUORUM_REPORT_BAD",
448 #      "data": { "node-name": "node0", "sector-num": 0, "sectors-count": 2097120,
449 #                "type": "flush", "error": "Broken pipe" },
450 #      "timestamp": { "seconds": 1456406829, "microseconds": 291763 } }
453 { 'event': 'QUORUM_REPORT_BAD',
454   'data': { 'type': 'QuorumOpType', '*error': 'str', 'node-name': 'str',
455             'sector-num': 'int', 'sectors-count': 'int' } }