hmp-commands.hx

   1 HXCOMM Use DEFHEADING() to define headings in both help text and texi
   2 HXCOMM Text between STEXI and ETEXI are copied to texi version and
   3 HXCOMM discarded from C version
   4 HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
   5 HXCOMM monitor commands
   6 HXCOMM HXCOMM can be used for comments, discarded from both texi and C
   7
   8 STEXI
   9 @table @option
  10 ETEXI
  11
  12     {
  13         .name       = "help|?",
  14         .args_type  = "name:s?",
  15         .params     = "[cmd]",
  16         .help       = "show the help",
  17         .mhandler.cmd = do_help_cmd,
  18     },
  19
  20 STEXI
  21 @item help or ? [@var{cmd}]
  22 @findex help
  23 Show the help for all commands or just for command @var{cmd}.
  24 ETEXI
  25
  26     {
  27         .name       = "commit",
  28         .args_type  = "device:B",
  29         .params     = "device|all",
  30         .help       = "commit changes to the disk images (if -snapshot is used) or backing files",
  31         .mhandler.cmd = do_commit,
  32     },
  33
  34 STEXI
  35 @item commit
  36 @findex commit
  37 Commit changes to the disk images (if -snapshot is used) or backing files.
  38 ETEXI
  39
  40     {
  41         .name       = "q|quit",
  42         .args_type  = "",
  43         .params     = "",
  44         .help       = "quit the emulator",
  45         .user_print = monitor_user_noop,
  46         .mhandler.cmd = hmp_quit,
  47     },
  48
  49 STEXI
  50 @item q or quit
  51 @findex quit
  52 Quit the emulator.
  53 ETEXI
  54
  55     {
  56         .name       = "block_resize",
  57         .args_type  = "device:B,size:o",
  58         .params     = "device size",
  59         .help       = "resize a block image",
  60         .mhandler.cmd = hmp_block_resize,
  61     },
  62
  63 STEXI
  64 @item block_resize
  65 @findex block_resize
  66 Resize a block image while a guest is running.  Usually requires guest
  67 action to see the updated size.  Resize to a lower size is supported,
  68 but should be used with extreme caution.  Note that this command only
  69 resizes image files, it can not resize block devices like LVM volumes.
  70 ETEXI
  71
  72     {
  73         .name       = "block_stream",
  74         .args_type  = "device:B,base:s?",
  75         .params     = "device [base]",
  76         .help       = "copy data from a backing file into a block device",
  77         .mhandler.cmd = hmp_block_stream,
  78     },
  79
  80 STEXI
  81 @item block_stream
  82 @findex block_stream
  83 Copy data from a backing file into a block device.
  84 ETEXI
  85
  86     {
  87         .name       = "block_job_set_speed",
  88         .args_type  = "device:B,value:o",
  89         .params     = "device value",
  90         .help       = "set maximum speed for a background block operation",
  91         .mhandler.cmd = hmp_block_job_set_speed,
  92     },
  93
  94 STEXI
  95 @item block_job_set_stream
  96 @findex block_job_set_stream
  97 Set maximum speed for a background block operation.
  98 ETEXI
  99
 100     {
 101         .name       = "block_job_cancel",
 102         .args_type  = "device:B",
 103         .params     = "device",
 104         .help       = "stop an active block streaming operation",
 105         .mhandler.cmd = hmp_block_job_cancel,
 106     },
 107
 108 STEXI
 109 @item block_job_cancel
 110 @findex block_job_cancel
 111 Stop an active block streaming operation.
 112 ETEXI
 113
 114     {
 115         .name       = "eject",
 116         .args_type  = "force:-f,device:B",
 117         .params     = "[-f] device",
 118         .help       = "eject a removable medium (use -f to force it)",
 119         .mhandler.cmd = hmp_eject,
 120     },
 121
 122 STEXI
 123 @item eject [-f] @var{device}
 124 @findex eject
 125 Eject a removable medium (use -f to force it).
 126 ETEXI
 127
 128     {
 129         .name       = "drive_del",
 130         .args_type  = "id:s",
 131         .params     = "device",
 132         .help       = "remove host block device",
 133         .user_print = monitor_user_noop,
 134         .mhandler.cmd_new = do_drive_del,
 135     },
 136
 137 STEXI
 138 @item drive_del @var{device}
 139 @findex drive_del
 140 Remove host block device.  The result is that guest generated IO is no longer
 141 submitted against the host device underlying the disk.  Once a drive has
 142 been deleted, the QEMU Block layer returns -EIO which results in IO
 143 errors in the guest for applications that are reading/writing to the device.
 144 ETEXI
 145
 146     {
 147         .name       = "change",
 148         .args_type  = "device:B,target:F,arg:s?",
 149         .params     = "device filename [format]",
 150         .help       = "change a removable medium, optional format",
 151         .mhandler.cmd = hmp_change,
 152     },
 153
 154 STEXI
 155 @item change @var{device} @var{setting}
 156 @findex change
 157
 158 Change the configuration of a device.
 159
 160 @table @option
 161 @item change @var{diskdevice} @var{filename} [@var{format}]
 162 Change the medium for a removable disk device to point to @var{filename}. eg
 163
 164 @example
 165 (qemu) change ide1-cd0 /path/to/some.iso
 166 @end example
 167
 168 @var{format} is optional.
 169
 170 @item change vnc @var{display},@var{options}
 171 Change the configuration of the VNC server. The valid syntax for @var{display}
 172 and @var{options} are described at @ref{sec_invocation}. eg
 173
 174 @example
 175 (qemu) change vnc localhost:1
 176 @end example
 177
 178 @item change vnc password [@var{password}]
 179
 180 Change the password associated with the VNC server. If the new password is not
 181 supplied, the monitor will prompt for it to be entered. VNC passwords are only
 182 significant up to 8 letters. eg
 183
 184 @example
 185 (qemu) change vnc password
 186 Password: ********
 187 @end example
 188
 189 @end table
 190 ETEXI
 191
 192     {
 193         .name       = "screendump",
 194         .args_type  = "filename:F",
 195         .params     = "filename",
 196         .help       = "save screen into PPM image 'filename'",
 197         .user_print = monitor_user_noop,
 198         .mhandler.cmd_new = do_screen_dump,
 199     },
 200
 201 STEXI
 202 @item screendump @var{filename}
 203 @findex screendump
 204 Save screen into PPM image @var{filename}.
 205 ETEXI
 206
 207     {
 208         .name       = "logfile",
 209         .args_type  = "filename:F",
 210         .params     = "filename",
 211         .help       = "output logs to 'filename'",
 212         .mhandler.cmd = do_logfile,
 213     },
 214
 215 STEXI
 216 @item logfile @var{filename}
 217 @findex logfile
 218 Output logs to @var{filename}.
 219 ETEXI
 220
 221     {
 222         .name       = "trace-event",
 223         .args_type  = "name:s,option:b",
 224         .params     = "name on|off",
 225         .help       = "changes status of a specific trace event",
 226         .mhandler.cmd = do_trace_event_set_state,
 227     },
 228
 229 STEXI
 230 @item trace-event
 231 @findex trace-event
 232 changes status of a trace event
 233 ETEXI
 234
 235 #if defined(CONFIG_TRACE_SIMPLE)
 236     {
 237         .name       = "trace-file",
 238         .args_type  = "op:s?,arg:F?",
 239         .params     = "on|off|flush|set [arg]",
 240         .help       = "open, close, or flush trace file, or set a new file name",
 241         .mhandler.cmd = do_trace_file,
 242     },
 243
 244 STEXI
 245 @item trace-file on|off|flush
 246 @findex trace-file
 247 Open, close, or flush the trace file.  If no argument is given, the status of the trace file is displayed.
 248 ETEXI
 249 #endif
 250
 251     {
 252         .name       = "log",
 253         .args_type  = "items:s",
 254         .params     = "item1[,...]",
 255         .help       = "activate logging of the specified items to '/tmp/qemu.log'",
 256         .mhandler.cmd = do_log,
 257     },
 258
 259 STEXI
 260 @item log @var{item1}[,...]
 261 @findex log
 262 Activate logging of the specified items to @file{/tmp/qemu.log}.
 263 ETEXI
 264
 265     {
 266         .name       = "savevm",
 267         .args_type  = "name:s?",
 268         .params     = "[tag|id]",
 269         .help       = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
 270         .mhandler.cmd = do_savevm,
 271     },
 272
 273 STEXI
 274 @item savevm [@var{tag}|@var{id}]
 275 @findex savevm
 276 Create a snapshot of the whole virtual machine. If @var{tag} is
 277 provided, it is used as human readable identifier. If there is already
 278 a snapshot with the same tag or ID, it is replaced. More info at
 279 @ref{vm_snapshots}.
 280 ETEXI
 281
 282     {
 283         .name       = "loadvm",
 284         .args_type  = "name:s",
 285         .params     = "tag|id",
 286         .help       = "restore a VM snapshot from its tag or id",
 287         .mhandler.cmd = do_loadvm,
 288     },
 289
 290 STEXI
 291 @item loadvm @var{tag}|@var{id}
 292 @findex loadvm
 293 Set the whole virtual machine to the snapshot identified by the tag
 294 @var{tag} or the unique snapshot ID @var{id}.
 295 ETEXI
 296
 297     {
 298         .name       = "delvm",
 299         .args_type  = "name:s",
 300         .params     = "tag|id",
 301         .help       = "delete a VM snapshot from its tag or id",
 302         .mhandler.cmd = do_delvm,
 303     },
 304
 305 STEXI
 306 @item delvm @var{tag}|@var{id}
 307 @findex delvm
 308 Delete the snapshot identified by @var{tag} or @var{id}.
 309 ETEXI
 310
 311     {
 312         .name       = "singlestep",
 313         .args_type  = "option:s?",
 314         .params     = "[on|off]",
 315         .help       = "run emulation in singlestep mode or switch to normal mode",
 316         .mhandler.cmd = do_singlestep,
 317     },
 318
 319 STEXI
 320 @item singlestep [off]
 321 @findex singlestep
 322 Run the emulation in single step mode.
 323 If called with option off, the emulation returns to normal mode.
 324 ETEXI
 325
 326     {
 327         .name       = "stop",
 328         .args_type  = "",
 329         .params     = "",
 330         .help       = "stop emulation",
 331         .mhandler.cmd = hmp_stop,
 332     },
 333
 334 STEXI
 335 @item stop
 336 @findex stop
 337 Stop emulation.
 338 ETEXI
 339
 340     {
 341         .name       = "c|cont",
 342         .args_type  = "",
 343         .params     = "",
 344         .help       = "resume emulation",
 345         .mhandler.cmd = hmp_cont,
 346     },
 347
 348 STEXI
 349 @item c or cont
 350 @findex cont
 351 Resume emulation.
 352 ETEXI
 353
 354     {
 355         .name       = "system_wakeup",
 356         .args_type  = "",
 357         .params     = "",
 358         .help       = "wakeup guest from suspend",
 359         .mhandler.cmd = hmp_system_wakeup,
 360     },
 361
 362 STEXI
 363 @item system_wakeup
 364 @findex system_wakeup
 365 Wakeup guest from suspend.
 366 ETEXI
 367
 368     {
 369         .name       = "gdbserver",
 370         .args_type  = "device:s?",
 371         .params     = "[device]",
 372         .help       = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
 373         .mhandler.cmd = do_gdbserver,
 374     },
 375
 376 STEXI
 377 @item gdbserver [@var{port}]
 378 @findex gdbserver
 379 Start gdbserver session (default @var{port}=1234)
 380 ETEXI
 381
 382     {
 383         .name       = "x",
 384         .args_type  = "fmt:/,addr:l",
 385         .params     = "/fmt addr",
 386         .help       = "virtual memory dump starting at 'addr'",
 387         .mhandler.cmd = do_memory_dump,
 388     },
 389
 390 STEXI
 391 @item x/fmt @var{addr}
 392 @findex x
 393 Virtual memory dump starting at @var{addr}.
 394 ETEXI
 395
 396     {
 397         .name       = "xp",
 398         .args_type  = "fmt:/,addr:l",
 399         .params     = "/fmt addr",
 400         .help       = "physical memory dump starting at 'addr'",
 401         .mhandler.cmd = do_physical_memory_dump,
 402     },
 403
 404 STEXI
 405 @item xp /@var{fmt} @var{addr}
 406 @findex xp
 407 Physical memory dump starting at @var{addr}.
 408
 409 @var{fmt} is a format which tells the command how to format the
 410 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
 411
 412 @table @var
 413 @item count
 414 is the number of items to be dumped.
 415
 416 @item format
 417 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
 418 c (char) or i (asm instruction).
 419
 420 @item size
 421 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
 422 @code{h} or @code{w} can be specified with the @code{i} format to
 423 respectively select 16 or 32 bit code instruction size.
 424
 425 @end table
 426
 427 Examples:
 428 @itemize
 429 @item
 430 Dump 10 instructions at the current instruction pointer:
 431 @example
 432 (qemu) x/10i $eip
 433 0x90107063:  ret
 434 0x90107064:  sti
 435 0x90107065:  lea    0x0(%esi,1),%esi
 436 0x90107069:  lea    0x0(%edi,1),%edi
 437 0x90107070:  ret
 438 0x90107071:  jmp    0x90107080
 439 0x90107073:  nop
 440 0x90107074:  nop
 441 0x90107075:  nop
 442 0x90107076:  nop
 443 @end example
 444
 445 @item
 446 Dump 80 16 bit values at the start of the video memory.
 447 @smallexample
 448 (qemu) xp/80hx 0xb8000
 449 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
 450 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
 451 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
 452 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
 453 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
 454 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
 455 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 456 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 457 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 458 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 459 @end smallexample
 460 @end itemize
 461 ETEXI
 462
 463     {
 464         .name       = "p|print",
 465         .args_type  = "fmt:/,val:l",
 466         .params     = "/fmt expr",
 467         .help       = "print expression value (use $reg for CPU register access)",
 468         .mhandler.cmd = do_print,
 469     },
 470
 471 STEXI
 472 @item p or print/@var{fmt} @var{expr}
 473 @findex print
 474
 475 Print expression value. Only the @var{format} part of @var{fmt} is
 476 used.
 477 ETEXI
 478
 479     {
 480         .name       = "i",
 481         .args_type  = "fmt:/,addr:i,index:i.",
 482         .params     = "/fmt addr",
 483         .help       = "I/O port read",
 484         .mhandler.cmd = do_ioport_read,
 485     },
 486
 487 STEXI
 488 Read I/O port.
 489 ETEXI
 490
 491     {
 492         .name       = "o",
 493         .args_type  = "fmt:/,addr:i,val:i",
 494         .params     = "/fmt addr value",
 495         .help       = "I/O port write",
 496         .mhandler.cmd = do_ioport_write,
 497     },
 498
 499 STEXI
 500 Write to I/O port.
 501 ETEXI
 502
 503     {
 504         .name       = "sendkey",
 505         .args_type  = "string:s,hold_time:i?",
 506         .params     = "keys [hold_ms]",
 507         .help       = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
 508         .mhandler.cmd = do_sendkey,
 509     },
 510
 511 STEXI
 512 @item sendkey @var{keys}
 513 @findex sendkey
 514
 515 Send @var{keys} to the emulator. @var{keys} could be the name of the
 516 key or @code{#} followed by the raw value in either decimal or hexadecimal
 517 format. Use @code{-} to press several keys simultaneously. Example:
 518 @example
 519 sendkey ctrl-alt-f1
 520 @end example
 521
 522 This command is useful to send keys that your graphical user interface
 523 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
 524 ETEXI
 525
 526     {
 527         .name       = "system_reset",
 528         .args_type  = "",
 529         .params     = "",
 530         .help       = "reset the system",
 531         .mhandler.cmd = hmp_system_reset,
 532     },
 533
 534 STEXI
 535 @item system_reset
 536 @findex system_reset
 537
 538 Reset the system.
 539 ETEXI
 540
 541     {
 542         .name       = "system_powerdown",
 543         .args_type  = "",
 544         .params     = "",
 545         .help       = "send system power down event",
 546         .mhandler.cmd = hmp_system_powerdown,
 547     },
 548
 549 STEXI
 550 @item system_powerdown
 551 @findex system_powerdown
 552
 553 Power down the system (if supported).
 554 ETEXI
 555
 556     {
 557         .name       = "sum",
 558         .args_type  = "start:i,size:i",
 559         .params     = "addr size",
 560         .help       = "compute the checksum of a memory region",
 561         .mhandler.cmd = do_sum,
 562     },
 563
 564 STEXI
 565 @item sum @var{addr} @var{size}
 566 @findex sum
 567
 568 Compute the checksum of a memory region.
 569 ETEXI
 570
 571     {
 572         .name       = "usb_add",
 573         .args_type  = "devname:s",
 574         .params     = "device",
 575         .help       = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
 576         .mhandler.cmd = do_usb_add,
 577     },
 578
 579 STEXI
 580 @item usb_add @var{devname}
 581 @findex usb_add
 582
 583 Add the USB device @var{devname}.  For details of available devices see
 584 @ref{usb_devices}
 585 ETEXI
 586
 587     {
 588         .name       = "usb_del",
 589         .args_type  = "devname:s",
 590         .params     = "device",
 591         .help       = "remove USB device 'bus.addr'",
 592         .mhandler.cmd = do_usb_del,
 593     },
 594
 595 STEXI
 596 @item usb_del @var{devname}
 597 @findex usb_del
 598
 599 Remove the USB device @var{devname} from the QEMU virtual USB
 600 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
 601 command @code{info usb} to see the devices you can remove.
 602 ETEXI
 603
 604     {
 605         .name       = "device_add",
 606         .args_type  = "device:O",
 607         .params     = "driver[,prop=value][,...]",
 608         .help       = "add device, like -device on the command line",
 609         .user_print = monitor_user_noop,
 610         .mhandler.cmd_new = do_device_add,
 611     },
 612
 613 STEXI
 614 @item device_add @var{config}
 615 @findex device_add
 616
 617 Add device.
 618 ETEXI
 619
 620     {
 621         .name       = "device_del",
 622         .args_type  = "id:s",
 623         .params     = "device",
 624         .help       = "remove device",
 625         .user_print = monitor_user_noop,
 626         .mhandler.cmd_new = do_device_del,
 627     },
 628
 629 STEXI
 630 @item device_del @var{id}
 631 @findex device_del
 632
 633 Remove device @var{id}.
 634 ETEXI
 635
 636     {
 637         .name       = "cpu",
 638         .args_type  = "index:i",
 639         .params     = "index",
 640         .help       = "set the default CPU",
 641         .mhandler.cmd = hmp_cpu,
 642     },
 643
 644 STEXI
 645 @item cpu @var{index}
 646 @findex cpu
 647 Set the default CPU.
 648 ETEXI
 649
 650     {
 651         .name       = "mouse_move",
 652         .args_type  = "dx_str:s,dy_str:s,dz_str:s?",
 653         .params     = "dx dy [dz]",
 654         .help       = "send mouse move events",
 655         .mhandler.cmd = do_mouse_move,
 656     },
 657
 658 STEXI
 659 @item mouse_move @var{dx} @var{dy} [@var{dz}]
 660 @findex mouse_move
 661 Move the active mouse to the specified coordinates @var{dx} @var{dy}
 662 with optional scroll axis @var{dz}.
 663 ETEXI
 664
 665     {
 666         .name       = "mouse_button",
 667         .args_type  = "button_state:i",
 668         .params     = "state",
 669         .help       = "change mouse button state (1=L, 2=M, 4=R)",
 670         .mhandler.cmd = do_mouse_button,
 671     },
 672
 673 STEXI
 674 @item mouse_button @var{val}
 675 @findex mouse_button
 676 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
 677 ETEXI
 678
 679     {
 680         .name       = "mouse_set",
 681         .args_type  = "index:i",
 682         .params     = "index",
 683         .help       = "set which mouse device receives events",
 684         .mhandler.cmd = do_mouse_set,
 685     },
 686
 687 STEXI
 688 @item mouse_set @var{index}
 689 @findex mouse_set
 690 Set which mouse device receives events at given @var{index}, index
 691 can be obtained with
 692 @example
 693 info mice
 694 @end example
 695 ETEXI
 696
 697 #ifdef HAS_AUDIO
 698     {
 699         .name       = "wavcapture",
 700         .args_type  = "path:F,freq:i?,bits:i?,nchannels:i?",
 701         .params     = "path [frequency [bits [channels]]]",
 702         .help       = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
 703         .mhandler.cmd = do_wav_capture,
 704     },
 705 #endif
 706 STEXI
 707 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
 708 @findex wavcapture
 709 Capture audio into @var{filename}. Using sample rate @var{frequency}
 710 bits per sample @var{bits} and number of channels @var{channels}.
 711
 712 Defaults:
 713 @itemize @minus
 714 @item Sample rate = 44100 Hz - CD quality
 715 @item Bits = 16
 716 @item Number of channels = 2 - Stereo
 717 @end itemize
 718 ETEXI
 719
 720 #ifdef HAS_AUDIO
 721     {
 722         .name       = "stopcapture",
 723         .args_type  = "n:i",
 724         .params     = "capture index",
 725         .help       = "stop capture",
 726         .mhandler.cmd = do_stop_capture,
 727     },
 728 #endif
 729 STEXI
 730 @item stopcapture @var{index}
 731 @findex stopcapture
 732 Stop capture with a given @var{index}, index can be obtained with
 733 @example
 734 info capture
 735 @end example
 736 ETEXI
 737
 738     {
 739         .name       = "memsave",
 740         .args_type  = "val:l,size:i,filename:s",
 741         .params     = "addr size file",
 742         .help       = "save to disk virtual memory dump starting at 'addr' of size 'size'",
 743         .mhandler.cmd = hmp_memsave,
 744     },
 745
 746 STEXI
 747 @item memsave @var{addr} @var{size} @var{file}
 748 @findex memsave
 749 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
 750 ETEXI
 751
 752     {
 753         .name       = "pmemsave",
 754         .args_type  = "val:l,size:i,filename:s",
 755         .params     = "addr size file",
 756         .help       = "save to disk physical memory dump starting at 'addr' of size 'size'",
 757         .mhandler.cmd = hmp_pmemsave,
 758     },
 759
 760 STEXI
 761 @item pmemsave @var{addr} @var{size} @var{file}
 762 @findex pmemsave
 763 save to disk physical memory dump starting at @var{addr} of size @var{size}.
 764 ETEXI
 765
 766     {
 767         .name       = "boot_set",
 768         .args_type  = "bootdevice:s",
 769         .params     = "bootdevice",
 770         .help       = "define new values for the boot device list",
 771         .mhandler.cmd = do_boot_set,
 772     },
 773
 774 STEXI
 775 @item boot_set @var{bootdevicelist}
 776 @findex boot_set
 777
 778 Define new values for the boot device list. Those values will override
 779 the values specified on the command line through the @code{-boot} option.
 780
 781 The values that can be specified here depend on the machine type, but are
 782 the same that can be specified in the @code{-boot} command line option.
 783 ETEXI
 784
 785 #if defined(TARGET_I386)
 786     {
 787         .name       = "nmi",
 788         .args_type  = "",
 789         .params     = "",
 790         .help       = "inject an NMI on all guest's CPUs",
 791         .mhandler.cmd = hmp_inject_nmi,
 792     },
 793 #endif
 794 STEXI
 795 @item nmi @var{cpu}
 796 @findex nmi
 797 Inject an NMI on the given CPU (x86 only).
 798 ETEXI
 799
 800     {
 801         .name       = "migrate",
 802         .args_type  = "detach:-d,blk:-b,inc:-i,uri:s",
 803         .params     = "[-d] [-b] [-i] uri",
 804         .help       = "migrate to URI (using -d to not wait for completion)"
 805                       "\n\t\t\t -b for migration without shared storage with"
 806                       " full copy of disk\n\t\t\t -i for migration without "
 807                       "shared storage with incremental copy of disk "
 808                       "(base image shared between src and destination)",
 809         .user_print = monitor_user_noop,
 810         .mhandler.cmd_new = do_migrate,
 811     },
 812
 813
 814 STEXI
 815 @item migrate [-d] [-b] [-i] @var{uri}
 816 @findex migrate
 817 Migrate to @var{uri} (using -d to not wait for completion).
 818         -b for migration with full copy of disk
 819         -i for migration with incremental copy of disk (base image is shared)
 820 ETEXI
 821
 822     {
 823         .name       = "migrate_cancel",
 824         .args_type  = "",
 825         .params     = "",
 826         .help       = "cancel the current VM migration",
 827         .mhandler.cmd = hmp_migrate_cancel,
 828     },
 829
 830 STEXI
 831 @item migrate_cancel
 832 @findex migrate_cancel
 833 Cancel the current VM migration.
 834 ETEXI
 835
 836     {
 837         .name       = "migrate_set_speed",
 838         .args_type  = "value:o",
 839         .params     = "value",
 840         .help       = "set maximum speed (in bytes) for migrations. "
 841         "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
 842         .mhandler.cmd = hmp_migrate_set_speed,
 843     },
 844
 845 STEXI
 846 @item migrate_set_speed @var{value}
 847 @findex migrate_set_speed
 848 Set maximum speed to @var{value} (in bytes) for migrations.
 849 ETEXI
 850
 851     {
 852         .name       = "migrate_set_downtime",
 853         .args_type  = "value:T",
 854         .params     = "value",
 855         .help       = "set maximum tolerated downtime (in seconds) for migrations",
 856         .mhandler.cmd = hmp_migrate_set_downtime,
 857     },
 858
 859 STEXI
 860 @item migrate_set_downtime @var{second}
 861 @findex migrate_set_downtime
 862 Set maximum tolerated downtime (in seconds) for migration.
 863 ETEXI
 864
 865     {
 866         .name       = "client_migrate_info",
 867         .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
 868         .params     = "protocol hostname port tls-port cert-subject",
 869         .help       = "send migration info to spice/vnc client",
 870         .user_print = monitor_user_noop,
 871         .mhandler.cmd_async = client_migrate_info,
 872         .flags      = MONITOR_CMD_ASYNC,
 873     },
 874
 875 STEXI
 876 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
 877 @findex client_migrate_info
 878 Set the spice/vnc connection info for the migration target.  The spice/vnc
 879 server will ask the spice/vnc client to automatically reconnect using the
 880 new parameters (if specified) once the vm migration finished successfully.
 881 ETEXI
 882
 883     {
 884         .name       = "snapshot_blkdev",
 885         .args_type  = "device:B,snapshot-file:s?,format:s?",
 886         .params     = "device [new-image-file] [format]",
 887         .help       = "initiates a live snapshot\n\t\t\t"
 888                       "of device. If a new image file is specified, the\n\t\t\t"
 889                       "new image file will become the new root image.\n\t\t\t"
 890                       "If format is specified, the snapshot file will\n\t\t\t"
 891                       "be created in that format. Otherwise the\n\t\t\t"
 892                       "snapshot will be internal! (currently unsupported)",
 893         .mhandler.cmd = hmp_snapshot_blkdev,
 894     },
 895
 896 STEXI
 897 @item snapshot_blkdev
 898 @findex snapshot_blkdev
 899 Snapshot device, using snapshot file as target if provided
 900 ETEXI
 901
 902     {
 903         .name       = "drive_add",
 904         .args_type  = "pci_addr:s,opts:s",
 905         .params     = "[[<domain>:]<bus>:]<slot>\n"
 906                       "[file=file][,if=type][,bus=n]\n"
 907                       "[,unit=m][,media=d][,index=i]\n"
 908                       "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
 909                       "[,snapshot=on|off][,cache=on|off]\n"
 910                       "[,readonly=on|off][,copy-on-read=on|off]",
 911         .help       = "add drive to PCI storage controller",
 912         .mhandler.cmd = drive_hot_add,
 913     },
 914
 915 STEXI
 916 @item drive_add
 917 @findex drive_add
 918 Add drive to PCI storage controller.
 919 ETEXI
 920
 921 #if defined(TARGET_I386)
 922     {
 923         .name       = "pci_add",
 924         .args_type  = "pci_addr:s,type:s,opts:s?",
 925         .params     = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
 926         .help       = "hot-add PCI device",
 927         .mhandler.cmd = pci_device_hot_add,
 928     },
 929 #endif
 930
 931 STEXI
 932 @item pci_add
 933 @findex pci_add
 934 Hot-add PCI device.
 935 ETEXI
 936
 937 #if defined(TARGET_I386)
 938     {
 939         .name       = "pci_del",
 940         .args_type  = "pci_addr:s",
 941         .params     = "[[<domain>:]<bus>:]<slot>",
 942         .help       = "hot remove PCI device",
 943         .mhandler.cmd = do_pci_device_hot_remove,
 944     },
 945 #endif
 946
 947 STEXI
 948 @item pci_del
 949 @findex pci_del
 950 Hot remove PCI device.
 951 ETEXI
 952
 953     {
 954         .name       = "pcie_aer_inject_error",
 955         .args_type  = "advisory_non_fatal:-a,correctable:-c,"
 956                       "id:s,error_status:s,"
 957                       "header0:i?,header1:i?,header2:i?,header3:i?,"
 958                       "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
 959         .params     = "[-a] [-c] id "
 960                       "<error_status> [<tlp header> [<tlp header prefix>]]",
 961         .help       = "inject pcie aer error\n\t\t\t"
 962                       " -a for advisory non fatal error\n\t\t\t"
 963                       " -c for correctable error\n\t\t\t"
 964                       "<id> = qdev device id\n\t\t\t"
 965                       "<error_status> = error string or 32bit\n\t\t\t"
 966                       "<tlb header> = 32bit x 4\n\t\t\t"
 967                       "<tlb header prefix> = 32bit x 4",
 968         .user_print  = pcie_aer_inject_error_print,
 969         .mhandler.cmd_new = do_pcie_aer_inject_error,
 970     },
 971
 972 STEXI
 973 @item pcie_aer_inject_error
 974 @findex pcie_aer_inject_error
 975 Inject PCIe AER error
 976 ETEXI
 977
 978     {
 979         .name       = "host_net_add",
 980         .args_type  = "device:s,opts:s?",
 981         .params     = "tap|user|socket|vde|dump [options]",
 982         .help       = "add host VLAN client",
 983         .mhandler.cmd = net_host_device_add,
 984     },
 985
 986 STEXI
 987 @item host_net_add
 988 @findex host_net_add
 989 Add host VLAN client.
 990 ETEXI
 991
 992     {
 993         .name       = "host_net_remove",
 994         .args_type  = "vlan_id:i,device:s",
 995         .params     = "vlan_id name",
 996         .help       = "remove host VLAN client",
 997         .mhandler.cmd = net_host_device_remove,
 998     },
 999
1000 STEXI
1001 @item host_net_remove
1002 @findex host_net_remove
1003 Remove host VLAN client.
1004 ETEXI
1005
1006     {
1007         .name       = "netdev_add",
1008         .args_type  = "netdev:O",
1009         .params     = "[user|tap|socket],id=str[,prop=value][,...]",
1010         .help       = "add host network device",
1011         .user_print = monitor_user_noop,
1012         .mhandler.cmd_new = do_netdev_add,
1013     },
1014
1015 STEXI
1016 @item netdev_add
1017 @findex netdev_add
1018 Add host network device.
1019 ETEXI
1020
1021     {
1022         .name       = "netdev_del",
1023         .args_type  = "id:s",
1024         .params     = "id",
1025         .help       = "remove host network device",
1026         .user_print = monitor_user_noop,
1027         .mhandler.cmd_new = do_netdev_del,
1028     },
1029
1030 STEXI
1031 @item netdev_del
1032 @findex netdev_del
1033 Remove host network device.
1034 ETEXI
1035
1036 #ifdef CONFIG_SLIRP
1037     {
1038         .name       = "hostfwd_add",
1039         .args_type  = "arg1:s,arg2:s?,arg3:s?",
1040         .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1041         .help       = "redirect TCP or UDP connections from host to guest (requires -net user)",
1042         .mhandler.cmd = net_slirp_hostfwd_add,
1043     },
1044 #endif
1045 STEXI
1046 @item hostfwd_add
1047 @findex hostfwd_add
1048 Redirect TCP or UDP connections from host to guest (requires -net user).
1049 ETEXI
1050
1051 #ifdef CONFIG_SLIRP
1052     {
1053         .name       = "hostfwd_remove",
1054         .args_type  = "arg1:s,arg2:s?,arg3:s?",
1055         .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1056         .help       = "remove host-to-guest TCP or UDP redirection",
1057         .mhandler.cmd = net_slirp_hostfwd_remove,
1058     },
1059
1060 #endif
1061 STEXI
1062 @item hostfwd_remove
1063 @findex hostfwd_remove
1064 Remove host-to-guest TCP or UDP redirection.
1065 ETEXI
1066
1067     {
1068         .name       = "balloon",
1069         .args_type  = "value:M",
1070         .params     = "target",
1071         .help       = "request VM to change its memory allocation (in MB)",
1072         .mhandler.cmd = hmp_balloon,
1073     },
1074
1075 STEXI
1076 @item balloon @var{value}
1077 @findex balloon
1078 Request VM to change its memory allocation to @var{value} (in MB).
1079 ETEXI
1080
1081     {
1082         .name       = "set_link",
1083         .args_type  = "name:s,up:b",
1084         .params     = "name on|off",
1085         .help       = "change the link status of a network adapter",
1086         .mhandler.cmd = hmp_set_link,
1087     },
1088
1089 STEXI
1090 @item set_link @var{name} [on|off]
1091 @findex set_link
1092 Switch link @var{name} on (i.e. up) or off (i.e. down).
1093 ETEXI
1094
1095     {
1096         .name       = "watchdog_action",
1097         .args_type  = "action:s",
1098         .params     = "[reset|shutdown|poweroff|pause|debug|none]",
1099         .help       = "change watchdog action",
1100         .mhandler.cmd = do_watchdog_action,
1101     },
1102
1103 STEXI
1104 @item watchdog_action
1105 @findex watchdog_action
1106 Change watchdog action.
1107 ETEXI
1108
1109     {
1110         .name       = "acl_show",
1111         .args_type  = "aclname:s",
1112         .params     = "aclname",
1113         .help       = "list rules in the access control list",
1114         .mhandler.cmd = do_acl_show,
1115     },
1116
1117 STEXI
1118 @item acl_show @var{aclname}
1119 @findex acl_show
1120 List all the matching rules in the access control list, and the default
1121 policy. There are currently two named access control lists,
1122 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1123 certificate distinguished name, and SASL username respectively.
1124 ETEXI
1125
1126     {
1127         .name       = "acl_policy",
1128         .args_type  = "aclname:s,policy:s",
1129         .params     = "aclname allow|deny",
1130         .help       = "set default access control list policy",
1131         .mhandler.cmd = do_acl_policy,
1132     },
1133
1134 STEXI
1135 @item acl_policy @var{aclname} @code{allow|deny}
1136 @findex acl_policy
1137 Set the default access control list policy, used in the event that
1138 none of the explicit rules match. The default policy at startup is
1139 always @code{deny}.
1140 ETEXI
1141
1142     {
1143         .name       = "acl_add",
1144         .args_type  = "aclname:s,match:s,policy:s,index:i?",
1145         .params     = "aclname match allow|deny [index]",
1146         .help       = "add a match rule to the access control list",
1147         .mhandler.cmd = do_acl_add,
1148     },
1149
1150 STEXI
1151 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1152 @findex acl_add
1153 Add a match rule to the access control list, allowing or denying access.
1154 The match will normally be an exact username or x509 distinguished name,
1155 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1156 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1157 normally be appended to the end of the ACL, but can be inserted
1158 earlier in the list if the optional @var{index} parameter is supplied.
1159 ETEXI
1160
1161     {
1162         .name       = "acl_remove",
1163         .args_type  = "aclname:s,match:s",
1164         .params     = "aclname match",
1165         .help       = "remove a match rule from the access control list",
1166         .mhandler.cmd = do_acl_remove,
1167     },
1168
1169 STEXI
1170 @item acl_remove @var{aclname} @var{match}
1171 @findex acl_remove
1172 Remove the specified match rule from the access control list.
1173 ETEXI
1174
1175     {
1176         .name       = "acl_reset",
1177         .args_type  = "aclname:s",
1178         .params     = "aclname",
1179         .help       = "reset the access control list",
1180         .mhandler.cmd = do_acl_reset,
1181     },
1182
1183 STEXI
1184 @item acl_reset @var{aclname}
1185 @findex acl_reset
1186 Remove all matches from the access control list, and set the default
1187 policy back to @code{deny}.
1188 ETEXI
1189
1190 #if defined(TARGET_I386)
1191
1192     {
1193         .name       = "mce",
1194         .args_type  = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1195         .params     = "[-b] cpu bank status mcgstatus addr misc",
1196         .help       = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1197         .mhandler.cmd = do_inject_mce,
1198     },
1199
1200 #endif
1201 STEXI
1202 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1203 @findex mce (x86)
1204 Inject an MCE on the given CPU (x86 only).
1205 ETEXI
1206
1207     {
1208         .name       = "getfd",
1209         .args_type  = "fdname:s",
1210         .params     = "getfd name",
1211         .help       = "receive a file descriptor via SCM rights and assign it a name",
1212         .user_print = monitor_user_noop,
1213         .mhandler.cmd_new = do_getfd,
1214     },
1215
1216 STEXI
1217 @item getfd @var{fdname}
1218 @findex getfd
1219 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1220 mechanism on unix sockets, it is stored using the name @var{fdname} for
1221 later use by other monitor commands.
1222 ETEXI
1223
1224     {
1225         .name       = "closefd",
1226         .args_type  = "fdname:s",
1227         .params     = "closefd name",
1228         .help       = "close a file descriptor previously passed via SCM rights",
1229         .user_print = monitor_user_noop,
1230         .mhandler.cmd_new = do_closefd,
1231     },
1232
1233 STEXI
1234 @item closefd @var{fdname}
1235 @findex closefd
1236 Close the file descriptor previously assigned to @var{fdname} using the
1237 @code{getfd} command. This is only needed if the file descriptor was never
1238 used by another monitor command.
1239 ETEXI
1240
1241     {
1242         .name       = "block_passwd",
1243         .args_type  = "device:B,password:s",
1244         .params     = "block_passwd device password",
1245         .help       = "set the password of encrypted block devices",
1246         .mhandler.cmd = hmp_block_passwd,
1247     },
1248
1249 STEXI
1250 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1251 @findex block_set_io_throttle
1252 Change I/O throttle limits for a block drive to @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1253 ETEXI
1254
1255     {
1256         .name       = "block_set_io_throttle",
1257         .args_type  = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1258         .params     = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1259         .help       = "change I/O throttle limits for a block drive",
1260         .mhandler.cmd = hmp_block_set_io_throttle,
1261     },
1262
1263 STEXI
1264 @item block_passwd @var{device} @var{password}
1265 @findex block_passwd
1266 Set the encrypted device @var{device} password to @var{password}
1267 ETEXI
1268
1269     {
1270         .name       = "set_password",
1271         .args_type  = "protocol:s,password:s,connected:s?",
1272         .params     = "protocol password action-if-connected",
1273         .help       = "set spice/vnc password",
1274         .mhandler.cmd = hmp_set_password,
1275     },
1276
1277 STEXI
1278 @item set_password [ vnc | spice ] password [ action-if-connected ]
1279 @findex set_password
1280
1281 Change spice/vnc password.  Use zero to make the password stay valid
1282 forever.  @var{action-if-connected} specifies what should happen in
1283 case a connection is established: @var{fail} makes the password change
1284 fail.  @var{disconnect} changes the password and disconnects the
1285 client.  @var{keep} changes the password and keeps the connection up.
1286 @var{keep} is the default.
1287 ETEXI
1288
1289     {
1290         .name       = "expire_password",
1291         .args_type  = "protocol:s,time:s",
1292         .params     = "protocol time",
1293         .help       = "set spice/vnc password expire-time",
1294         .mhandler.cmd = hmp_expire_password,
1295     },
1296
1297 STEXI
1298 @item expire_password [ vnc | spice ] expire-time
1299 @findex expire_password
1300
1301 Specify when a password for spice/vnc becomes
1302 invalid. @var{expire-time} accepts:
1303
1304 @table @var
1305 @item now
1306 Invalidate password instantly.
1307
1308 @item never
1309 Password stays valid forever.
1310
1311 @item +nsec
1312 Password stays valid for @var{nsec} seconds starting now.
1313
1314 @item nsec
1315 Password is invalidated at the given time.  @var{nsec} are the seconds
1316 passed since 1970, i.e. unix epoch.
1317
1318 @end table
1319 ETEXI
1320
1321     {
1322         .name       = "info",
1323         .args_type  = "item:s?",
1324         .params     = "[subcommand]",
1325         .help       = "show various information about the system state",
1326         .mhandler.cmd = do_info,
1327     },
1328
1329 STEXI
1330 @item info @var{subcommand}
1331 @findex info
1332 Show various information about the system state.
1333
1334 @table @option
1335 @item info version
1336 show the version of QEMU
1337 @item info network
1338 show the various VLANs and the associated devices
1339 @item info chardev
1340 show the character devices
1341 @item info block
1342 show the block devices
1343 @item info blockstats
1344 show block device statistics
1345 @item info registers
1346 show the cpu registers
1347 @item info cpus
1348 show infos for each CPU
1349 @item info history
1350 show the command line history
1351 @item info irq
1352 show the interrupts statistics (if available)
1353 @item info pic
1354 show i8259 (PIC) state
1355 @item info pci
1356 show emulated PCI device info
1357 @item info tlb
1358 show virtual to physical memory mappings (i386, SH4, SPARC, and PPC only)
1359 @item info mem
1360 show the active virtual memory mappings (i386 only)
1361 @item info jit
1362 show dynamic compiler info
1363 @item info numa
1364 show NUMA information
1365 @item info kvm
1366 show KVM information
1367 @item info usb
1368 show USB devices plugged on the virtual USB hub
1369 @item info usbhost
1370 show all USB host devices
1371 @item info profile
1372 show profiling information
1373 @item info capture
1374 show information about active capturing
1375 @item info snapshots
1376 show list of VM snapshots
1377 @item info status
1378 show the current VM status (running|paused)
1379 @item info pcmcia
1380 show guest PCMCIA status
1381 @item info mice
1382 show which guest mouse is receiving events
1383 @item info vnc
1384 show the vnc server status
1385 @item info name
1386 show the current VM name
1387 @item info uuid
1388 show the current VM UUID
1389 @item info cpustats
1390 show CPU statistics
1391 @item info usernet
1392 show user network stack connection states
1393 @item info migrate
1394 show migration status
1395 @item info balloon
1396 show balloon information
1397 @item info qtree
1398 show device tree
1399 @item info qdm
1400 show qdev device model list
1401 @item info roms
1402 show roms
1403 @end table
1404 ETEXI
1405
1406 #ifdef CONFIG_TRACE_SIMPLE
1407 STEXI
1408 @item info trace
1409 show contents of trace buffer
1410 ETEXI
1411 #endif
1412
1413 STEXI
1414 @item info trace-events
1415 show available trace events and their state
1416 ETEXI
1417
1418 STEXI
1419 @end table
1420 ETEXI