| blob | 80dd419b39257b1ee843b24587f39fd8fecc4ccf |
1 # -*- Mode: Python -*-
2 # vim: filetype=python
3 #
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' }
12 ##
13 # = QEMU Object Model (QOM)
14 ##
16 ##
17 # @ObjectPropertyInfo:
18 #
19 # @name: the name of the property
20 #
21 # @type: the type of the property. This will typically come in one of four
22 # forms:
23 #
24 # 1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
25 # These types are mapped to the appropriate JSON type.
26 #
27 # 2) A child type in the form 'child<subtype>' where subtype is a qdev
28 # device type name. Child properties create the composition tree.
29 #
30 # 3) A link type in the form 'link<subtype>' where subtype is a qdev
31 # device type name. Link properties form the device model graph.
32 #
33 # @description: if specified, the description of the property.
34 #
35 # @default-value: the default value, if any (since 5.0)
36 #
37 # Since: 1.2
38 ##
39 { 'struct': 'ObjectPropertyInfo',
40 'data': { 'name': 'str',
41 'type': 'str',
42 '*description': 'str',
43 '*default-value': 'any' } }
45 ##
46 # @qom-list:
47 #
48 # This command will list any properties of a object given a path in the object
49 # model.
50 #
51 # @path: the path within the object model. See @qom-get for a description of
52 # this parameter.
53 #
54 # Returns: a list of @ObjectPropertyInfo that describe the properties of the
55 # object.
56 #
57 # Since: 1.2
58 #
59 # Example:
60 #
61 # -> { "execute": "qom-list",
62 # "arguments": { "path": "/chardevs" } }
63 # <- { "return": [ { "name": "type", "type": "string" },
64 # { "name": "parallel0", "type": "child<chardev-vc>" },
65 # { "name": "serial0", "type": "child<chardev-vc>" },
66 # { "name": "mon0", "type": "child<chardev-stdio>" } ] }
67 #
68 ##
69 { 'command': 'qom-list',
70 'data': { 'path': 'str' },
71 'returns': [ 'ObjectPropertyInfo' ],
72 'allow-preconfig': true }
74 ##
75 # @qom-get:
76 #
77 # This command will get a property from a object model path and return the
78 # value.
79 #
80 # @path: The path within the object model. There are two forms of supported
81 # paths--absolute and partial paths.
82 #
83 # Absolute paths are derived from the root object and can follow child<>
84 # or link<> properties. Since they can follow link<> properties, they
85 # can be arbitrarily long. Absolute paths look like absolute filenames
86 # and are prefixed with a leading slash.
87 #
88 # Partial paths look like relative filenames. They do not begin
89 # with a prefix. The matching rules for partial paths are subtle but
90 # designed to make specifying objects easy. At each level of the
91 # composition tree, the partial path is matched as an absolute path.
92 # The first match is not returned. At least two matches are searched
93 # for. A successful result is only returned if only one match is
94 # found. If more than one match is found, a flag is return to
95 # indicate that the match was ambiguous.
96 #
97 # @property: The property name to read
98 #
99 # Returns: The property value. The type depends on the property
100 # type. child<> and link<> properties are returned as #str
101 # pathnames. All integer property types (u8, u16, etc) are
102 # returned as #int.
103 #
104 # Since: 1.2
105 #
106 # Example:
107 #
108 # 1. Use absolute path
109 #
110 # -> { "execute": "qom-get",
111 # "arguments": { "path": "/machine/unattached/device[0]",
112 # "property": "hotplugged" } }
113 # <- { "return": false }
114 #
115 # 2. Use partial path
116 #
117 # -> { "execute": "qom-get",
118 # "arguments": { "path": "unattached/sysbus",
119 # "property": "type" } }
120 # <- { "return": "System" }
121 #
122 ##
123 { 'command': 'qom-get',
124 'data': { 'path': 'str', 'property': 'str' },
125 'returns': 'any',
126 'allow-preconfig': true }
128 ##
129 # @qom-set:
130 #
131 # This command will set a property from a object model path.
132 #
133 # @path: see @qom-get for a description of this parameter
134 #
135 # @property: the property name to set
136 #
137 # @value: a value who's type is appropriate for the property type. See @qom-get
138 # for a description of type mapping.
139 #
140 # Since: 1.2
141 #
142 # Example:
143 #
144 # -> { "execute": "qom-set",
145 # "arguments": { "path": "/machine",
146 # "property": "graphics",
147 # "value": false } }
148 # <- { "return": {} }
149 #
150 ##
151 { 'command': 'qom-set',
152 'data': { 'path': 'str', 'property': 'str', 'value': 'any' },
153 'allow-preconfig': true }
155 ##
156 # @ObjectTypeInfo:
157 #
158 # This structure describes a search result from @qom-list-types
159 #
160 # @name: the type name found in the search
161 #
162 # @abstract: the type is abstract and can't be directly instantiated.
163 # Omitted if false. (since 2.10)
164 #
165 # @parent: Name of parent type, if any (since 2.10)
166 #
167 # Since: 1.1
168 ##
169 { 'struct': 'ObjectTypeInfo',
170 'data': { 'name': 'str', '*abstract': 'bool', '*parent': 'str' } }
172 ##
173 # @qom-list-types:
174 #
175 # This command will return a list of types given search parameters
176 #
177 # @implements: if specified, only return types that implement this type name
178 #
179 # @abstract: if true, include abstract types in the results
180 #
181 # Returns: a list of @ObjectTypeInfo or an empty list if no results are found
182 #
183 # Since: 1.1
184 ##
185 { 'command': 'qom-list-types',
186 'data': { '*implements': 'str', '*abstract': 'bool' },
187 'returns': [ 'ObjectTypeInfo' ],
188 'allow-preconfig': true }
190 ##
191 # @qom-list-properties:
192 #
193 # List properties associated with a QOM object.
194 #
195 # @typename: the type name of an object
196 #
197 # Note: objects can create properties at runtime, for example to describe
198 # links between different devices and/or objects. These properties
199 # are not included in the output of this command.
200 #
201 # Returns: a list of ObjectPropertyInfo describing object properties
202 #
203 # Since: 2.12
204 ##
205 { 'command': 'qom-list-properties',
206 'data': { 'typename': 'str'},
207 'returns': [ 'ObjectPropertyInfo' ],
208 'allow-preconfig': true }
210 ##
211 # @CanHostSocketcanProperties:
212 #
213 # Properties for can-host-socketcan objects.
214 #
215 # @if: interface name of the host system CAN bus to connect to
216 #
217 # @canbus: object ID of the can-bus object to connect to the host interface
218 #
219 # Since: 2.12
220 ##
221 { 'struct': 'CanHostSocketcanProperties',
222 'data': { 'if': 'str',
223 'canbus': 'str' } }
225 ##
226 # @ColoCompareProperties:
227 #
228 # Properties for colo-compare objects.
229 #
230 # @primary_in: name of the character device backend to use for the primary
231 # input (incoming packets are redirected to @outdev)
232 #
233 # @secondary_in: name of the character device backend to use for secondary
234 # input (incoming packets are only compared to the input on
235 # @primary_in and then dropped)
236 #
237 # @outdev: name of the character device backend to use for output
238 #
239 # @iothread: name of the iothread to run in
240 #
241 # @notify_dev: name of the character device backend to be used to communicate
242 # with the remote colo-frame (only for Xen COLO)
243 #
244 # @compare_timeout: the maximum time to hold a packet from @primary_in for
245 # comparison with an incoming packet on @secondary_in in
246 # milliseconds (default: 3000)
247 #
248 # @expired_scan_cycle: the interval at which colo-compare checks whether
249 # packets from @primary have timed out, in milliseconds
250 # (default: 3000)
251 #
252 # @max_queue_size: the maximum number of packets to keep in the queue for
253 # comparing with incoming packets from @secondary_in. If the
254 # queue is full and additional packets are received, the
255 # additional packets are dropped. (default: 1024)
256 #
257 # @vnet_hdr_support: if true, vnet header support is enabled (default: false)
258 #
259 # Since: 2.8
260 ##
261 { 'struct': 'ColoCompareProperties',
262 'data': { 'primary_in': 'str',
263 'secondary_in': 'str',
264 'outdev': 'str',
265 'iothread': 'str',
266 '*notify_dev': 'str',
267 '*compare_timeout': 'uint64',
268 '*expired_scan_cycle': 'uint32',
269 '*max_queue_size': 'uint32',
270 '*vnet_hdr_support': 'bool' } }
272 ##
273 # @CryptodevBackendProperties:
274 #
275 # Properties for cryptodev-backend and cryptodev-backend-builtin objects.
276 #
277 # @queues: the number of queues for the cryptodev backend. Ignored for
278 # cryptodev-backend and must be 1 for cryptodev-backend-builtin.
279 # (default: 1)
280 #
281 # Since: 2.8
282 ##
283 { 'struct': 'CryptodevBackendProperties',
284 'data': { '*queues': 'uint32' } }
286 ##
287 # @CryptodevVhostUserProperties:
288 #
289 # Properties for cryptodev-vhost-user objects.
290 #
291 # @chardev: the name of a Unix domain socket character device that connects to
292 # the vhost-user server
293 #
294 # Since: 2.12
295 ##
296 { 'struct': 'CryptodevVhostUserProperties',
297 'base': 'CryptodevBackendProperties',
298 'data': { 'chardev': 'str' } }
300 ##
301 # @DBusVMStateProperties:
302 #
303 # Properties for dbus-vmstate objects.
304 #
305 # @addr: the name of the DBus bus to connect to
306 #
307 # @id-list: a comma separated list of DBus IDs of helpers whose data should be
308 # included in the VM state on migration
309 #
310 # Since: 5.0
311 ##
312 { 'struct': 'DBusVMStateProperties',
313 'data': { 'addr': 'str' ,
314 '*id-list': 'str' } }
316 ##
317 # @NetfilterInsert:
318 #
319 # Indicates where to insert a netfilter relative to a given other filter.
320 #
321 # @before: insert before the specified filter
322 #
323 # @behind: insert behind the specified filter
324 #
325 # Since: 5.0
326 ##
327 { 'enum': 'NetfilterInsert',
328 'data': [ 'before', 'behind' ] }
330 ##
331 # @NetfilterProperties:
332 #
333 # Properties for objects of classes derived from netfilter.
334 #
335 # @netdev: id of the network device backend to filter
336 #
337 # @queue: indicates which queue(s) to filter (default: all)
338 #
339 # @status: indicates whether the filter is enabled ("on") or disabled ("off")
340 # (default: "on")
341 #
342 # @position: specifies where the filter should be inserted in the filter list.
343 # "head" means the filter is inserted at the head of the filter list,
344 # before any existing filters.
345 # "tail" means the filter is inserted at the tail of the filter list,
346 # behind any existing filters (default).
347 # "id=<id>" means the filter is inserted before or behind the filter
348 # specified by <id>, depending on the @insert property.
349 # (default: "tail")
350 #
351 # @insert: where to insert the filter relative to the filter given in @position.
352 # Ignored if @position is "head" or "tail". (default: behind)
353 #
354 # Since: 2.5
355 ##
356 { 'struct': 'NetfilterProperties',
357 'data': { 'netdev': 'str',
358 '*queue': 'NetFilterDirection',
359 '*status': 'str',
360 '*position': 'str',
361 '*insert': 'NetfilterInsert' } }
363 ##
364 # @FilterBufferProperties:
365 #
366 # Properties for filter-buffer objects.
367 #
368 # @interval: a non-zero interval in microseconds. All packets arriving in the
369 # given interval are delayed until the end of the interval.
370 #
371 # Since: 2.5
372 ##
373 { 'struct': 'FilterBufferProperties',
374 'base': 'NetfilterProperties',
375 'data': { 'interval': 'uint32' } }
377 ##
378 # @FilterDumpProperties:
379 #
380 # Properties for filter-dump objects.
381 #
382 # @file: the filename where the dumped packets should be stored
383 #
384 # @maxlen: maximum number of bytes in a packet that are stored (default: 65536)
385 #
386 # Since: 2.5
387 ##
388 { 'struct': 'FilterDumpProperties',
389 'base': 'NetfilterProperties',
390 'data': { 'file': 'str',
391 '*maxlen': 'uint32' } }
393 ##
394 # @FilterMirrorProperties:
395 #
396 # Properties for filter-mirror objects.
397 #
398 # @outdev: the name of a character device backend to which all incoming packets
399 # are mirrored
400 #
401 # @vnet_hdr_support: if true, vnet header support is enabled (default: false)
402 #
403 # Since: 2.6
404 ##
405 { 'struct': 'FilterMirrorProperties',
406 'base': 'NetfilterProperties',
407 'data': { 'outdev': 'str',
408 '*vnet_hdr_support': 'bool' } }
410 ##
411 # @FilterRedirectorProperties:
412 #
413 # Properties for filter-redirector objects.
414 #
415 # At least one of @indev or @outdev must be present. If both are present, they
416 # must not refer to the same character device backend.
417 #
418 # @indev: the name of a character device backend from which packets are
419 # received and redirected to the filtered network device
420 #
421 # @outdev: the name of a character device backend to which all incoming packets
422 # are redirected
423 #
424 # @vnet_hdr_support: if true, vnet header support is enabled (default: false)
425 #
426 # Since: 2.6
427 ##
428 { 'struct': 'FilterRedirectorProperties',
429 'base': 'NetfilterProperties',
430 'data': { '*indev': 'str',
431 '*outdev': 'str',
432 '*vnet_hdr_support': 'bool' } }
434 ##
435 # @FilterRewriterProperties:
436 #
437 # Properties for filter-rewriter objects.
438 #
439 # @vnet_hdr_support: if true, vnet header support is enabled (default: false)
440 #
441 # Since: 2.8
442 ##
443 { 'struct': 'FilterRewriterProperties',
444 'base': 'NetfilterProperties',
445 'data': { '*vnet_hdr_support': 'bool' } }
447 ##
448 # @InputBarrierProperties:
449 #
450 # Properties for input-barrier objects.
451 #
452 # @name: the screen name as declared in the screens section of barrier.conf
453 #
454 # @server: hostname of the Barrier server (default: "localhost")
455 #
456 # @port: TCP port of the Barrier server (default: "24800")
457 #
458 # @x-origin: x coordinate of the leftmost pixel on the guest screen
459 # (default: "0")
460 #
461 # @y-origin: y coordinate of the topmost pixel on the guest screen
462 # (default: "0")
463 #
464 # @width: the width of secondary screen in pixels (default: "1920")
465 #
466 # @height: the height of secondary screen in pixels (default: "1080")
467 #
468 # Since: 4.2
469 ##
470 { 'struct': 'InputBarrierProperties',
471 'data': { 'name': 'str',
472 '*server': 'str',
473 '*port': 'str',
474 '*x-origin': 'str',
475 '*y-origin': 'str',
476 '*width': 'str',
477 '*height': 'str' } }
479 ##
480 # @InputLinuxProperties:
481 #
482 # Properties for input-linux objects.
483 #
484 # @evdev: the path of the host evdev device to use
485 #
486 # @grab_all: if true, grab is toggled for all devices (e.g. both keyboard and
487 # mouse) instead of just one device (default: false)
488 #
489 # @repeat: enables auto-repeat events (default: false)
490 #
491 # @grab-toggle: the key or key combination that toggles device grab
492 # (default: ctrl-ctrl)
493 #
494 # Since: 2.6
495 ##
496 { 'struct': 'InputLinuxProperties',
497 'data': { 'evdev': 'str',
498 '*grab_all': 'bool',
499 '*repeat': 'bool',
500 '*grab-toggle': 'GrabToggleKeys' } }
502 ##
503 # @EventLoopBaseProperties:
504 #
505 # Common properties for event loops
506 #
507 # @aio-max-batch: maximum number of requests in a batch for the AIO engine,
508 # 0 means that the engine will use its default.
509 # (default: 0)
510 #
511 # @thread-pool-min: minimum number of threads reserved in the thread pool
512 # (default:0)
513 #
514 # @thread-pool-max: maximum number of threads the thread pool can contain
515 # (default:64)
516 #
517 # Since: 7.1
518 ##
519 { 'struct': 'EventLoopBaseProperties',
520 'data': { '*aio-max-batch': 'int',
521 '*thread-pool-min': 'int',
522 '*thread-pool-max': 'int' } }
524 ##
525 # @IothreadProperties:
526 #
527 # Properties for iothread objects.
528 #
529 # @poll-max-ns: the maximum number of nanoseconds to busy wait for events.
530 # 0 means polling is disabled (default: 32768 on POSIX hosts,
531 # 0 otherwise)
532 #
533 # @poll-grow: the multiplier used to increase the polling time when the
534 # algorithm detects it is missing events due to not polling long
535 # enough. 0 selects a default behaviour (default: 0)
536 #
537 # @poll-shrink: the divisor used to decrease the polling time when the
538 # algorithm detects it is spending too long polling without
539 # encountering events. 0 selects a default behaviour (default: 0)
540 #
541 # The @aio-max-batch option is available since 6.1.
542 #
543 # Since: 2.0
544 ##
545 { 'struct': 'IothreadProperties',
546 'base': 'EventLoopBaseProperties',
547 'data': { '*poll-max-ns': 'int',
548 '*poll-grow': 'int',
549 '*poll-shrink': 'int' } }
551 ##
552 # @MainLoopProperties:
553 #
554 # Properties for the main-loop object.
555 #
556 # Since: 7.1
557 ##
558 { 'struct': 'MainLoopProperties',
559 'base': 'EventLoopBaseProperties',
560 'data': {} }
562 ##
563 # @MemoryBackendProperties:
564 #
565 # Properties for objects of classes derived from memory-backend.
566 #
567 # @merge: if true, mark the memory as mergeable (default depends on the machine
568 # type)
569 #
570 # @dump: if true, include the memory in core dumps (default depends on the
571 # machine type)
572 #
573 # @host-nodes: the list of NUMA host nodes to bind the memory to
574 #
575 # @policy: the NUMA policy (default: 'default')
576 #
577 # @prealloc: if true, preallocate memory (default: false)
578 #
579 # @prealloc-threads: number of CPU threads to use for prealloc (default: 1)
580 #
581 # @share: if false, the memory is private to QEMU; if true, it is shared
582 # (default: false)
583 #
584 # @reserve: if true, reserve swap space (or huge pages) if applicable
585 # (default: true) (since 6.1)
586 #
587 # @size: size of the memory region in bytes
588 #
589 # @x-use-canonical-path-for-ramblock-id: if true, the canoncial path is used
590 # for ramblock-id. Disable this for 4.0
591 # machine types or older to allow
592 # migration with newer QEMU versions.
593 # (default: false generally,
594 # but true for machine types <= 4.0)
595 #
596 # Note: prealloc=true and reserve=false cannot be set at the same time. With
597 # reserve=true, the behavior depends on the operating system: for example,
598 # Linux will not reserve swap space for shared file mappings --
599 # "not applicable". In contrast, reserve=false will bail out if it cannot
600 # be configured accordingly.
601 #
602 # Since: 2.1
603 ##
604 { 'struct': 'MemoryBackendProperties',
605 'data': { '*dump': 'bool',
606 '*host-nodes': ['uint16'],
607 '*merge': 'bool',
608 '*policy': 'HostMemPolicy',
609 '*prealloc': 'bool',
610 '*prealloc-threads': 'uint32',
611 '*share': 'bool',
612 '*reserve': 'bool',
613 'size': 'size',
614 '*x-use-canonical-path-for-ramblock-id': 'bool' } }
616 ##
617 # @MemoryBackendFileProperties:
618 #
619 # Properties for memory-backend-file objects.
620 #
621 # @align: the base address alignment when QEMU mmap(2)s @mem-path. Some
622 # backend stores specified by @mem-path require an alignment different
623 # than the default one used by QEMU, e.g. the device DAX /dev/dax0.0
624 # requires 2M alignment rather than 4K. In such cases, users can
625 # specify the required alignment via this option.
626 # 0 selects a default alignment (currently the page size). (default: 0)
627 #
628 # @discard-data: if true, the file contents can be destroyed when QEMU exits,
629 # to avoid unnecessarily flushing data to the backing file. Note
630 # that ``discard-data`` is only an optimization, and QEMU might
631 # not discard file contents if it aborts unexpectedly or is
632 # terminated using SIGKILL. (default: false)
633 #
634 # @mem-path: the path to either a shared memory or huge page filesystem mount
635 #
636 # @pmem: specifies whether the backing file specified by @mem-path is in
637 # host persistent memory that can be accessed using the SNIA NVM
638 # programming model (e.g. Intel NVDIMM).
639 #
640 # @readonly: if true, the backing file is opened read-only; if false, it is
641 # opened read-write. (default: false)
642 #
643 # Since: 2.1
644 ##
645 { 'struct': 'MemoryBackendFileProperties',
646 'base': 'MemoryBackendProperties',
647 'data': { '*align': 'size',
648 '*discard-data': 'bool',
649 'mem-path': 'str',
650 '*pmem': { 'type': 'bool', 'if': 'CONFIG_LIBPMEM' },
651 '*readonly': 'bool' } }
653 ##
654 # @MemoryBackendMemfdProperties:
655 #
656 # Properties for memory-backend-memfd objects.
657 #
658 # The @share boolean option is true by default with memfd.
659 #
660 # @hugetlb: if true, the file to be created resides in the hugetlbfs filesystem
661 # (default: false)
662 #
663 # @hugetlbsize: the hugetlb page size on systems that support multiple hugetlb
664 # page sizes (it must be a power of 2 value supported by the
665 # system). 0 selects a default page size. This option is ignored
666 # if @hugetlb is false. (default: 0)
667 #
668 # @seal: if true, create a sealed-file, which will block further resizing of
669 # the memory (default: true)
670 #
671 # Since: 2.12
672 ##
673 { 'struct': 'MemoryBackendMemfdProperties',
674 'base': 'MemoryBackendProperties',
675 'data': { '*hugetlb': 'bool',
676 '*hugetlbsize': 'size',
677 '*seal': 'bool' } }
679 ##
680 # @MemoryBackendEpcProperties:
681 #
682 # Properties for memory-backend-epc objects.
683 #
684 # The @share boolean option is true by default with epc
685 #
686 # The @merge boolean option is false by default with epc
687 #
688 # The @dump boolean option is false by default with epc
689 #
690 # Since: 6.2
691 ##
692 { 'struct': 'MemoryBackendEpcProperties',
693 'base': 'MemoryBackendProperties',
694 'data': {} }
696 ##
697 # @PrManagerHelperProperties:
698 #
699 # Properties for pr-manager-helper objects.
700 #
701 # @path: the path to a Unix domain socket for connecting to the external helper
702 #
703 # Since: 2.11
704 ##
705 { 'struct': 'PrManagerHelperProperties',
706 'data': { 'path': 'str' } }
708 ##
709 # @QtestProperties:
710 #
711 # Properties for qtest objects.
712 #
713 # @chardev: the chardev to be used to receive qtest commands on.
714 #
715 # @log: the path to a log file
716 #
717 # Since: 6.0
718 ##
719 { 'struct': 'QtestProperties',
720 'data': { 'chardev': 'str',
721 '*log': 'str' } }
723 ##
724 # @RemoteObjectProperties:
725 #
726 # Properties for x-remote-object objects.
727 #
728 # @fd: file descriptor name previously passed via 'getfd' command
729 #
730 # @devid: the id of the device to be associated with the file descriptor
731 #
732 # Since: 6.0
733 ##
734 { 'struct': 'RemoteObjectProperties',
735 'data': { 'fd': 'str', 'devid': 'str' } }
737 ##
738 # @VfioUserServerProperties:
739 #
740 # Properties for x-vfio-user-server objects.
741 #
742 # @socket: socket to be used by the libvfio-user library
743 #
744 # @device: the ID of the device to be emulated at the server
745 #
746 # Since: 7.1
747 ##
748 { 'struct': 'VfioUserServerProperties',
749 'data': { 'socket': 'SocketAddress', 'device': 'str' } }
751 ##
752 # @RngProperties:
753 #
754 # Properties for objects of classes derived from rng.
755 #
756 # @opened: if true, the device is opened immediately when applying this option
757 # and will probably fail when processing the next option. Don't use;
758 # only provided for compatibility. (default: false)
759 #
760 # Features:
761 # @deprecated: Member @opened is deprecated. Setting true doesn't make sense,
762 # and false is already the default.
763 #
764 # Since: 1.3
765 ##
766 { 'struct': 'RngProperties',
767 'data': { '*opened': { 'type': 'bool', 'features': ['deprecated'] } } }
769 ##
770 # @RngEgdProperties:
771 #
772 # Properties for rng-egd objects.
773 #
774 # @chardev: the name of a character device backend that provides the connection
775 # to the RNG daemon
776 #
777 # Since: 1.3
778 ##
779 { 'struct': 'RngEgdProperties',
780 'base': 'RngProperties',
781 'data': { 'chardev': 'str' } }
783 ##
784 # @RngRandomProperties:
785 #
786 # Properties for rng-random objects.
787 #
788 # @filename: the filename of the device on the host to obtain entropy from
789 # (default: "/dev/urandom")
790 #
791 # Since: 1.3
792 ##
793 { 'struct': 'RngRandomProperties',
794 'base': 'RngProperties',
795 'data': { '*filename': 'str' } }
797 ##
798 # @SevGuestProperties:
799 #
800 # Properties for sev-guest objects.
801 #
802 # @sev-device: SEV device to use (default: "/dev/sev")
803 #
804 # @dh-cert-file: guest owners DH certificate (encoded with base64)
805 #
806 # @session-file: guest owners session parameters (encoded with base64)
807 #
808 # @policy: SEV policy value (default: 0x1)
809 #
810 # @handle: SEV firmware handle (default: 0)
811 #
812 # @cbitpos: C-bit location in page table entry (default: 0)
813 #
814 # @reduced-phys-bits: number of bits in physical addresses that become
815 # unavailable when SEV is enabled
816 #
817 # @kernel-hashes: if true, add hashes of kernel/initrd/cmdline to a
818 # designated guest firmware page for measured boot
819 # with -kernel (default: false) (since 6.2)
820 #
821 # Since: 2.12
822 ##
823 { 'struct': 'SevGuestProperties',
824 'data': { '*sev-device': 'str',
825 '*dh-cert-file': 'str',
826 '*session-file': 'str',
827 '*policy': 'uint32',
828 '*handle': 'uint32',
829 '*cbitpos': 'uint32',
830 'reduced-phys-bits': 'uint32',
831 '*kernel-hashes': 'bool' } }
833 ##
834 # @ObjectType:
835 #
836 # Features:
837 # @unstable: Member @x-remote-object is experimental.
838 #
839 # Since: 6.0
840 ##
841 { 'enum': 'ObjectType',
842 'data': [
843 'authz-list',
844 'authz-listfile',
845 'authz-pam',
846 'authz-simple',
847 'can-bus',
848 { 'name': 'can-host-socketcan',
849 'if': 'CONFIG_LINUX' },
850 'colo-compare',
851 'cryptodev-backend',
852 'cryptodev-backend-builtin',
853 { 'name': 'cryptodev-vhost-user',
854 'if': 'CONFIG_VHOST_CRYPTO' },
855 'dbus-vmstate',
856 'filter-buffer',
857 'filter-dump',
858 'filter-mirror',
859 'filter-redirector',
860 'filter-replay',
861 'filter-rewriter',
862 'input-barrier',
863 { 'name': 'input-linux',
864 'if': 'CONFIG_LINUX' },
865 'iothread',
866 'main-loop',
867 { 'name': 'memory-backend-epc',
868 'if': 'CONFIG_LINUX' },
869 'memory-backend-file',
870 { 'name': 'memory-backend-memfd',
871 'if': 'CONFIG_LINUX' },
872 'memory-backend-ram',
873 'pef-guest',
874 { 'name': 'pr-manager-helper',
875 'if': 'CONFIG_LINUX' },
876 'qtest',
877 'rng-builtin',
878 'rng-egd',
879 { 'name': 'rng-random',
880 'if': 'CONFIG_POSIX' },
881 'secret',
882 { 'name': 'secret_keyring',
883 'if': 'CONFIG_SECRET_KEYRING' },
884 'sev-guest',
885 's390-pv-guest',
886 'throttle-group',
887 'tls-creds-anon',
888 'tls-creds-psk',
889 'tls-creds-x509',
890 'tls-cipher-suites',
891 { 'name': 'x-remote-object', 'features': [ 'unstable' ] },
892 { 'name': 'x-vfio-user-server', 'features': [ 'unstable' ] }
893 ] }
895 ##
896 # @ObjectOptions:
897 #
898 # Describes the options of a user creatable QOM object.
899 #
900 # @qom-type: the class name for the object to be created
901 #
902 # @id: the name of the new object
903 #
904 # Since: 6.0
905 ##
906 { 'union': 'ObjectOptions',
907 'base': { 'qom-type': 'ObjectType',
908 'id': 'str' },
909 'discriminator': 'qom-type',
910 'data': {
911 'authz-list': 'AuthZListProperties',
912 'authz-listfile': 'AuthZListFileProperties',
913 'authz-pam': 'AuthZPAMProperties',
914 'authz-simple': 'AuthZSimpleProperties',
915 'can-host-socketcan': { 'type': 'CanHostSocketcanProperties',
916 'if': 'CONFIG_LINUX' },
917 'colo-compare': 'ColoCompareProperties',
918 'cryptodev-backend': 'CryptodevBackendProperties',
919 'cryptodev-backend-builtin': 'CryptodevBackendProperties',
920 'cryptodev-vhost-user': { 'type': 'CryptodevVhostUserProperties',
921 'if': 'CONFIG_VHOST_CRYPTO' },
922 'dbus-vmstate': 'DBusVMStateProperties',
923 'filter-buffer': 'FilterBufferProperties',
924 'filter-dump': 'FilterDumpProperties',
925 'filter-mirror': 'FilterMirrorProperties',
926 'filter-redirector': 'FilterRedirectorProperties',
927 'filter-replay': 'NetfilterProperties',
928 'filter-rewriter': 'FilterRewriterProperties',
929 'input-barrier': 'InputBarrierProperties',
930 'input-linux': { 'type': 'InputLinuxProperties',
931 'if': 'CONFIG_LINUX' },
932 'iothread': 'IothreadProperties',
933 'main-loop': 'MainLoopProperties',
934 'memory-backend-epc': { 'type': 'MemoryBackendEpcProperties',
935 'if': 'CONFIG_LINUX' },
936 'memory-backend-file': 'MemoryBackendFileProperties',
937 'memory-backend-memfd': { 'type': 'MemoryBackendMemfdProperties',
938 'if': 'CONFIG_LINUX' },
939 'memory-backend-ram': 'MemoryBackendProperties',
940 'pr-manager-helper': { 'type': 'PrManagerHelperProperties',
941 'if': 'CONFIG_LINUX' },
942 'qtest': 'QtestProperties',
943 'rng-builtin': 'RngProperties',
944 'rng-egd': 'RngEgdProperties',
945 'rng-random': { 'type': 'RngRandomProperties',
946 'if': 'CONFIG_POSIX' },
947 'secret': 'SecretProperties',
948 'secret_keyring': { 'type': 'SecretKeyringProperties',
949 'if': 'CONFIG_SECRET_KEYRING' },
950 'sev-guest': 'SevGuestProperties',
951 'throttle-group': 'ThrottleGroupProperties',
952 'tls-creds-anon': 'TlsCredsAnonProperties',
953 'tls-creds-psk': 'TlsCredsPskProperties',
954 'tls-creds-x509': 'TlsCredsX509Properties',
955 'tls-cipher-suites': 'TlsCredsProperties',
956 'x-remote-object': 'RemoteObjectProperties',
957 'x-vfio-user-server': 'VfioUserServerProperties'
958 } }
960 ##
961 # @object-add:
962 #
963 # Create a QOM object.
964 #
965 # Returns: Nothing on success
966 # Error if @qom-type is not a valid class name
967 #
968 # Since: 2.0
969 #
970 # Example:
971 #
972 # -> { "execute": "object-add",
973 # "arguments": { "qom-type": "rng-random", "id": "rng1",
974 # "filename": "/dev/hwrng" } }
975 # <- { "return": {} }
976 #
977 ##
978 { 'command': 'object-add', 'data': 'ObjectOptions', 'boxed': true,
979 'allow-preconfig': true }
981 ##
982 # @object-del:
983 #
984 # Remove a QOM object.
985 #
986 # @id: the name of the QOM object to remove
987 #
988 # Returns: Nothing on success
989 # Error if @id is not a valid id for a QOM object
990 #
991 # Since: 2.0
992 #
993 # Example:
994 #
995 # -> { "execute": "object-del", "arguments": { "id": "rng1" } }
996 # <- { "return": {} }
997 #
998 ##
999 { 'command': 'object-del', 'data': {'id': 'str'},
1000 'allow-preconfig': true }