~ubuntu-branches/ubuntu/saucy/qemu/saucy

« back to all changes in this revision

Viewing changes to qmp-commands.hx

  • Committer: Package Import Robot
  • Author(s): Serge Hallyn
  • Date: 2013-05-28 08:18:30 UTC
  • mfrom: (1.8.2) (10.1.37 sid)
  • Revision ID: package-import@ubuntu.com-20130528081830-87xl2z9fq516a814
Tags: 1.5.0+dfsg-2ubuntu1
* Merge 1.5.0+dfs-2 from debian unstable.  Remaining changes:
  - debian/control
    * update maintainer
    * remove libiscsi, usb-redir, vde, vnc-jpeg, and libssh2-1-dev
      from build-deps
    * enable rbd
    * add qemu-system and qemu-common B/R to qemu-keymaps
    * add D:udev, R:qemu, R:qemu-common and B:qemu-common to
      qemu-system-common
    * qemu-system-arm, qemu-system-ppc, qemu-system-sparc:
      - add qemu-kvm to Provides
      - add qemu-common, qemu-kvm, kvm to B/R
      - remove openbios-sparc from qemu-system-sparc D
    * qemu-system-x86:
      - add qemu-common to Breaks/Replaces.
      - add cpu-checker to Recommends.
    * qemu-user: add B/R:qemu-kvm
    * qemu-kvm:
      - add armhf armel powerpc sparc to Architecture
      - C/R/P: qemu-kvm-spice
    * add qemu-common package
    * drop qemu-slof which is not packaged in ubuntu
  - add qemu-system-common.links for tap ifup/down scripts and OVMF link.
  - qemu-system-x86.links:
    * remove pxe rom links which are in kvm-ipxe
    * add symlink for kvm.1 manpage
  - debian/rules
    * add kvm-spice symlink to qemu-kvm
    * call dh_installmodules for qemu-system-x86
    * update dh_installinit to install upstart script
    * run dh_installman (Closes: #709241) (cherrypicked from 1.5.0+dfsg-2)
  - Add qemu-utils.links for kvm-* symlinks.
  - Add qemu-system-x86.qemu-kvm.upstart and .default
  - Add qemu-system-x86.modprobe to set nesting=1
  - Add qemu-system-common.preinst to add kvm group
  - qemu-system-common.postinst: remove bad group acl if there, then have
    udev relabel /dev/kvm.
  - Dropped patches:
    * 0001-fix-wrong-output-with-info-chardev-for-tcp-socket.patch
  - Kept patches:
    * expose_vms_qemu64cpu.patch - updated
    * gridcentric patch - updated
    * linaro arm patches from qemu-linaro rebasing branch

Show diffs side-by-side

added added

removed removed

Lines of Context:
168
168
 
169
169
    {
170
170
        .name       = "stop",
171
 
        .args_type  = "silent:b?",
172
 
        .params     = "[silent]",
173
 
        .help       = "stop emulation, optional silent for no event emission",
 
171
        .args_type  = "",
174
172
        .mhandler.cmd_new = qmp_marshal_input_stop,
175
173
    },
176
174
 
180
178
 
181
179
Stop the emulator.
182
180
 
183
 
Arguments:
184
 
 
185
 
- silent: do not emit stop event (json-bool, optional)
 
181
Arguments: None.
186
182
 
187
183
Example:
188
184
 
389
385
EQMP
390
386
 
391
387
    {
 
388
        .name       = "cpu-add",
 
389
        .args_type  = "id:i",
 
390
        .mhandler.cmd_new = qmp_marshal_input_cpu_add,
 
391
    },
 
392
 
 
393
SQMP
 
394
cpu-add
 
395
-------
 
396
 
 
397
Adds virtual cpu
 
398
 
 
399
Arguments:
 
400
 
 
401
- "id": cpu id (json-int)
 
402
 
 
403
Example:
 
404
 
 
405
-> { "execute": "cpu-add", "arguments": { "id": 2 } }
 
406
<- { "return": {} }
 
407
 
 
408
EQMP
 
409
 
 
410
    {
392
411
        .name       = "memsave",
393
412
        .args_type  = "val:l,size:i,filename:s,cpu:i?",
394
413
        .mhandler.cmd_new = qmp_marshal_input_memsave,
648
667
 
649
668
SQMP
650
669
migrate-set-cache-size
651
 
---------------------
 
670
----------------------
652
671
 
653
672
Set cache size to be used by XBZRLE migration, the cache size will be rounded
654
673
down to the nearest power of 2
671
690
 
672
691
SQMP
673
692
query-migrate-cache-size
674
 
---------------------
 
693
------------------------
675
694
 
676
695
Show cache size to be used by XBZRLE migration
677
696
 
826
845
-> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } }
827
846
<- { "return": {} }
828
847
 
