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. 6 7 { 'include': 'authz.json' } 8 { 'include': 'block-core.json' } 9 { 'include': 'common.json' } 10 { 'include': 'crypto.json' } 11 12 ## 13 # = QEMU Object Model (QOM) 14 ## 15 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 22 # four forms: 23 # 24 # 1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 25 # 'double'. These types are mapped to the appropriate JSON 26 # type. 27 # 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. 31 # 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. 35 # 36 # @description: if specified, the description of the property. 37 # 38 # @default-value: the default value, if any (since 5.0) 39 # 40 # Since: 1.2 41 ## 42 { 'struct': 'ObjectPropertyInfo', 43 'data': { 'name': 'str', 44 'type': 'str', 45 '*description': 'str', 46 '*default-value': 'any' } } 47 48 ## 49 # @qom-list: 50 # 51 # This command will list any properties of a object given a path in 52 # the object model. 53 # 54 # @path: the path within the object model. See @qom-get for a 55 # description of this parameter. 56 # 57 # Returns: a list of @ObjectPropertyInfo that describe the properties 58 # of the object. 59 # 60 # Since: 1.2 61 # 62 # Example: 63 # 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>" } ] } 70 ## 71 { 'command': 'qom-list', 72 'data': { 'path': 'str' }, 73 'returns': [ 'ObjectPropertyInfo' ], 74 'allow-preconfig': true } 75 76 ## 77 # @qom-get: 78 # 79 # This command will get a property from a object model path and return 80 # the value. 81 # 82 # @path: The path within the object model. There are two forms of 83 # supported paths--absolute and partial paths. 84 # 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. 89 # 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. 98 # 99 # @property: The property name to read 100 # 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. 104 # 105 # Since: 1.2 106 # 107 # Examples: 108 # 109 # 1. Use absolute path 110 # 111 # -> { "execute": "qom-get", 112 # "arguments": { "path": "/machine/unattached/device[0]", 113 # "property": "hotplugged" } } 114 # <- { "return": false } 115 # 116 # 2. Use partial path 117 # 118 # -> { "execute": "qom-get", 119 # "arguments": { "path": "unattached/sysbus", 120 # "property": "type" } } 121 # <- { "return": "System" } 122 ## 123 { 'command': 'qom-get', 124 'data': { 'path': 'str', 'property': 'str' }, 125 'returns': 'any', 126 'allow-preconfig': true } 127 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. 138 # See @qom-get 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 { 'command': 'qom-set', 151 'data': { 'path': 'str', 'property': 'str', 'value': 'any' }, 152 'allow-preconfig': true } 153 154 ## 155 # @ObjectTypeInfo: 156 # 157 # This structure describes a search result from @qom-list-types 158 # 159 # @name: the type name found in the search 160 # 161 # @abstract: the type is abstract and can't be directly instantiated. 162 # Omitted if false. (since 2.10) 163 # 164 # @parent: Name of parent type, if any (since 2.10) 165 # 166 # Since: 1.1 167 ## 168 { 'struct': 'ObjectTypeInfo', 169 'data': { 'name': 'str', '*abstract': 'bool', '*parent': 'str' } } 170 171 ## 172 # @qom-list-types: 173 # 174 # This command will return a list of types given search parameters 175 # 176 # @implements: if specified, only return types that implement this 177 # 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 182 # are found 183 # 184 # Since: 1.1 185 ## 186 { 'command': 'qom-list-types', 187 'data': { '*implements': 'str', '*abstract': 'bool' }, 188 'returns': [ 'ObjectTypeInfo' ], 189 'allow-preconfig': true } 190 191 ## 192 # @qom-list-properties: 193 # 194 # List properties associated with a QOM object. 195 # 196 # @typename: the type name of an object 197 # 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. 201 # 202 # Returns: a list of ObjectPropertyInfo describing object properties 203 # 204 # Since: 2.12 205 ## 206 { 'command': 'qom-list-properties', 207 'data': { 'typename': 'str'}, 208 'returns': [ 'ObjectPropertyInfo' ], 209 'allow-preconfig': true } 210 211 ## 212 # @CanHostSocketcanProperties: 213 # 214 # Properties for can-host-socketcan objects. 215 # 216 # @if: interface name of the host system CAN bus to connect to 217 # 218 # @canbus: object ID of the can-bus object to connect to the host 219 # interface 220 # 221 # Since: 2.12 222 ## 223 { 'struct': 'CanHostSocketcanProperties', 224 'data': { 'if': 'str', 225 'canbus': 'str' } } 226 227 ## 228 # @ColoCompareProperties: 229 # 230 # Properties for colo-compare objects. 231 # 232 # @primary_in: name of the character device backend to use for the 233 # primary input (incoming packets are redirected to @outdev) 234 # 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) 238 # 239 # @outdev: name of the character device backend to use for output 240 # 241 # @iothread: name of the iothread to run in 242 # 243 # @notify_dev: name of the character device backend to be used to 244 # communicate with the remote colo-frame (only for Xen COLO) 245 # 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) 249 # 250 # @expired_scan_cycle: the interval at which colo-compare checks 251 # whether packets from @primary have timed out, in milliseconds 252 # (default: 3000) 253 # 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) 258 # 259 # @vnet_hdr_support: if true, vnet header support is enabled 260 # (default: false) 261 # 262 # Since: 2.8 263 ## 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' } } 274 275 ## 276 # @CryptodevBackendProperties: 277 # 278 # Properties for cryptodev-backend and cryptodev-backend-builtin 279 # objects. 280 # 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) 284 # 285 # @throttle-bps: limit total bytes per second (Since 8.0) 286 # 287 # @throttle-ops: limit total operations per second (Since 8.0) 288 # 289 # Since: 2.8 290 ## 291 { 'struct': 'CryptodevBackendProperties', 292 'data': { '*queues': 'uint32', 293 '*throttle-bps': 'uint64', 294 '*throttle-ops': 'uint64' } } 295 296 ## 297 # @CryptodevVhostUserProperties: 298 # 299 # Properties for cryptodev-vhost-user objects. 300 # 301 # @chardev: the name of a Unix domain socket character device that 302 # connects to the vhost-user server 303 # 304 # Since: 2.12 305 ## 306 { 'struct': 'CryptodevVhostUserProperties', 307 'base': 'CryptodevBackendProperties', 308 'data': { 'chardev': 'str' } } 309 310 ## 311 # @DBusVMStateProperties: 312 # 313 # Properties for dbus-vmstate objects. 314 # 315 # @addr: the name of the DBus bus to connect to 316 # 317 # @id-list: a comma separated list of DBus IDs of helpers whose data 318 # should be included in the VM state on migration 319 # 320 # Since: 5.0 321 ## 322 { 'struct': 'DBusVMStateProperties', 323 'data': { 'addr': 'str' , 324 '*id-list': 'str' } } 325 326 ## 327 # @NetfilterInsert: 328 # 329 # Indicates where to insert a netfilter relative to a given other 330 # filter. 331 # 332 # @before: insert before the specified filter 333 # 334 # @behind: insert behind the specified filter 335 # 336 # Since: 5.0 337 ## 338 { 'enum': 'NetfilterInsert', 339 'data': [ 'before', 'behind' ] } 340 341 ## 342 # @NetfilterProperties: 343 # 344 # Properties for objects of classes derived from netfilter. 345 # 346 # @netdev: id of the network device backend to filter 347 # 348 # @queue: indicates which queue(s) to filter (default: all) 349 # 350 # @status: indicates whether the filter is enabled ("on") or disabled 351 # ("off") (default: "on") 352 # 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") 360 # 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) 364 # 365 # Since: 2.5 366 ## 367 { 'struct': 'NetfilterProperties', 368 'data': { 'netdev': 'str', 369 '*queue': 'NetFilterDirection', 370 '*status': 'str', 371 '*position': 'str', 372 '*insert': 'NetfilterInsert' } } 373 374 ## 375 # @FilterBufferProperties: 376 # 377 # Properties for filter-buffer objects. 378 # 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. 382 # 383 # Since: 2.5 384 ## 385 { 'struct': 'FilterBufferProperties', 386 'base': 'NetfilterProperties', 387 'data': { 'interval': 'uint32' } } 388 389 ## 390 # @FilterDumpProperties: 391 # 392 # Properties for filter-dump objects. 393 # 394 # @file: the filename where the dumped packets should be stored 395 # 396 # @maxlen: maximum number of bytes in a packet that are stored 397 # (default: 65536) 398 # 399 # Since: 2.5 400 ## 401 { 'struct': 'FilterDumpProperties', 402 'base': 'NetfilterProperties', 403 'data': { 'file': 'str', 404 '*maxlen': 'uint32' } } 405 406 ## 407 # @FilterMirrorProperties: 408 # 409 # Properties for filter-mirror objects. 410 # 411 # @outdev: the name of a character device backend to which all 412 # incoming packets are mirrored 413 # 414 # @vnet_hdr_support: if true, vnet header support is enabled 415 # (default: false) 416 # 417 # Since: 2.6 418 ## 419 { 'struct': 'FilterMirrorProperties', 420 'base': 'NetfilterProperties', 421 'data': { 'outdev': 'str', 422 '*vnet_hdr_support': 'bool' } } 423 424 ## 425 # @FilterRedirectorProperties: 426 # 427 # Properties for filter-redirector objects. 428 # 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. 431 # 432 # @indev: the name of a character device backend from which packets 433 # are received and redirected to the filtered network device 434 # 435 # @outdev: the name of a character device backend to which all 436 # incoming packets are redirected 437 # 438 # @vnet_hdr_support: if true, vnet header support is enabled 439 # (default: false) 440 # 441 # Since: 2.6 442 ## 443 { 'struct': 'FilterRedirectorProperties', 444 'base': 'NetfilterProperties', 445 'data': { '*indev': 'str', 446 '*outdev': 'str', 447 '*vnet_hdr_support': 'bool' } } 448 449 ## 450 # @FilterRewriterProperties: 451 # 452 # Properties for filter-rewriter objects. 453 # 454 # @vnet_hdr_support: if true, vnet header support is enabled 455 # (default: false) 456 # 457 # Since: 2.8 458 ## 459 { 'struct': 'FilterRewriterProperties', 460 'base': 'NetfilterProperties', 461 'data': { '*vnet_hdr_support': 'bool' } } 462 463 ## 464 # @InputBarrierProperties: 465 # 466 # Properties for input-barrier objects. 467 # 468 # @name: the screen name as declared in the screens section of 469 # barrier.conf 470 # 471 # @server: hostname of the Barrier server (default: "localhost") 472 # 473 # @port: TCP port of the Barrier server (default: "24800") 474 # 475 # @x-origin: x coordinate of the leftmost pixel on the guest screen 476 # (default: "0") 477 # 478 # @y-origin: y coordinate of the topmost pixel on the guest screen 479 # (default: "0") 480 # 481 # @width: the width of secondary screen in pixels (default: "1920") 482 # 483 # @height: the height of secondary screen in pixels (default: "1080") 484 # 485 # Since: 4.2 486 ## 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' } } 495 496 ## 497 # @InputLinuxProperties: 498 # 499 # Properties for input-linux objects. 500 # 501 # @evdev: the path of the host evdev device to use 502 # 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) 505 # 506 # @repeat: enables auto-repeat events (default: false) 507 # 508 # @grab-toggle: the key or key combination that toggles device grab 509 # (default: ctrl-ctrl) 510 # 511 # Since: 2.6 512 ## 513 { 'struct': 'InputLinuxProperties', 514 'data': { 'evdev': 'str', 515 '*grab_all': 'bool', 516 '*repeat': 'bool', 517 '*grab-toggle': 'GrabToggleKeys' } } 518 519 ## 520 # @EventLoopBaseProperties: 521 # 522 # Common properties for event loops 523 # 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) 527 # 528 # @thread-pool-min: minimum number of threads reserved in the thread 529 # pool (default:0) 530 # 531 # @thread-pool-max: maximum number of threads the thread pool can 532 # contain (default:64) 533 # 534 # Since: 7.1 535 ## 536 { 'struct': 'EventLoopBaseProperties', 537 'data': { '*aio-max-batch': 'int', 538 '*thread-pool-min': 'int', 539 '*thread-pool-max': 'int' } } 540 541 ## 542 # @IothreadProperties: 543 # 544 # Properties for iothread objects. 545 # 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) 549 # 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) 553 # 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) 557 # 558 # The @aio-max-batch option is available since 6.1. 559 # 560 # Since: 2.0 561 ## 562 { 'struct': 'IothreadProperties', 563 'base': 'EventLoopBaseProperties', 564 'data': { '*poll-max-ns': 'int', 565 '*poll-grow': 'int', 566 '*poll-shrink': 'int' } } 567 568 ## 569 # @MainLoopProperties: 570 # 571 # Properties for the main-loop object. 572 # 573 # Since: 7.1 574 ## 575 { 'struct': 'MainLoopProperties', 576 'base': 'EventLoopBaseProperties', 577 'data': {} } 578 579 ## 580 # @MemoryBackendProperties: 581 # 582 # Properties for objects of classes derived from memory-backend. 583 # 584 # @merge: if true, mark the memory as mergeable (default depends on 585 # the machine type) 586 # 587 # @dump: if true, include the memory in core dumps (default depends on 588 # the machine type) 589 # 590 # @host-nodes: the list of NUMA host nodes to bind the memory to 591 # 592 # @policy: the NUMA policy (default: 'default') 593 # 594 # @prealloc: if true, preallocate memory (default: false) 595 # 596 # @prealloc-threads: number of CPU threads to use for prealloc 597 # (default: 1) 598 # 599 # @prealloc-context: thread context to use for creation of 600 # preallocation threads (default: none) (since 7.2) 601 # 602 # @share: if false, the memory is private to QEMU; if true, it is 603 # shared (default: false) 604 # 605 # @reserve: if true, reserve swap space (or huge pages) if applicable 606 # (default: true) (since 6.1) 607 # 608 # @size: size of the memory region in bytes 609 # 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) 614 # 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. 621 # 622 # Since: 2.1 623 ## 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' } } 636 637 ## 638 # @MemoryBackendFileProperties: 639 # 640 # Properties for memory-backend-file objects. 641 # 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) 649 # 650 # @offset: the offset into the target file that the region starts at. You 651 # can use this option to back multiple regions with a single file. Must 652 # be a multiple of the page size. (default: 0) (since 8.1) 653 # 654 # @discard-data: if true, the file contents can be destroyed when QEMU 655 # exits, to avoid unnecessarily flushing data to the backing file. 656 # Note that @discard-data is only an optimization, and QEMU might 657 # not discard file contents if it aborts unexpectedly or is 658 # terminated using SIGKILL. (default: false) 659 # 660 # @mem-path: the path to either a shared memory or huge page 661 # filesystem mount 662 # 663 # @pmem: specifies whether the backing file specified by @mem-path is 664 # in host persistent memory that can be accessed using the SNIA 665 # NVM programming model (e.g. Intel NVDIMM). 666 # 667 # @readonly: if true, the backing file is opened read-only; if false, 668 # it is opened read-write. (default: false) 669 # 670 # Since: 2.1 671 ## 672 { 'struct': 'MemoryBackendFileProperties', 673 'base': 'MemoryBackendProperties', 674 'data': { '*align': 'size', 675 '*offset': 'size', 676 '*discard-data': 'bool', 677 'mem-path': 'str', 678 '*pmem': { 'type': 'bool', 'if': 'CONFIG_LIBPMEM' }, 679 '*readonly': 'bool' } } 680 681 ## 682 # @MemoryBackendMemfdProperties: 683 # 684 # Properties for memory-backend-memfd objects. 685 # 686 # The @share boolean option is true by default with memfd. 687 # 688 # @hugetlb: if true, the file to be created resides in the hugetlbfs 689 # filesystem (default: false) 690 # 691 # @hugetlbsize: the hugetlb page size on systems that support multiple 692 # hugetlb page sizes (it must be a power of 2 value supported by 693 # the system). 0 selects a default page size. This option is 694 # ignored if @hugetlb is false. (default: 0) 695 # 696 # @seal: if true, create a sealed-file, which will block further 697 # resizing of the memory (default: true) 698 # 699 # Since: 2.12 700 ## 701 { 'struct': 'MemoryBackendMemfdProperties', 702 'base': 'MemoryBackendProperties', 703 'data': { '*hugetlb': 'bool', 704 '*hugetlbsize': 'size', 705 '*seal': 'bool' } } 706 707 ## 708 # @MemoryBackendEpcProperties: 709 # 710 # Properties for memory-backend-epc objects. 711 # 712 # The @share boolean option is true by default with epc 713 # 714 # The @merge boolean option is false by default with epc 715 # 716 # The @dump boolean option is false by default with epc 717 # 718 # Since: 6.2 719 ## 720 { 'struct': 'MemoryBackendEpcProperties', 721 'base': 'MemoryBackendProperties', 722 'data': {} } 723 724 ## 725 # @PrManagerHelperProperties: 726 # 727 # Properties for pr-manager-helper objects. 728 # 729 # @path: the path to a Unix domain socket for connecting to the 730 # external helper 731 # 732 # Since: 2.11 733 ## 734 { 'struct': 'PrManagerHelperProperties', 735 'data': { 'path': 'str' } } 736 737 ## 738 # @QtestProperties: 739 # 740 # Properties for qtest objects. 741 # 742 # @chardev: the chardev to be used to receive qtest commands on. 743 # 744 # @log: the path to a log file 745 # 746 # Since: 6.0 747 ## 748 { 'struct': 'QtestProperties', 749 'data': { 'chardev': 'str', 750 '*log': 'str' } } 751 752 ## 753 # @RemoteObjectProperties: 754 # 755 # Properties for x-remote-object objects. 756 # 757 # @fd: file descriptor name previously passed via 'getfd' command 758 # 759 # @devid: the id of the device to be associated with the file 760 # descriptor 761 # 762 # Since: 6.0 763 ## 764 { 'struct': 'RemoteObjectProperties', 765 'data': { 'fd': 'str', 'devid': 'str' } } 766 767 ## 768 # @VfioUserServerProperties: 769 # 770 # Properties for x-vfio-user-server objects. 771 # 772 # @socket: socket to be used by the libvfio-user library 773 # 774 # @device: the ID of the device to be emulated at the server 775 # 776 # Since: 7.1 777 ## 778 { 'struct': 'VfioUserServerProperties', 779 'data': { 'socket': 'SocketAddress', 'device': 'str' } } 780 781 ## 782 # @RngProperties: 783 # 784 # Properties for objects of classes derived from rng. 785 # 786 # @opened: if true, the device is opened immediately when applying 787 # this option and will probably fail when processing the next 788 # option. Don't use; only provided for compatibility. 789 # (default: false) 790 # 791 # Features: 792 # 793 # @deprecated: Member @opened is deprecated. Setting true doesn't 794 # make sense, and false is already the default. 795 # 796 # Since: 1.3 797 ## 798 { 'struct': 'RngProperties', 799 'data': { '*opened': { 'type': 'bool', 'features': ['deprecated'] } } } 800 801 ## 802 # @RngEgdProperties: 803 # 804 # Properties for rng-egd objects. 805 # 806 # @chardev: the name of a character device backend that provides the 807 # connection to the RNG daemon 808 # 809 # Since: 1.3 810 ## 811 { 'struct': 'RngEgdProperties', 812 'base': 'RngProperties', 813 'data': { 'chardev': 'str' } } 814 815 ## 816 # @RngRandomProperties: 817 # 818 # Properties for rng-random objects. 819 # 820 # @filename: the filename of the device on the host to obtain entropy 821 # from (default: "/dev/urandom") 822 # 823 # Since: 1.3 824 ## 825 { 'struct': 'RngRandomProperties', 826 'base': 'RngProperties', 827 'data': { '*filename': 'str' } } 828 829 ## 830 # @SevGuestProperties: 831 # 832 # Properties for sev-guest objects. 833 # 834 # @sev-device: SEV device to use (default: "/dev/sev") 835 # 836 # @dh-cert-file: guest owners DH certificate (encoded with base64) 837 # 838 # @session-file: guest owners session parameters (encoded with base64) 839 # 840 # @policy: SEV policy value (default: 0x1) 841 # 842 # @handle: SEV firmware handle (default: 0) 843 # 844 # @cbitpos: C-bit location in page table entry (default: 0) 845 # 846 # @reduced-phys-bits: number of bits in physical addresses that become 847 # unavailable when SEV is enabled 848 # 849 # @kernel-hashes: if true, add hashes of kernel/initrd/cmdline to a 850 # designated guest firmware page for measured boot with -kernel 851 # (default: false) (since 6.2) 852 # 853 # Since: 2.12 854 ## 855 { 'struct': 'SevGuestProperties', 856 'data': { '*sev-device': 'str', 857 '*dh-cert-file': 'str', 858 '*session-file': 'str', 859 '*policy': 'uint32', 860 '*handle': 'uint32', 861 '*cbitpos': 'uint32', 862 'reduced-phys-bits': 'uint32', 863 '*kernel-hashes': 'bool' } } 864 865 ## 866 # @ThreadContextProperties: 867 # 868 # Properties for thread context objects. 869 # 870 # @cpu-affinity: the list of host CPU numbers used as CPU affinity for 871 # all threads created in the thread context (default: QEMU main 872 # thread CPU affinity) 873 # 874 # @node-affinity: the list of host node numbers that will be resolved 875 # to a list of host CPU numbers used as CPU affinity. This is a 876 # shortcut for specifying the list of host CPU numbers belonging 877 # to the host nodes manually by setting @cpu-affinity. 878 # (default: QEMU main thread affinity) 879 # 880 # Since: 7.2 881 ## 882 { 'struct': 'ThreadContextProperties', 883 'data': { '*cpu-affinity': ['uint16'], 884 '*node-affinity': ['uint16'] } } 885 886 887 ## 888 # @ObjectType: 889 # 890 # Features: 891 # 892 # @unstable: Member @x-remote-object is experimental. 893 # 894 # Since: 6.0 895 ## 896 { 'enum': 'ObjectType', 897 'data': [ 898 'authz-list', 899 'authz-listfile', 900 'authz-pam', 901 'authz-simple', 902 'can-bus', 903 { 'name': 'can-host-socketcan', 904 'if': 'CONFIG_LINUX' }, 905 'colo-compare', 906 'cryptodev-backend', 907 'cryptodev-backend-builtin', 908 'cryptodev-backend-lkcf', 909 { 'name': 'cryptodev-vhost-user', 910 'if': 'CONFIG_VHOST_CRYPTO' }, 911 'dbus-vmstate', 912 'filter-buffer', 913 'filter-dump', 914 'filter-mirror', 915 'filter-redirector', 916 'filter-replay', 917 'filter-rewriter', 918 'input-barrier', 919 { 'name': 'input-linux', 920 'if': 'CONFIG_LINUX' }, 921 'iothread', 922 'main-loop', 923 { 'name': 'memory-backend-epc', 924 'if': 'CONFIG_LINUX' }, 925 'memory-backend-file', 926 { 'name': 'memory-backend-memfd', 927 'if': 'CONFIG_LINUX' }, 928 'memory-backend-ram', 929 'pef-guest', 930 { 'name': 'pr-manager-helper', 931 'if': 'CONFIG_LINUX' }, 932 'qtest', 933 'rng-builtin', 934 'rng-egd', 935 { 'name': 'rng-random', 936 'if': 'CONFIG_POSIX' }, 937 'secret', 938 { 'name': 'secret_keyring', 939 'if': 'CONFIG_SECRET_KEYRING' }, 940 'sev-guest', 941 'thread-context', 942 's390-pv-guest', 943 'throttle-group', 944 'tls-creds-anon', 945 'tls-creds-psk', 946 'tls-creds-x509', 947 'tls-cipher-suites', 948 { 'name': 'x-remote-object', 'features': [ 'unstable' ] }, 949 { 'name': 'x-vfio-user-server', 'features': [ 'unstable' ] } 950 ] } 951 952 ## 953 # @ObjectOptions: 954 # 955 # Describes the options of a user creatable QOM object. 956 # 957 # @qom-type: the class name for the object to be created 958 # 959 # @id: the name of the new object 960 # 961 # Since: 6.0 962 ## 963 { 'union': 'ObjectOptions', 964 'base': { 'qom-type': 'ObjectType', 965 'id': 'str' }, 966 'discriminator': 'qom-type', 967 'data': { 968 'authz-list': 'AuthZListProperties', 969 'authz-listfile': 'AuthZListFileProperties', 970 'authz-pam': 'AuthZPAMProperties', 971 'authz-simple': 'AuthZSimpleProperties', 972 'can-host-socketcan': { 'type': 'CanHostSocketcanProperties', 973 'if': 'CONFIG_LINUX' }, 974 'colo-compare': 'ColoCompareProperties', 975 'cryptodev-backend': 'CryptodevBackendProperties', 976 'cryptodev-backend-builtin': 'CryptodevBackendProperties', 977 'cryptodev-backend-lkcf': 'CryptodevBackendProperties', 978 'cryptodev-vhost-user': { 'type': 'CryptodevVhostUserProperties', 979 'if': 'CONFIG_VHOST_CRYPTO' }, 980 'dbus-vmstate': 'DBusVMStateProperties', 981 'filter-buffer': 'FilterBufferProperties', 982 'filter-dump': 'FilterDumpProperties', 983 'filter-mirror': 'FilterMirrorProperties', 984 'filter-redirector': 'FilterRedirectorProperties', 985 'filter-replay': 'NetfilterProperties', 986 'filter-rewriter': 'FilterRewriterProperties', 987 'input-barrier': 'InputBarrierProperties', 988 'input-linux': { 'type': 'InputLinuxProperties', 989 'if': 'CONFIG_LINUX' }, 990 'iothread': 'IothreadProperties', 991 'main-loop': 'MainLoopProperties', 992 'memory-backend-epc': { 'type': 'MemoryBackendEpcProperties', 993 'if': 'CONFIG_LINUX' }, 994 'memory-backend-file': 'MemoryBackendFileProperties', 995 'memory-backend-memfd': { 'type': 'MemoryBackendMemfdProperties', 996 'if': 'CONFIG_LINUX' }, 997 'memory-backend-ram': 'MemoryBackendProperties', 998 'pr-manager-helper': { 'type': 'PrManagerHelperProperties', 999 'if': 'CONFIG_LINUX' }, 1000 'qtest': 'QtestProperties', 1001 'rng-builtin': 'RngProperties', 1002 'rng-egd': 'RngEgdProperties', 1003 'rng-random': { 'type': 'RngRandomProperties', 1004 'if': 'CONFIG_POSIX' }, 1005 'secret': 'SecretProperties', 1006 'secret_keyring': { 'type': 'SecretKeyringProperties', 1007 'if': 'CONFIG_SECRET_KEYRING' }, 1008 'sev-guest': 'SevGuestProperties', 1009 'thread-context': 'ThreadContextProperties', 1010 'throttle-group': 'ThrottleGroupProperties', 1011 'tls-creds-anon': 'TlsCredsAnonProperties', 1012 'tls-creds-psk': 'TlsCredsPskProperties', 1013 'tls-creds-x509': 'TlsCredsX509Properties', 1014 'tls-cipher-suites': 'TlsCredsProperties', 1015 'x-remote-object': 'RemoteObjectProperties', 1016 'x-vfio-user-server': 'VfioUserServerProperties' 1017 } } 1018 1019 ## 1020 # @object-add: 1021 # 1022 # Create a QOM object. 1023 # 1024 # Returns: Nothing on success Error if @qom-type is not a valid class 1025 # name 1026 # 1027 # Since: 2.0 1028 # 1029 # Example: 1030 # 1031 # -> { "execute": "object-add", 1032 # "arguments": { "qom-type": "rng-random", "id": "rng1", 1033 # "filename": "/dev/hwrng" } } 1034 # <- { "return": {} } 1035 ## 1036 { 'command': 'object-add', 'data': 'ObjectOptions', 'boxed': true, 1037 'allow-preconfig': true } 1038 1039 ## 1040 # @object-del: 1041 # 1042 # Remove a QOM object. 1043 # 1044 # @id: the name of the QOM object to remove 1045 # 1046 # Returns: Nothing on success Error if @id is not a valid id for a QOM 1047 # object 1048 # 1049 # Since: 2.0 1050 # 1051 # Example: 1052 # 1053 # -> { "execute": "object-del", "arguments": { "id": "rng1" } } 1054 # <- { "return": {} } 1055 ## 1056 { 'command': 'object-del', 'data': {'id': 'str'}, 1057 'allow-preconfig': true } 1058