hw/ide: Add the possibility to disable the CompactFlash device in the build
[qemu/ar7.git] / qapi / qom.json
blob84af23fe245de777985de1a67afbffdde92bfca7
1 # -*- Mode: Python -*-
2 # vim: filetype=python
4 # This work is licensed under the terms of the GNU GPL, version 2 or later.
5 # See the COPYING file in the top-level directory.
7 { 'include': 'authz.json' }
8 { 'include': 'block-core.json' }
9 { 'include': 'common.json' }
10 { 'include': 'crypto.json' }
13 # = QEMU Object Model (QOM)
17 # @ObjectPropertyInfo:
19 # @name: the name of the property
21 # @type: the type of the property.  This will typically come in one of
22 #     four forms:
24 #     1) A primitive type such as 'u8', 'u16', 'bool', 'str', or
25 #        'double'.  These types are mapped to the appropriate JSON
26 #        type.
28 #     2) A child type in the form 'child<subtype>' where subtype is a
29 #        qdev device type name.  Child properties create the
30 #        composition tree.
32 #     3) A link type in the form 'link<subtype>' where subtype is a
33 #        qdev device type name.  Link properties form the device model
34 #        graph.
36 # @description: if specified, the description of the property.
38 # @default-value: the default value, if any (since 5.0)
40 # Since: 1.2
42 { 'struct': 'ObjectPropertyInfo',
43   'data': { 'name': 'str',
44             'type': 'str',
45             '*description': 'str',
46             '*default-value': 'any' } }
49 # @qom-list:
51 # This command will list any properties of a object given a path in
52 # the object model.
54 # @path: the path within the object model.  See @qom-get for a
55 #     description of this parameter.
57 # Returns: a list of @ObjectPropertyInfo that describe the properties
58 #     of the object.
60 # Since: 1.2
62 # Example:
64 # -> { "execute": "qom-list",
65 #      "arguments": { "path": "/chardevs" } }
66 # <- { "return": [ { "name": "type", "type": "string" },
67 #                  { "name": "parallel0", "type": "child<chardev-vc>" },
68 #                  { "name": "serial0", "type": "child<chardev-vc>" },
69 #                  { "name": "mon0", "type": "child<chardev-stdio>" } ] }
71 { 'command': 'qom-list',
72   'data': { 'path': 'str' },
73   'returns': [ 'ObjectPropertyInfo' ],
74   'allow-preconfig': true }
77 # @qom-get:
79 # This command will get a property from a object model path and return
80 # the value.
82 # @path: The path within the object model.  There are two forms of
83 #     supported paths--absolute and partial paths.
85 #     Absolute paths are derived from the root object and can follow
86 #     child<> or link<> properties.  Since they can follow link<>
87 #     properties, they can be arbitrarily long.  Absolute paths look
88 #     like absolute filenames and are prefixed  with a leading slash.
90 #     Partial paths look like relative filenames.  They do not begin
91 #     with a prefix.  The matching rules for partial paths are subtle
92 #     but designed to make specifying objects easy.  At each level of
93 #     the composition tree, the partial path is matched as an absolute
94 #     path.  The first match is not returned.  At least two matches
95 #     are searched for.  A successful result is only returned if only
96 #     one match is found.  If more than one match is found, a flag is
97 #     return to indicate that the match was ambiguous.
99 # @property: The property name to read
101 # Returns: The property value.  The type depends on the property type.
102 #     child<> and link<> properties are returned as #str pathnames.
103 #     All integer property types (u8, u16, etc) are returned as #int.
105 # Since: 1.2
107 # Examples:
109 # 1. Use absolute path
111 # -> { "execute": "qom-get",
112 #      "arguments": { "path": "/machine/unattached/device[0]",
113 #                     "property": "hotplugged" } }
114 # <- { "return": false }
116 # 2. Use partial path
118 # -> { "execute": "qom-get",
119 #      "arguments": { "path": "unattached/sysbus",
120 #                     "property": "type" } }
121 # <- { "return": "System" }
123 { 'command': 'qom-get',
124   'data': { 'path': 'str', 'property': 'str' },
125   'returns': 'any',
126   'allow-preconfig': true }
129 # @qom-set:
131 # This command will set a property from a object model path.
133 # @path: see @qom-get for a description of this parameter
135 # @property: the property name to set
137 # @value: a value who's type is appropriate for the property type.
138 #     See @qom-get for a description of type mapping.
140 # Since: 1.2
142 # Example:
144 # -> { "execute": "qom-set",
145 #      "arguments": { "path": "/machine",
146 #                     "property": "graphics",
147 #                     "value": false } }
148 # <- { "return": {} }
150 { 'command': 'qom-set',
151   'data': { 'path': 'str', 'property': 'str', 'value': 'any' },
152   'allow-preconfig': true }
155 # @ObjectTypeInfo:
157 # This structure describes a search result from @qom-list-types
159 # @name: the type name found in the search
161 # @abstract: the type is abstract and can't be directly instantiated.
162 #     Omitted if false.  (since 2.10)
164 # @parent: Name of parent type, if any (since 2.10)
166 # Since: 1.1
168 { 'struct': 'ObjectTypeInfo',
169   'data': { 'name': 'str', '*abstract': 'bool', '*parent': 'str' } }
172 # @qom-list-types:
174 # This command will return a list of types given search parameters
176 # @implements: if specified, only return types that implement this
177 #     type name
179 # @abstract: if true, include abstract types in the results
181 # Returns: a list of @ObjectTypeInfo or an empty list if no results
182 #     are found
184 # Since: 1.1
186 { 'command': 'qom-list-types',
187   'data': { '*implements': 'str', '*abstract': 'bool' },
188   'returns': [ 'ObjectTypeInfo' ],
189   'allow-preconfig': true }
192 # @qom-list-properties:
194 # List properties associated with a QOM object.
196 # @typename: the type name of an object
198 # Note: objects can create properties at runtime, for example to
199 #     describe links between different devices and/or objects.  These
200 #     properties are not included in the output of this command.
202 # Returns: a list of ObjectPropertyInfo describing object properties
204 # Since: 2.12
206 { 'command': 'qom-list-properties',
207   'data': { 'typename': 'str'},
208   'returns': [ 'ObjectPropertyInfo' ],
209   'allow-preconfig': true }
212 # @CanHostSocketcanProperties:
214 # Properties for can-host-socketcan objects.
216 # @if: interface name of the host system CAN bus to connect to
218 # @canbus: object ID of the can-bus object to connect to the host
219 #     interface
221 # Since: 2.12
223 { 'struct': 'CanHostSocketcanProperties',
224   'data': { 'if': 'str',
225             'canbus': 'str' } }
228 # @ColoCompareProperties:
230 # Properties for colo-compare objects.
232 # @primary_in: name of the character device backend to use for the
233 #     primary input (incoming packets are redirected to @outdev)
235 # @secondary_in: name of the character device backend to use for
236 #     secondary input (incoming packets are only compared to the input
237 #     on @primary_in and then dropped)
239 # @outdev: name of the character device backend to use for output
241 # @iothread: name of the iothread to run in
243 # @notify_dev: name of the character device backend to be used to
244 #     communicate with the remote colo-frame (only for Xen COLO)
246 # @compare_timeout: the maximum time to hold a packet from @primary_in
247 #     for comparison with an incoming packet on @secondary_in in
248 #     milliseconds (default: 3000)
250 # @expired_scan_cycle: the interval at which colo-compare checks
251 #     whether packets from @primary have timed out, in milliseconds
252 #     (default: 3000)
254 # @max_queue_size: the maximum number of packets to keep in the queue
255 #     for comparing with incoming packets from @secondary_in.  If the
256 #     queue is full and additional packets are received, the
257 #     additional packets are dropped.  (default: 1024)
259 # @vnet_hdr_support: if true, vnet header support is enabled
260 #     (default: false)
262 # Since: 2.8
264 { 'struct': 'ColoCompareProperties',
265   'data': { 'primary_in': 'str',
266             'secondary_in': 'str',
267             'outdev': 'str',
268             'iothread': 'str',
269             '*notify_dev': 'str',
270             '*compare_timeout': 'uint64',
271             '*expired_scan_cycle': 'uint32',
272             '*max_queue_size': 'uint32',
273             '*vnet_hdr_support': 'bool' } }
276 # @CryptodevBackendProperties:
278 # Properties for cryptodev-backend and cryptodev-backend-builtin
279 # objects.
281 # @queues: the number of queues for the cryptodev backend.  Ignored
282 #     for cryptodev-backend and must be 1 for
283 #     cryptodev-backend-builtin.  (default: 1)
285 # @throttle-bps: limit total bytes per second (Since 8.0)
287 # @throttle-ops: limit total operations per second (Since 8.0)
289 # Since: 2.8
291 { 'struct': 'CryptodevBackendProperties',
292   'data': { '*queues': 'uint32',
293             '*throttle-bps': 'uint64',
294             '*throttle-ops': 'uint64' } }
297 # @CryptodevVhostUserProperties:
299 # Properties for cryptodev-vhost-user objects.
301 # @chardev: the name of a Unix domain socket character device that
302 #     connects to the vhost-user server
304 # Since: 2.12
306 { 'struct': 'CryptodevVhostUserProperties',
307   'base': 'CryptodevBackendProperties',
308   'data': { 'chardev': 'str' } }
311 # @DBusVMStateProperties:
313 # Properties for dbus-vmstate objects.
315 # @addr: the name of the DBus bus to connect to
317 # @id-list: a comma separated list of DBus IDs of helpers whose data
318 #     should be included in the VM state on migration
320 # Since: 5.0
322 { 'struct': 'DBusVMStateProperties',
323   'data': { 'addr': 'str' ,
324             '*id-list': 'str' } }
327 # @NetfilterInsert:
329 # Indicates where to insert a netfilter relative to a given other
330 # filter.
332 # @before: insert before the specified filter
334 # @behind: insert behind the specified filter
336 # Since: 5.0
338 { 'enum': 'NetfilterInsert',
339   'data': [ 'before', 'behind' ] }
342 # @NetfilterProperties:
344 # Properties for objects of classes derived from netfilter.
346 # @netdev: id of the network device backend to filter
348 # @queue: indicates which queue(s) to filter (default: all)
350 # @status: indicates whether the filter is enabled ("on") or disabled
351 #     ("off") (default: "on")
353 # @position: specifies where the filter should be inserted in the
354 #     filter list.  "head" means the filter is inserted at the head of
355 #     the filter list, before any existing filters.  "tail" means the
356 #     filter is inserted at the tail of the filter list, behind any
357 #     existing filters (default). "id=<id>" means the filter is
358 #     inserted before or behind the filter specified by <id>,
359 #     depending on the @insert property.  (default: "tail")
361 # @insert: where to insert the filter relative to the filter given in
362 #     @position.  Ignored if @position is "head" or "tail".
363 #     (default: behind)
365 # Since: 2.5
367 { 'struct': 'NetfilterProperties',
368   'data': { 'netdev': 'str',
369             '*queue': 'NetFilterDirection',
370             '*status': 'str',
371             '*position': 'str',
372             '*insert': 'NetfilterInsert' } }
375 # @FilterBufferProperties:
377 # Properties for filter-buffer objects.
379 # @interval: a non-zero interval in microseconds.  All packets
380 #     arriving in the given interval are delayed until the end of the
381 #     interval.
383 # Since: 2.5
385 { 'struct': 'FilterBufferProperties',
386   'base': 'NetfilterProperties',
387   'data': { 'interval': 'uint32' } }
390 # @FilterDumpProperties:
392 # Properties for filter-dump objects.
394 # @file: the filename where the dumped packets should be stored
396 # @maxlen: maximum number of bytes in a packet that are stored
397 #     (default: 65536)
399 # Since: 2.5
401 { 'struct': 'FilterDumpProperties',
402   'base': 'NetfilterProperties',
403   'data': { 'file': 'str',
404             '*maxlen': 'uint32' } }
407 # @FilterMirrorProperties:
409 # Properties for filter-mirror objects.
411 # @outdev: the name of a character device backend to which all
412 #     incoming packets are mirrored
414 # @vnet_hdr_support: if true, vnet header support is enabled
415 #     (default: false)
417 # Since: 2.6
419 { 'struct': 'FilterMirrorProperties',
420   'base': 'NetfilterProperties',
421   'data': { 'outdev': 'str',
422             '*vnet_hdr_support': 'bool' } }
425 # @FilterRedirectorProperties:
427 # Properties for filter-redirector objects.
429 # At least one of @indev or @outdev must be present.  If both are
430 # present, they must not refer to the same character device backend.
432 # @indev: the name of a character device backend from which packets
433 #     are received and redirected to the filtered network device
435 # @outdev: the name of a character device backend to which all
436 #     incoming packets are redirected
438 # @vnet_hdr_support: if true, vnet header support is enabled
439 #     (default: false)
441 # Since: 2.6
443 { 'struct': 'FilterRedirectorProperties',
444   'base': 'NetfilterProperties',
445   'data': { '*indev': 'str',
446             '*outdev': 'str',
447             '*vnet_hdr_support': 'bool' } }
450 # @FilterRewriterProperties:
452 # Properties for filter-rewriter objects.
454 # @vnet_hdr_support: if true, vnet header support is enabled
455 #     (default: false)
457 # Since: 2.8
459 { 'struct': 'FilterRewriterProperties',
460   'base': 'NetfilterProperties',
461   'data': { '*vnet_hdr_support': 'bool' } }
464 # @InputBarrierProperties:
466 # Properties for input-barrier objects.
468 # @name: the screen name as declared in the screens section of
469 #     barrier.conf
471 # @server: hostname of the Barrier server (default: "localhost")
473 # @port: TCP port of the Barrier server (default: "24800")
475 # @x-origin: x coordinate of the leftmost pixel on the guest screen
476 #     (default: "0")
478 # @y-origin: y coordinate of the topmost pixel on the guest screen
479 #     (default: "0")
481 # @width: the width of secondary screen in pixels (default: "1920")
483 # @height: the height of secondary screen in pixels (default: "1080")
485 # Since: 4.2
487 { 'struct': 'InputBarrierProperties',
488   'data': { 'name': 'str',
489             '*server': 'str',
490             '*port': 'str',
491             '*x-origin': 'str',
492             '*y-origin': 'str',
493             '*width': 'str',
494             '*height': 'str' } }
497 # @InputLinuxProperties:
499 # Properties for input-linux objects.
501 # @evdev: the path of the host evdev device to use
503 # @grab_all: if true, grab is toggled for all devices (e.g. both
504 #     keyboard and mouse) instead of just one device (default: false)
506 # @repeat: enables auto-repeat events (default: false)
508 # @grab-toggle: the key or key combination that toggles device grab
509 #     (default: ctrl-ctrl)
511 # Since: 2.6
513 { 'struct': 'InputLinuxProperties',
514   'data': { 'evdev': 'str',
515             '*grab_all': 'bool',
516             '*repeat': 'bool',
517             '*grab-toggle': 'GrabToggleKeys' } }
520 # @EventLoopBaseProperties:
522 # Common properties for event loops
524 # @aio-max-batch: maximum number of requests in a batch for the AIO
525 #     engine, 0 means that the engine will use its default.
526 #     (default: 0)
528 # @thread-pool-min: minimum number of threads reserved in the thread
529 #     pool (default:0)
531 # @thread-pool-max: maximum number of threads the thread pool can
532 #     contain (default:64)
534 # Since: 7.1
536 { 'struct': 'EventLoopBaseProperties',
537   'data': { '*aio-max-batch': 'int',
538             '*thread-pool-min': 'int',
539             '*thread-pool-max': 'int' } }
542 # @IothreadProperties:
544 # Properties for iothread objects.
546 # @poll-max-ns: the maximum number of nanoseconds to busy wait for
547 #     events.  0 means polling is disabled (default: 32768 on POSIX
548 #     hosts, 0 otherwise)
550 # @poll-grow: the multiplier used to increase the polling time when
551 #     the algorithm detects it is missing events due to not polling
552 #     long enough.  0 selects a default behaviour (default: 0)
554 # @poll-shrink: the divisor used to decrease the polling time when the
555 #     algorithm detects it is spending too long polling without
556 #     encountering events.  0 selects a default behaviour (default: 0)
558 # The @aio-max-batch option is available since 6.1.
560 # Since: 2.0
562 { 'struct': 'IothreadProperties',
563   'base': 'EventLoopBaseProperties',
564   'data': { '*poll-max-ns': 'int',
565             '*poll-grow': 'int',
566             '*poll-shrink': 'int' } }
569 # @MainLoopProperties:
571 # Properties for the main-loop object.
573 # Since: 7.1
575 { 'struct': 'MainLoopProperties',
576   'base': 'EventLoopBaseProperties',
577   'data': {} }
580 # @MemoryBackendProperties:
582 # Properties for objects of classes derived from memory-backend.
584 # @merge: if true, mark the memory as mergeable (default depends on
585 #     the machine type)
587 # @dump: if true, include the memory in core dumps (default depends on
588 #     the machine type)
590 # @host-nodes: the list of NUMA host nodes to bind the memory to
592 # @policy: the NUMA policy (default: 'default')
594 # @prealloc: if true, preallocate memory (default: false)
596 # @prealloc-threads: number of CPU threads to use for prealloc
597 #     (default: 1)
599 # @prealloc-context: thread context to use for creation of
600 #     preallocation threads (default: none) (since 7.2)
602 # @share: if false, the memory is private to QEMU; if true, it is
603 #     shared (default: false)
605 # @reserve: if true, reserve swap space (or huge pages) if applicable
606 #     (default: true) (since 6.1)
608 # @size: size of the memory region in bytes
610 # @x-use-canonical-path-for-ramblock-id: if true, the canonical path
611 #     is used for ramblock-id.  Disable this for 4.0 machine types or
612 #     older to allow migration with newer QEMU versions.
613 #     (default: false generally, but true for machine types <= 4.0)
615 # Note: prealloc=true and reserve=false cannot be set at the same
616 #     time.  With reserve=true, the behavior depends on the operating
617 #     system: for example, Linux will not reserve swap space for
618 #     shared file mappings -- "not applicable". In contrast,
619 #     reserve=false will bail out if it cannot be configured
620 #     accordingly.
622 # Since: 2.1
624 { 'struct': 'MemoryBackendProperties',
625   'data': { '*dump': 'bool',
626             '*host-nodes': ['uint16'],
627             '*merge': 'bool',
628             '*policy': 'HostMemPolicy',
629             '*prealloc': 'bool',
630             '*prealloc-threads': 'uint32',
631             '*prealloc-context': 'str',
632             '*share': 'bool',
633             '*reserve': 'bool',
634             'size': 'size',
635             '*x-use-canonical-path-for-ramblock-id': 'bool' } }
638 # @MemoryBackendFileProperties:
640 # Properties for memory-backend-file objects.
642 # @align: the base address alignment when QEMU mmap(2)s @mem-path.
643 #     Some backend stores specified by @mem-path require an alignment
644 #     different than the default one used by QEMU, e.g. the device DAX
645 #     /dev/dax0.0 requires 2M alignment rather than 4K. In such cases,
646 #     users can specify the required alignment via this option.  0
647 #     selects a default alignment (currently the page size).
648 #     (default: 0)
650 # @offset: the offset into the target file that the region starts at.
651 #     You can use this option to back multiple regions with a single
652 #     file. Must be a multiple of the page size.
653 #     (default: 0) (since 8.1)
655 # @discard-data: if true, the file contents can be destroyed when QEMU
656 #     exits, to avoid unnecessarily flushing data to the backing file.
657 #     Note that @discard-data is only an optimization, and QEMU might
658 #     not discard file contents if it aborts unexpectedly or is
659 #     terminated using SIGKILL. (default: false)
661 # @mem-path: the path to either a shared memory or huge page
662 #     filesystem mount
664 # @pmem: specifies whether the backing file specified by @mem-path is
665 #     in host persistent memory that can be accessed using the SNIA
666 #     NVM programming model (e.g. Intel NVDIMM).
668 # @readonly: if true, the backing file is opened read-only; if false,
669 #     it is opened read-write.  (default: false)
671 # @rom: whether to create Read Only Memory (ROM) that cannot be modified
672 #       by the VM.  Any write attempts to such ROM will be denied.  Most
673 #       use cases want writable RAM instead of ROM.  However, selected use
674 #       cases, like R/O NVDIMMs, can benefit from ROM.  If set to 'on',
675 #       create ROM; if set to 'off', create writable RAM;  if set to
676 #       'auto', the value of the @readonly property is used.  This
677 #       property is primarily helpful when we want to have proper RAM in
678 #       configurations that would traditionally create ROM before this
679 #       property was introduced: VM templating, where we want to open a
680 #       file readonly (@readonly set to true) and mark the memory to be
681 #       private for QEMU (@share set to false).  For this use case, we need
682 #       writable RAM instead of ROM, and want to set this property to 'off'.
683 #       (default: auto, since 8.2)
685 # Since: 2.1
687 { 'struct': 'MemoryBackendFileProperties',
688   'base': 'MemoryBackendProperties',
689   'data': { '*align': 'size',
690             '*offset': 'size',
691             '*discard-data': 'bool',
692             'mem-path': 'str',
693             '*pmem': { 'type': 'bool', 'if': 'CONFIG_LIBPMEM' },
694             '*readonly': 'bool',
695             '*rom': 'OnOffAuto' } }
698 # @MemoryBackendMemfdProperties:
700 # Properties for memory-backend-memfd objects.
702 # The @share boolean option is true by default with memfd.
704 # @hugetlb: if true, the file to be created resides in the hugetlbfs
705 #     filesystem (default: false)
707 # @hugetlbsize: the hugetlb page size on systems that support multiple
708 #     hugetlb page sizes (it must be a power of 2 value supported by
709 #     the system). 0 selects a default page size.  This option is
710 #     ignored if @hugetlb is false.  (default: 0)
712 # @seal: if true, create a sealed-file, which will block further
713 #     resizing of the memory (default: true)
715 # Since: 2.12
717 { 'struct': 'MemoryBackendMemfdProperties',
718   'base': 'MemoryBackendProperties',
719   'data': { '*hugetlb': 'bool',
720             '*hugetlbsize': 'size',
721             '*seal': 'bool' } }
724 # @MemoryBackendEpcProperties:
726 # Properties for memory-backend-epc objects.
728 # The @share boolean option is true by default with epc
730 # The @merge boolean option is false by default with epc
732 # The @dump boolean option is false by default with epc
734 # Since: 6.2
736 { 'struct': 'MemoryBackendEpcProperties',
737   'base': 'MemoryBackendProperties',
738   'data': {} }
741 # @PrManagerHelperProperties:
743 # Properties for pr-manager-helper objects.
745 # @path: the path to a Unix domain socket for connecting to the
746 #     external helper
748 # Since: 2.11
750 { 'struct': 'PrManagerHelperProperties',
751   'data': { 'path': 'str' } }
754 # @QtestProperties:
756 # Properties for qtest objects.
758 # @chardev: the chardev to be used to receive qtest commands on.
760 # @log: the path to a log file
762 # Since: 6.0
764 { 'struct': 'QtestProperties',
765         'data': { 'chardev': 'str',
766                   '*log': 'str' } }
769 # @RemoteObjectProperties:
771 # Properties for x-remote-object objects.
773 # @fd: file descriptor name previously passed via 'getfd' command
775 # @devid: the id of the device to be associated with the file
776 #     descriptor
778 # Since: 6.0
780 { 'struct': 'RemoteObjectProperties',
781   'data': { 'fd': 'str', 'devid': 'str' } }
784 # @VfioUserServerProperties:
786 # Properties for x-vfio-user-server objects.
788 # @socket: socket to be used by the libvfio-user library
790 # @device: the ID of the device to be emulated at the server
792 # Since: 7.1
794 { 'struct': 'VfioUserServerProperties',
795   'data': { 'socket': 'SocketAddress', 'device': 'str' } }
798 # @IOMMUFDProperties:
800 # Properties for iommufd objects.
802 # @fd: file descriptor name previously passed via 'getfd' command,
803 #     which represents a pre-opened /dev/iommu.  This allows the
804 #     iommufd object to be shared accross several subsystems
805 #     (VFIO, VDPA, ...), and the file descriptor to be shared
806 #     with other process, e.g. DPDK.  (default: QEMU opens
807 #     /dev/iommu by itself)
809 # Since: 9.0
811 { 'struct': 'IOMMUFDProperties',
812   'data': { '*fd': 'str' } }
815 # @RngProperties:
817 # Properties for objects of classes derived from rng.
819 # @opened: if true, the device is opened immediately when applying
820 #     this option and will probably fail when processing the next
821 #     option.  Don't use; only provided for compatibility.
822 #     (default: false)
824 # Features:
826 # @deprecated: Member @opened is deprecated.  Setting true doesn't
827 #     make sense, and false is already the default.
829 # Since: 1.3
831 { 'struct': 'RngProperties',
832   'data': { '*opened': { 'type': 'bool', 'features': ['deprecated'] } } }
835 # @RngEgdProperties:
837 # Properties for rng-egd objects.
839 # @chardev: the name of a character device backend that provides the
840 #     connection to the RNG daemon
842 # Since: 1.3
844 { 'struct': 'RngEgdProperties',
845   'base': 'RngProperties',
846   'data': { 'chardev': 'str' } }
849 # @RngRandomProperties:
851 # Properties for rng-random objects.
853 # @filename: the filename of the device on the host to obtain entropy
854 #     from (default: "/dev/urandom")
856 # Since: 1.3
858 { 'struct': 'RngRandomProperties',
859   'base': 'RngProperties',
860   'data': { '*filename': 'str' } }
863 # @SevGuestProperties:
865 # Properties for sev-guest objects.
867 # @sev-device: SEV device to use (default: "/dev/sev")
869 # @dh-cert-file: guest owners DH certificate (encoded with base64)
871 # @session-file: guest owners session parameters (encoded with base64)
873 # @policy: SEV policy value (default: 0x1)
875 # @handle: SEV firmware handle (default: 0)
877 # @cbitpos: C-bit location in page table entry (default: 0)
879 # @reduced-phys-bits: number of bits in physical addresses that become
880 #     unavailable when SEV is enabled
882 # @kernel-hashes: if true, add hashes of kernel/initrd/cmdline to a
883 #     designated guest firmware page for measured boot with -kernel
884 #     (default: false) (since 6.2)
886 # Since: 2.12
888 { 'struct': 'SevGuestProperties',
889   'data': { '*sev-device': 'str',
890             '*dh-cert-file': 'str',
891             '*session-file': 'str',
892             '*policy': 'uint32',
893             '*handle': 'uint32',
894             '*cbitpos': 'uint32',
895             'reduced-phys-bits': 'uint32',
896             '*kernel-hashes': 'bool' } }
899 # @ThreadContextProperties:
901 # Properties for thread context objects.
903 # @cpu-affinity: the list of host CPU numbers used as CPU affinity for
904 #     all threads created in the thread context (default: QEMU main
905 #     thread CPU affinity)
907 # @node-affinity: the list of host node numbers that will be resolved
908 #     to a list of host CPU numbers used as CPU affinity.  This is a
909 #     shortcut for specifying the list of host CPU numbers belonging
910 #     to the host nodes manually by setting @cpu-affinity.
911 #     (default: QEMU main thread affinity)
913 # Since: 7.2
915 { 'struct': 'ThreadContextProperties',
916   'data': { '*cpu-affinity': ['uint16'],
917             '*node-affinity': ['uint16'] } }
921 # @ObjectType:
923 # Features:
925 # @unstable: Member @x-remote-object is experimental.
927 # Since: 6.0
929 { 'enum': 'ObjectType',
930   'data': [
931     'authz-list',
932     'authz-listfile',
933     'authz-pam',
934     'authz-simple',
935     'can-bus',
936     { 'name': 'can-host-socketcan',
937       'if': 'CONFIG_LINUX' },
938     'colo-compare',
939     'cryptodev-backend',
940     'cryptodev-backend-builtin',
941     'cryptodev-backend-lkcf',
942     { 'name': 'cryptodev-vhost-user',
943       'if': 'CONFIG_VHOST_CRYPTO' },
944     'dbus-vmstate',
945     'filter-buffer',
946     'filter-dump',
947     'filter-mirror',
948     'filter-redirector',
949     'filter-replay',
950     'filter-rewriter',
951     'input-barrier',
952     { 'name': 'input-linux',
953       'if': 'CONFIG_LINUX' },
954     'iommufd',
955     'iothread',
956     'main-loop',
957     { 'name': 'memory-backend-epc',
958       'if': 'CONFIG_LINUX' },
959     'memory-backend-file',
960     { 'name': 'memory-backend-memfd',
961       'if': 'CONFIG_LINUX' },
962     'memory-backend-ram',
963     'pef-guest',
964     { 'name': 'pr-manager-helper',
965       'if': 'CONFIG_LINUX' },
966     'qtest',
967     'rng-builtin',
968     'rng-egd',
969     { 'name': 'rng-random',
970       'if': 'CONFIG_POSIX' },
971     'secret',
972     { 'name': 'secret_keyring',
973       'if': 'CONFIG_SECRET_KEYRING' },
974     'sev-guest',
975     'thread-context',
976     's390-pv-guest',
977     'throttle-group',
978     'tls-creds-anon',
979     'tls-creds-psk',
980     'tls-creds-x509',
981     'tls-cipher-suites',
982     { 'name': 'x-remote-object', 'features': [ 'unstable' ] },
983     { 'name': 'x-vfio-user-server', 'features': [ 'unstable' ] }
984   ] }
987 # @ObjectOptions:
989 # Describes the options of a user creatable QOM object.
991 # @qom-type: the class name for the object to be created
993 # @id: the name of the new object
995 # Since: 6.0
997 { 'union': 'ObjectOptions',
998   'base': { 'qom-type': 'ObjectType',
999             'id': 'str' },
1000   'discriminator': 'qom-type',
1001   'data': {
1002       'authz-list':                 'AuthZListProperties',
1003       'authz-listfile':             'AuthZListFileProperties',
1004       'authz-pam':                  'AuthZPAMProperties',
1005       'authz-simple':               'AuthZSimpleProperties',
1006       'can-host-socketcan':         { 'type': 'CanHostSocketcanProperties',
1007                                       'if': 'CONFIG_LINUX' },
1008       'colo-compare':               'ColoCompareProperties',
1009       'cryptodev-backend':          'CryptodevBackendProperties',
1010       'cryptodev-backend-builtin':  'CryptodevBackendProperties',
1011       'cryptodev-backend-lkcf':     'CryptodevBackendProperties',
1012       'cryptodev-vhost-user':       { 'type': 'CryptodevVhostUserProperties',
1013                                       'if': 'CONFIG_VHOST_CRYPTO' },
1014       'dbus-vmstate':               'DBusVMStateProperties',
1015       'filter-buffer':              'FilterBufferProperties',
1016       'filter-dump':                'FilterDumpProperties',
1017       'filter-mirror':              'FilterMirrorProperties',
1018       'filter-redirector':          'FilterRedirectorProperties',
1019       'filter-replay':              'NetfilterProperties',
1020       'filter-rewriter':            'FilterRewriterProperties',
1021       'input-barrier':              'InputBarrierProperties',
1022       'input-linux':                { 'type': 'InputLinuxProperties',
1023                                       'if': 'CONFIG_LINUX' },
1024       'iommufd':                    'IOMMUFDProperties',
1025       'iothread':                   'IothreadProperties',
1026       'main-loop':                  'MainLoopProperties',
1027       'memory-backend-epc':         { 'type': 'MemoryBackendEpcProperties',
1028                                       'if': 'CONFIG_LINUX' },
1029       'memory-backend-file':        'MemoryBackendFileProperties',
1030       'memory-backend-memfd':       { 'type': 'MemoryBackendMemfdProperties',
1031                                       'if': 'CONFIG_LINUX' },
1032       'memory-backend-ram':         'MemoryBackendProperties',
1033       'pr-manager-helper':          { 'type': 'PrManagerHelperProperties',
1034                                       'if': 'CONFIG_LINUX' },
1035       'qtest':                      'QtestProperties',
1036       'rng-builtin':                'RngProperties',
1037       'rng-egd':                    'RngEgdProperties',
1038       'rng-random':                 { 'type': 'RngRandomProperties',
1039                                       'if': 'CONFIG_POSIX' },
1040       'secret':                     'SecretProperties',
1041       'secret_keyring':             { 'type': 'SecretKeyringProperties',
1042                                       'if': 'CONFIG_SECRET_KEYRING' },
1043       'sev-guest':                  'SevGuestProperties',
1044       'thread-context':             'ThreadContextProperties',
1045       'throttle-group':             'ThrottleGroupProperties',
1046       'tls-creds-anon':             'TlsCredsAnonProperties',
1047       'tls-creds-psk':              'TlsCredsPskProperties',
1048       'tls-creds-x509':             'TlsCredsX509Properties',
1049       'tls-cipher-suites':          'TlsCredsProperties',
1050       'x-remote-object':            'RemoteObjectProperties',
1051       'x-vfio-user-server':         'VfioUserServerProperties'
1052   } }
1055 # @object-add:
1057 # Create a QOM object.
1059 # Returns:
1060 #     - Nothing on success
1061 #     - Error if @qom-type is not a valid class name
1063 # Since: 2.0
1065 # Example:
1067 # -> { "execute": "object-add",
1068 #      "arguments": { "qom-type": "rng-random", "id": "rng1",
1069 #                     "filename": "/dev/hwrng" } }
1070 # <- { "return": {} }
1072 { 'command': 'object-add', 'data': 'ObjectOptions', 'boxed': true,
1073   'allow-preconfig': true }
1076 # @object-del:
1078 # Remove a QOM object.
1080 # @id: the name of the QOM object to remove
1082 # Returns:
1083 #     - Nothing on success
1084 #     - Error if @id is not a valid id for a QOM object
1086 # Since: 2.0
1088 # Example:
1090 # -> { "execute": "object-del", "arguments": { "id": "rng1" } }
1091 # <- { "return": {} }
1093 { 'command': 'object-del', 'data': {'id': 'str'},
1094   'allow-preconfig': true }