829
 
Note: The supported device options are the same ones supported by the '-net'
 
848
Note: The supported device options are the same ones supported by the '-netdev'
830
849
      command-line argument, which are listed in the '-help' output or QEMU's
831
850
      manual
832
851
 
2420
2439
    },
2421
2440
 
2422
2441
SQMP
 
2442
query-command-line-options
 
2443
--------------------------
 
2444
 
 
2445
Show command line option schema.
 
2446
 
 
2447
Return a json-array of command line option schema for all options (or for
 
2448
the given option), returning an error if the given option doesn't exist.
 
2449
 
 
2450
Each array entry contains the following:
 
2451
 
 
2452
- "option": option name (json-string)
 
2453
- "parameters": a json-array describes all parameters of the option:
 
2454
    - "name": parameter name (json-string)
 
2455
    - "type": parameter type (one of 'string', 'boolean', 'number',
 
2456
              or 'size')
 
2457
    - "help": human readable description of the parameter
 
2458
              (json-string, optional)
 
2459
 
 
2460
Example:
 
2461
 
 
2462
-> { "execute": "query-command-line-options", "arguments": { "option": "option-rom" } }
 
2463
<- { "return": [
 
2464
        {
 
2465
            "parameters": [
 
2466
                {
 
2467
                    "name": "romfile",
 
2468
                    "type": "string"
 
2469
                },
 
2470
                {
 
2471
                    "name": "bootindex",
 
2472
                    "type": "number"
 
2473
                }
 
2474
            ],
 
2475
            "option": "option-rom"
 
2476
        }
 
2477
     ]
 
2478
   }
 
2479
 
 
2480
EQMP
 
2481
 
 
2482
    {
 
2483
        .name       = "query-command-line-options",
 
2484
        .args_type  = "option:s?",
 
2485
        .mhandler.cmd_new = qmp_marshal_input_query_command_line_options,
 
2486
    },
 
2487
 
 
2488
SQMP
2423
2489
query-migrate
2424
2490
-------------
2425
2491
 
2435
2501
     - Possible values: "active", "completed", "failed", "cancelled"
2436
2502
- "total-time": total amount of ms since migration started.  If
2437
2503
                migration has ended, it returns the total migration
2438
 
                 time (json-int)
 
2504
                time (json-int)
2439
2505
- "downtime": only present when migration has finished correctly
2440
2506
              total amount in ms for downtime that happened (json-int)
2441
2507
- "expected-downtime": only present while migration is active
2442
2508
                total amount in ms for downtime that was calculated on
2443
 
                the last bitmap round (json-int)
 
2509
                the last bitmap round (json-int)
2444
2510
- "ram": only present if "status" is "active", it is a json-object with the
2445
 
  following RAM information (in bytes):
2446
 
         - "transferred": amount transferred (json-int)
2447
 
         - "remaining": amount remaining (json-int)
2448
 
         - "total": total (json-int)
2449
 
         - "duplicate": number of duplicated pages (json-int)
2450
 
         - "normal" : number of normal pages transferred (json-int)
2451
 
         - "normal-bytes" : number of normal bytes transferred (json-int)
 
2511
  following RAM information:
 
2512
         - "transferred": amount transferred in bytes (json-int)
 
2513
         - "remaining": amount remaining to transfer in bytes (json-int)
 
2514
         - "total": total amount of memory in bytes (json-int)
 
2515
         - "duplicate": number of pages filled entirely with the same
 
2516
            byte (json-int)
 
2517
            These are sent over the wire much more efficiently.
 
2518
         - "skipped": number of skipped zero pages (json-int)
 
2519
         - "normal" : number of whole pages transferred.  I.e. they
 
2520
            were not sent as duplicate or xbzrle pages (json-int)
 
2521
         - "normal-bytes" : number of bytes transferred in whole
 
2522
            pages. This is just normal pages times size of one page,
 
2523
            but this way upper levels don't need to care about page
 
2524
            size (json-int)
2452
2525
- "disk": only present if "status" is "active" and it is a block migration,
2453
 
  it is a json-object with the following disk information (in bytes):
2454
 
         - "transferred": amount transferred (json-int)
2455
 
         - "remaining": amount remaining (json-int)
2456
 
         - "total": total (json-int)
 
2526
  it is a json-object with the following disk information:
 
2527
         - "transferred": amount transferred in bytes (json-int)
 
2528
         - "remaining": amount remaining to transfer in bytes json-int)
 
2529
         - "total": total disk size in bytes (json-int)
2457
2530
- "xbzrle-cache": only present if XBZRLE is active.
2458
2531
  It is a json-object with the following XBZRLE information:
2459
 
         - "cache-size": XBZRLE cache size
2460
 
         - "bytes": total XBZRLE bytes transferred
 
2532
         - "cache-size": XBZRLE cache size in bytes
 
2533
         - "bytes": number of bytes transferred for XBZRLE compressed pages
2461
2534
         - "pages": number of XBZRLE compressed pages
2462
 
         - "cache-miss": number of cache misses
2463
 
         - "overflow": number of XBZRLE overflows
 
2535
         - "cache-miss": number of XBRZRLE page cache misses
 
2536
         - "overflow": number of times XBZRLE overflows.  This means
 
2537
           that the XBZRLE encoding was bigger than just sent the
 
2538
           whole page, and then we sent the whole page instead (as as
 
2539
           normal page).
 
2540
 
2464
2541
Examples:
2465
2542
 
2466
2543
1. Before the first migration
2571
2648
 
2572
2649
SQMP
2573
2650
migrate-set-capabilities
2574
 
-------
 
2651
------------------------
2575
2652
 
2576
2653
Enable/Disable migration capabilities
2577
2654
 
2578
 
- "xbzrle": xbzrle support
 
2655
- "xbzrle": XBZRLE support
2579
2656
 
2580
2657
Arguments:
2581
2658
 
2594
2671
    },
2595
2672
SQMP
2596
2673
query-migrate-capabilities
2597
 
-------
 
2674
--------------------------
2598
2675
 
2599
2676
Query current migration capabilities
2600
2677
 
2720
2797
    },
2721
2798
 
2722
2799
    {
 
2800
        .name       = "query-tpm",
 
2801
        .args_type  = "",
 
2802
        .mhandler.cmd_new = qmp_marshal_input_query_tpm,
 
2803
    },
 
2804
 
 
2805
SQMP
 
2806
query-tpm
 
2807
---------
 
2808
 
 
2809
Return information about the TPM device.
 
2810
 
 
2811
Arguments: None
 
2812
 
 
2813
Example:
 
2814
 
 
2815
-> { "execute": "query-tpm" }
 
2816
<- { "return":
 
2817
     [
 
2818
       { "model": "tpm-tis",
 
2819
         "options":
 
2820
           { "type": "passthrough",
 
2821
             "data":
 
2822
               { "cancel-path": "/sys/class/misc/tpm0/device/cancel",
 
2823
                 "path": "/dev/tpm0"
 
2824
               }
 
2825
           },
 
2826
         "id": "tpm0"
 
2827
       }
 
2828
     ]
 
2829
   }
 
2830
 
 
2831
EQMP
 
2832
 
 
2833
    {
 
2834
        .name       = "query-tpm-models",
 
2835
        .args_type  = "",
 
2836
        .mhandler.cmd_new = qmp_marshal_input_query_tpm_models,
 
2837
    },
 
2838
 
 
2839
SQMP
 
2840
query-tpm-models
 
2841
----------------
 
2842
 
 
2843
Return a list of supported TPM models.
 
2844
 
 
2845
Arguments: None
 
2846
 
 
2847
Example:
 
2848
 
 
2849
-> { "execute": "query-tpm-models" }
 
2850
<- { "return": [ "tpm-tis" ] }
 
2851
 
 
2852
EQMP
 
2853
 
 
2854
    {
 
2855
        .name       = "query-tpm-types",
 
2856
        .args_type  = "",
 
2857
        .mhandler.cmd_new = qmp_marshal_input_query_tpm_types,
 
2858
    },
 
2859
 
 
2860
SQMP
 
2861
query-tpm-types
 
2862
---------------
 
2863
 
 
2864
Return a list of supported TPM types.
 
2865
 
 
2866
Arguments: None
 
2867
 
 
2868
Example:
 
2869
 
 
2870
-> { "execute": "query-tpm-types" }
 
2871
<- { "return": [ "passthrough" ] }
 
2872
 
 
2873
EQMP
 
2874
 
 
2875
    {
2723
2876
        .name       = "chardev-add",
2724
2877
        .args_type  = "id:s,backend:q",
2725
2878
        .mhandler.cmd_new = qmp_marshal_input_chardev_add,