| 1 | HXCOMM See docs/devel/docs.rst for the format of this file. |
| 2 | HXCOMM |
| 3 | HXCOMM This file defines the contents of an array of HMPCommand structs |
| 4 | HXCOMM which specify the name, behaviour and help text for HMP commands. |
| 5 | HXCOMM Text between SRST and ERST is rST format documentation. |
| 6 | HXCOMM HXCOMM can be used for comments, discarded from both rST and C. |
| 7 | |
| 8 | |
| 9 | { |
| 10 | .name = "help|?", |
| 11 | .args_type = "name:S?", |
| 12 | .params = "[cmd]", |
| 13 | .help = "show the help", |
| 14 | .cmd = hmp_help, |
| 15 | .flags = "p", |
| 16 | }, |
| 17 | |
| 18 | SRST |
| 19 | ``help`` or ``?`` [*cmd*] |
| 20 | Show the help for all commands or just for command *cmd*. |
| 21 | ERST |
| 22 | |
| 23 | { |
| 24 | .name = "clear", |
| 25 | .args_type = "", |
| 26 | .params = "", |
| 27 | .help = "clear the monitor screen", |
| 28 | .cmd = hmp_clear, |
| 29 | .flags = "p", |
| 30 | }, |
| 31 | |
| 32 | SRST |
| 33 | ``clear`` |
| 34 | Clear the monitor screen. |
| 35 | ERST |
| 36 | |
| 37 | { |
| 38 | .name = "commit", |
| 39 | .args_type = "device:B", |
| 40 | .params = "device|all", |
| 41 | .help = "commit changes to the disk images (if -snapshot is used) or backing files", |
| 42 | .cmd = hmp_commit, |
| 43 | }, |
| 44 | |
| 45 | SRST |
| 46 | ``commit`` |
| 47 | Commit changes to the disk images (if -snapshot is used) or backing files. |
| 48 | If the backing file is smaller than the snapshot, then the backing file |
| 49 | will be resized to be the same size as the snapshot. If the snapshot is |
| 50 | smaller than the backing file, the backing file will not be truncated. |
| 51 | If you want the backing file to match the size of the smaller snapshot, |
| 52 | you can safely truncate it yourself once the commit operation successfully |
| 53 | completes. |
| 54 | ERST |
| 55 | |
| 56 | { |
| 57 | .name = "quit|q", |
| 58 | .args_type = "", |
| 59 | .params = "", |
| 60 | .help = "quit the emulator", |
| 61 | .cmd = hmp_quit, |
| 62 | .flags = "p", |
| 63 | }, |
| 64 | |
| 65 | SRST |
| 66 | ``quit`` or ``q`` |
| 67 | Quit the emulator. |
| 68 | ERST |
| 69 | |
| 70 | { |
| 71 | .name = "exit_preconfig", |
| 72 | .args_type = "", |
| 73 | .params = "", |
| 74 | .help = "exit the preconfig state", |
| 75 | .cmd = hmp_exit_preconfig, |
| 76 | .flags = "p", |
| 77 | }, |
| 78 | |
| 79 | SRST |
| 80 | ``exit_preconfig`` |
| 81 | This command makes QEMU exit the preconfig state and proceed with |
| 82 | VM initialization using configuration data provided on the command line |
| 83 | and via the QMP monitor during the preconfig state. The command is only |
| 84 | available during the preconfig state (i.e. when the --preconfig command |
| 85 | line option was in use). |
| 86 | ERST |
| 87 | |
| 88 | { |
| 89 | .name = "block_resize", |
| 90 | .args_type = "device:B,size:o", |
| 91 | .params = "device size", |
| 92 | .help = "resize a block image", |
| 93 | .cmd = hmp_block_resize, |
| 94 | .coroutine = true, |
| 95 | .flags = "p", |
| 96 | }, |
| 97 | |
| 98 | SRST |
| 99 | ``block_resize`` |
| 100 | Resize a block image while a guest is running. Usually requires guest |
| 101 | action to see the updated size. Resize to a lower size is supported, |
| 102 | but should be used with extreme caution. Note that this command only |
| 103 | resizes image files, it can not resize block devices like LVM volumes. |
| 104 | ERST |
| 105 | |
| 106 | { |
| 107 | .name = "block_stream", |
| 108 | .args_type = "device:B,speed:o?,base:s?", |
| 109 | .params = "device [speed [base]]", |
| 110 | .help = "copy data from a backing file into a block device", |
| 111 | .cmd = hmp_block_stream, |
| 112 | .flags = "p", |
| 113 | }, |
| 114 | |
| 115 | SRST |
| 116 | ``block_stream`` |
| 117 | Copy data from a backing file into a block device. |
| 118 | ERST |
| 119 | |
| 120 | { |
| 121 | .name = "block_job_set_speed", |
| 122 | .args_type = "device:B,speed:o", |
| 123 | .params = "device speed", |
| 124 | .help = "set maximum speed for a background block operation", |
| 125 | .cmd = hmp_block_job_set_speed, |
| 126 | .flags = "p", |
| 127 | }, |
| 128 | |
| 129 | SRST |
| 130 | ``block_job_set_speed`` |
| 131 | Set maximum speed for a background block operation. |
| 132 | ERST |
| 133 | |
| 134 | { |
| 135 | .name = "block_job_cancel", |
| 136 | .args_type = "force:-f,device:B", |
| 137 | .params = "[-f] device", |
| 138 | .help = "stop an active background block operation (use -f" |
| 139 | "\n\t\t\t if you want to abort the operation immediately" |
| 140 | "\n\t\t\t instead of keep running until data is in sync)", |
| 141 | .cmd = hmp_block_job_cancel, |
| 142 | .flags = "p", |
| 143 | }, |
| 144 | |
| 145 | SRST |
| 146 | ``block_job_cancel`` |
| 147 | Stop an active background block operation (streaming, mirroring). |
| 148 | ERST |
| 149 | |
| 150 | { |
| 151 | .name = "block_job_complete", |
| 152 | .args_type = "device:B", |
| 153 | .params = "device", |
| 154 | .help = "stop an active background block operation", |
| 155 | .cmd = hmp_block_job_complete, |
| 156 | .flags = "p", |
| 157 | }, |
| 158 | |
| 159 | SRST |
| 160 | ``block_job_complete`` |
| 161 | Manually trigger completion of an active background block operation. |
| 162 | For mirroring, this will switch the device to the destination path. |
| 163 | ERST |
| 164 | |
| 165 | { |
| 166 | .name = "block_job_pause", |
| 167 | .args_type = "device:B", |
| 168 | .params = "device", |
| 169 | .help = "pause an active background block operation", |
| 170 | .cmd = hmp_block_job_pause, |
| 171 | .flags = "p", |
| 172 | }, |
| 173 | |
| 174 | SRST |
| 175 | ``block_job_pause`` |
| 176 | Pause an active block streaming operation. |
| 177 | ERST |
| 178 | |
| 179 | { |
| 180 | .name = "block_job_resume", |
| 181 | .args_type = "device:B", |
| 182 | .params = "device", |
| 183 | .help = "resume a paused background block operation", |
| 184 | .cmd = hmp_block_job_resume, |
| 185 | .flags = "p", |
| 186 | }, |
| 187 | |
| 188 | SRST |
| 189 | ``block_job_resume`` |
| 190 | Resume a paused block streaming operation. |
| 191 | ERST |
| 192 | |
| 193 | { |
| 194 | .name = "eject", |
| 195 | .args_type = "force:-f,device:B", |
| 196 | .params = "[-f] device", |
| 197 | .help = "eject a removable medium (use -f to force it)", |
| 198 | .cmd = hmp_eject, |
| 199 | }, |
| 200 | |
| 201 | SRST |
| 202 | ``eject [-f]`` *device* |
| 203 | Eject a removable medium (use -f to force it). |
| 204 | ERST |
| 205 | |
| 206 | { |
| 207 | .name = "drive_del", |
| 208 | .args_type = "id:B", |
| 209 | .params = "device", |
| 210 | .help = "remove host block device", |
| 211 | .cmd = hmp_drive_del, |
| 212 | }, |
| 213 | |
| 214 | SRST |
| 215 | ``drive_del`` *device* |
| 216 | Remove host block device. The result is that guest generated IO is no longer |
| 217 | submitted against the host device underlying the disk. Once a drive has |
| 218 | been deleted, the QEMU Block layer returns -EIO which results in IO |
| 219 | errors in the guest for applications that are reading/writing to the device. |
| 220 | These errors are always reported to the guest, regardless of the drive's error |
| 221 | actions (drive options rerror, werror). |
| 222 | ERST |
| 223 | |
| 224 | { |
| 225 | .name = "change", |
| 226 | .args_type = "device:B,force:-f,target:F,arg:s?,read-only-mode:s?", |
| 227 | .params = "device [-f] filename [format [read-only-mode]]", |
| 228 | .help = "change a removable medium, optional format, use -f to force the operation", |
| 229 | .cmd = hmp_change, |
| 230 | }, |
| 231 | |
| 232 | SRST |
| 233 | ``change`` *device* *setting* |
| 234 | Change the configuration of a device. |
| 235 | |
| 236 | ``change`` *diskdevice* [-f] *filename* [*format* [*read-only-mode*]] |
| 237 | Change the medium for a removable disk device to point to *filename*. eg:: |
| 238 | |
| 239 | (qemu) change ide1-cd0 /path/to/some.iso |
| 240 | |
| 241 | ``-f`` |
| 242 | forces the operation even if the guest has locked the tray. |
| 243 | |
| 244 | *format* is optional. |
| 245 | |
| 246 | *read-only-mode* may be used to change the read-only status of the device. |
| 247 | It accepts the following values: |
| 248 | |
| 249 | retain |
| 250 | Retains the current status; this is the default. |
| 251 | |
| 252 | read-only |
| 253 | Makes the device read-only. |
| 254 | |
| 255 | read-write |
| 256 | Makes the device writable. |
| 257 | |
| 258 | ``change vnc password`` [*password*] |
| 259 | |
| 260 | Change the password associated with the VNC server. If the new password |
| 261 | is not supplied, the monitor will prompt for it to be entered. VNC |
| 262 | passwords are only significant up to 8 letters. eg:: |
| 263 | |
| 264 | (qemu) change vnc password |
| 265 | Password: ******** |
| 266 | |
| 267 | ERST |
| 268 | |
| 269 | #ifdef CONFIG_PIXMAN |
| 270 | { |
| 271 | .name = "screendump", |
| 272 | .args_type = "filename:F,format:-fs,device:s?,head:i?", |
| 273 | .params = "filename [-f format] [device [head]]", |
| 274 | .help = "save screen from head 'head' of display device 'device' " |
| 275 | "in specified format 'format' as image 'filename'. " |
| 276 | "Currently only 'png' and 'ppm' formats are supported.", |
| 277 | .cmd = hmp_screendump, |
| 278 | .coroutine = true, |
| 279 | }, |
| 280 | |
| 281 | SRST |
| 282 | ``screendump`` *filename* |
| 283 | Save screen into PPM image *filename*. |
| 284 | ERST |
| 285 | #endif |
| 286 | |
| 287 | { |
| 288 | .name = "logfile", |
| 289 | .args_type = "filename:F", |
| 290 | .params = "filename", |
| 291 | .help = "output logs to 'filename'", |
| 292 | .cmd = hmp_logfile, |
| 293 | }, |
| 294 | |
| 295 | SRST |
| 296 | ``logfile`` *filename* |
| 297 | Output logs to *filename*. |
| 298 | ERST |
| 299 | |
| 300 | { |
| 301 | .name = "trace-event", |
| 302 | .args_type = "name:s,option:b", |
| 303 | .params = "name on|off", |
| 304 | .help = "changes status of a specific trace event", |
| 305 | .cmd = hmp_trace_event, |
| 306 | .command_completion = trace_event_completion, |
| 307 | }, |
| 308 | |
| 309 | SRST |
| 310 | ``trace-event`` |
| 311 | changes status of a trace event |
| 312 | ERST |
| 313 | |
| 314 | #if defined(CONFIG_TRACE_SIMPLE) |
| 315 | { |
| 316 | .name = "trace-file", |
| 317 | .args_type = "op:s?,arg:F?", |
| 318 | .params = "on|off|flush|set [arg]", |
| 319 | .help = "open, close, or flush trace file, or set a new file name", |
| 320 | .cmd = hmp_trace_file, |
| 321 | }, |
| 322 | |
| 323 | SRST |
| 324 | ``trace-file on|off|flush`` |
| 325 | Open, close, or flush the trace file. If no argument is given, the |
| 326 | status of the trace file is displayed. |
| 327 | ERST |
| 328 | #endif |
| 329 | |
| 330 | { |
| 331 | .name = "log", |
| 332 | .args_type = "items:s", |
| 333 | .params = "item1[,...]", |
| 334 | .help = "activate logging of the specified items", |
| 335 | .cmd = hmp_log, |
| 336 | }, |
| 337 | |
| 338 | SRST |
| 339 | ``log`` *item1*\ [,...] |
| 340 | Activate logging of the specified items. |
| 341 | ERST |
| 342 | |
| 343 | { |
| 344 | .name = "savevm", |
| 345 | .args_type = "name:s?", |
| 346 | .params = "tag", |
| 347 | .help = "save a VM snapshot. If no tag is provided, a new snapshot is created", |
| 348 | .cmd = hmp_savevm, |
| 349 | }, |
| 350 | |
| 351 | SRST |
| 352 | ``savevm`` *tag* |
| 353 | Create a snapshot of the whole virtual machine. If *tag* is |
| 354 | provided, it is used as human readable identifier. If there is already |
| 355 | a snapshot with the same tag, it is replaced. More info at |
| 356 | :ref:`vm_005fsnapshots`. |
| 357 | |
| 358 | Since 4.0, savevm stopped allowing the snapshot id to be set, accepting |
| 359 | only *tag* as parameter. |
| 360 | ERST |
| 361 | |
| 362 | { |
| 363 | .name = "loadvm", |
| 364 | .args_type = "name:s", |
| 365 | .params = "tag", |
| 366 | .help = "restore a VM snapshot from its tag", |
| 367 | .cmd = hmp_loadvm, |
| 368 | .command_completion = loadvm_completion, |
| 369 | }, |
| 370 | |
| 371 | SRST |
| 372 | ``loadvm`` *tag* |
| 373 | Set the whole virtual machine to the snapshot identified by the tag |
| 374 | *tag*. |
| 375 | |
| 376 | Since 4.0, loadvm stopped accepting snapshot id as parameter. |
| 377 | ERST |
| 378 | |
| 379 | { |
| 380 | .name = "delvm", |
| 381 | .args_type = "name:s", |
| 382 | .params = "tag", |
| 383 | .help = "delete a VM snapshot from its tag", |
| 384 | .cmd = hmp_delvm, |
| 385 | .command_completion = delvm_completion, |
| 386 | }, |
| 387 | |
| 388 | SRST |
| 389 | ``delvm`` *tag* |
| 390 | Delete the snapshot identified by *tag*. |
| 391 | |
| 392 | Since 4.0, delvm stopped deleting snapshots by snapshot id, accepting |
| 393 | only *tag* as parameter. |
| 394 | ERST |
| 395 | |
| 396 | { |
| 397 | .name = "one-insn-per-tb", |
| 398 | .args_type = "option:s?", |
| 399 | .params = "[on|off]", |
| 400 | .help = "run emulation with one guest instruction per translation block", |
| 401 | .cmd = hmp_one_insn_per_tb, |
| 402 | }, |
| 403 | |
| 404 | SRST |
| 405 | ``one-insn-per-tb [off]`` |
| 406 | Run the emulation with one guest instruction per translation block. |
| 407 | This slows down emulation a lot, but can be useful in some situations, |
| 408 | such as when trying to analyse the logs produced by the ``-d`` option. |
| 409 | This only has an effect when using TCG, not with KVM or other accelerators. |
| 410 | |
| 411 | If called with option off, the emulation returns to normal mode. |
| 412 | ERST |
| 413 | |
| 414 | { |
| 415 | .name = "stop|s", |
| 416 | .args_type = "", |
| 417 | .params = "", |
| 418 | .help = "stop emulation", |
| 419 | .cmd = hmp_stop, |
| 420 | }, |
| 421 | |
| 422 | SRST |
| 423 | ``stop`` or ``s`` |
| 424 | Stop emulation. |
| 425 | ERST |
| 426 | |
| 427 | { |
| 428 | .name = "cont|c", |
| 429 | .args_type = "", |
| 430 | .params = "", |
| 431 | .help = "resume emulation", |
| 432 | .cmd = hmp_cont, |
| 433 | }, |
| 434 | |
| 435 | SRST |
| 436 | ``cont`` or ``c`` |
| 437 | Resume emulation. |
| 438 | ERST |
| 439 | |
| 440 | { |
| 441 | .name = "system_wakeup", |
| 442 | .args_type = "", |
| 443 | .params = "", |
| 444 | .help = "wakeup guest from suspend", |
| 445 | .cmd = hmp_system_wakeup, |
| 446 | }, |
| 447 | |
| 448 | SRST |
| 449 | ``system_wakeup`` |
| 450 | Wakeup guest from suspend. |
| 451 | ERST |
| 452 | |
| 453 | { |
| 454 | .name = "gdbserver", |
| 455 | .args_type = "device:s?", |
| 456 | .params = "[device]", |
| 457 | .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'", |
| 458 | .cmd = hmp_gdbserver, |
| 459 | }, |
| 460 | |
| 461 | SRST |
| 462 | ``gdbserver`` [*port*] |
| 463 | Start gdbserver session (default *port*\=1234) |
| 464 | ERST |
| 465 | |
| 466 | { |
| 467 | .name = "x", |
| 468 | .args_type = "fmt:/,addr:l", |
| 469 | .params = "/fmt addr", |
| 470 | .help = "virtual memory dump starting at 'addr'", |
| 471 | .cmd = hmp_memory_dump, |
| 472 | }, |
| 473 | |
| 474 | SRST |
| 475 | ``x/``\ *fmt* *addr* |
| 476 | Virtual memory dump starting at *addr*. |
| 477 | ERST |
| 478 | |
| 479 | { |
| 480 | .name = "xp", |
| 481 | .args_type = "fmt:/,addr:l", |
| 482 | .params = "/fmt addr", |
| 483 | .help = "physical memory dump starting at 'addr'", |
| 484 | .cmd = hmp_physical_memory_dump, |
| 485 | }, |
| 486 | |
| 487 | SRST |
| 488 | ``xp /``\ *fmt* *addr* |
| 489 | Physical memory dump starting at *addr*. |
| 490 | |
| 491 | *fmt* is a format which tells the command how to format the |
| 492 | data. Its syntax is: ``/{count}{format}{size}`` |
| 493 | |
| 494 | *count* |
| 495 | is the number of items to be dumped. |
| 496 | *format* |
| 497 | can be x (hex), d (signed decimal), u (unsigned decimal), o (octal), |
| 498 | c (char) or i (asm instruction). |
| 499 | *size* |
| 500 | can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86, |
| 501 | ``h`` or ``w`` can be specified with the ``i`` format to |
| 502 | respectively select 16 or 32 bit code instruction size. |
| 503 | |
| 504 | Examples: |
| 505 | |
| 506 | Dump 10 instructions at the current instruction pointer:: |
| 507 | |
| 508 | (qemu) x/10i $eip |
| 509 | 0x90107063: ret |
| 510 | 0x90107064: sti |
| 511 | 0x90107065: lea 0x0(%esi,1),%esi |
| 512 | 0x90107069: lea 0x0(%edi,1),%edi |
| 513 | 0x90107070: ret |
| 514 | 0x90107071: jmp 0x90107080 |
| 515 | 0x90107073: nop |
| 516 | 0x90107074: nop |
| 517 | 0x90107075: nop |
| 518 | 0x90107076: nop |
| 519 | |
| 520 | Dump 80 16 bit values at the start of the video memory:: |
| 521 | |
| 522 | (qemu) xp/80hx 0xb8000 |
| 523 | 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42 |
| 524 | 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41 |
| 525 | 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72 |
| 526 | 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73 |
| 527 | 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20 |
| 528 | 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720 |
| 529 | 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
| 530 | 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
| 531 | 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
| 532 | 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 |
| 533 | |
| 534 | ERST |
| 535 | |
| 536 | { |
| 537 | .name = "gpa2hva", |
| 538 | .args_type = "addr:l", |
| 539 | .params = "addr", |
| 540 | .help = "print the host virtual address corresponding to a guest physical address", |
| 541 | .cmd = hmp_gpa2hva, |
| 542 | }, |
| 543 | |
| 544 | SRST |
| 545 | ``gpa2hva`` *addr* |
| 546 | Print the host virtual address at which the guest's physical address *addr* |
| 547 | is mapped. |
| 548 | ERST |
| 549 | |
| 550 | #ifdef CONFIG_LINUX |
| 551 | { |
| 552 | .name = "gpa2hpa", |
| 553 | .args_type = "addr:l", |
| 554 | .params = "addr", |
| 555 | .help = "print the host physical address corresponding to a guest physical address", |
| 556 | .cmd = hmp_gpa2hpa, |
| 557 | }, |
| 558 | #endif |
| 559 | |
| 560 | SRST |
| 561 | ``gpa2hpa`` *addr* |
| 562 | Print the host physical address at which the guest's physical address *addr* |
| 563 | is mapped. |
| 564 | ERST |
| 565 | |
| 566 | { |
| 567 | .name = "gva2gpa", |
| 568 | .args_type = "addr:l", |
| 569 | .params = "addr", |
| 570 | .help = "print the guest physical address corresponding to a guest virtual address", |
| 571 | .cmd = hmp_gva2gpa, |
| 572 | }, |
| 573 | |
| 574 | SRST |
| 575 | ``gva2gpa`` *addr* |
| 576 | Print the guest physical address at which the guest's virtual address *addr* |
| 577 | is mapped based on the mapping for the current CPU. |
| 578 | ERST |
| 579 | |
| 580 | { |
| 581 | .name = "print|p", |
| 582 | .args_type = "fmt:/,val:l", |
| 583 | .params = "/fmt expr", |
| 584 | .help = "print expression value (use $reg for CPU register access)", |
| 585 | .cmd = hmp_print, |
| 586 | }, |
| 587 | |
| 588 | SRST |
| 589 | ``print`` or ``p/``\ *fmt* *expr* |
| 590 | Print expression value. Only the *format* part of *fmt* is |
| 591 | used. |
| 592 | ERST |
| 593 | |
| 594 | { |
| 595 | .name = "i", |
| 596 | .args_type = "fmt:/,addr:i,index:i.", |
| 597 | .params = "/fmt addr", |
| 598 | .help = "I/O port read", |
| 599 | .cmd = hmp_ioport_read, |
| 600 | }, |
| 601 | |
| 602 | SRST |
| 603 | ``i/``\ *fmt* *addr* [.\ *index*\ ] |
| 604 | Read I/O port. |
| 605 | ERST |
| 606 | |
| 607 | { |
| 608 | .name = "o", |
| 609 | .args_type = "fmt:/,addr:i,val:i", |
| 610 | .params = "/fmt addr value", |
| 611 | .help = "I/O port write", |
| 612 | .cmd = hmp_ioport_write, |
| 613 | }, |
| 614 | |
| 615 | SRST |
| 616 | ``o/``\ *fmt* *addr* *val* |
| 617 | Write to I/O port. |
| 618 | ERST |
| 619 | |
| 620 | { |
| 621 | .name = "sendkey", |
| 622 | .args_type = "keys:s,hold-time:i?", |
| 623 | .params = "keys [hold_ms]", |
| 624 | .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)", |
| 625 | .cmd = hmp_sendkey, |
| 626 | .command_completion = sendkey_completion, |
| 627 | }, |
| 628 | |
| 629 | SRST |
| 630 | ``sendkey`` *keys* |
| 631 | Send *keys* to the guest. *keys* could be the name of the |
| 632 | key or the raw value in hexadecimal format. Use ``-`` to press |
| 633 | several keys simultaneously. Example:: |
| 634 | |
| 635 | sendkey ctrl-alt-f1 |
| 636 | |
| 637 | This command is useful to send keys that your graphical user interface |
| 638 | intercepts at low level, such as ``ctrl-alt-f1`` in X Window. |
| 639 | ERST |
| 640 | { |
| 641 | .name = "sync-profile", |
| 642 | .args_type = "op:s?", |
| 643 | .params = "[on|off|reset]", |
| 644 | .help = "enable, disable or reset synchronization profiling. " |
| 645 | "With no arguments, prints whether profiling is on or off.", |
| 646 | .cmd = hmp_sync_profile, |
| 647 | }, |
| 648 | |
| 649 | SRST |
| 650 | ``sync-profile [on|off|reset]`` |
| 651 | Enable, disable or reset synchronization profiling. With no arguments, prints |
| 652 | whether profiling is on or off. |
| 653 | ERST |
| 654 | |
| 655 | { |
| 656 | .name = "system_reset", |
| 657 | .args_type = "", |
| 658 | .params = "", |
| 659 | .help = "reset the system", |
| 660 | .cmd = hmp_system_reset, |
| 661 | }, |
| 662 | |
| 663 | SRST |
| 664 | ``system_reset`` |
| 665 | Reset the system. |
| 666 | ERST |
| 667 | |
| 668 | { |
| 669 | .name = "system_powerdown", |
| 670 | .args_type = "", |
| 671 | .params = "", |
| 672 | .help = "send system power down event", |
| 673 | .cmd = hmp_system_powerdown, |
| 674 | }, |
| 675 | |
| 676 | SRST |
| 677 | ``system_powerdown`` |
| 678 | Power down the system (if supported). |
| 679 | ERST |
| 680 | |
| 681 | { |
| 682 | .name = "sum", |
| 683 | .args_type = "start:i,size:i", |
| 684 | .params = "addr size", |
| 685 | .help = "compute the checksum of a memory region", |
| 686 | .cmd = hmp_sum, |
| 687 | }, |
| 688 | |
| 689 | SRST |
| 690 | ``sum`` *addr* *size* |
| 691 | Compute the checksum of a memory region. |
| 692 | ERST |
| 693 | |
| 694 | { |
| 695 | .name = "device_add", |
| 696 | .args_type = "device:O", |
| 697 | .params = "driver[,prop=value][,...]", |
| 698 | .help = "add device, like -device on the command line", |
| 699 | .cmd = hmp_device_add, |
| 700 | .command_completion = device_add_completion, |
| 701 | }, |
| 702 | |
| 703 | SRST |
| 704 | ``device_add`` *config* |
| 705 | Add device. |
| 706 | ERST |
| 707 | |
| 708 | { |
| 709 | .name = "device_del", |
| 710 | .args_type = "id:s", |
| 711 | .params = "device", |
| 712 | .help = "remove device", |
| 713 | .cmd = hmp_device_del, |
| 714 | .command_completion = device_del_completion, |
| 715 | }, |
| 716 | |
| 717 | SRST |
| 718 | ``device_del`` *id* |
| 719 | Remove device *id*. *id* may be a short ID |
| 720 | or a QOM object path. |
| 721 | ERST |
| 722 | |
| 723 | { |
| 724 | .name = "cpu", |
| 725 | .args_type = "index:i", |
| 726 | .params = "index", |
| 727 | .help = "set the default CPU", |
| 728 | .cmd = hmp_cpu, |
| 729 | }, |
| 730 | |
| 731 | SRST |
| 732 | ``cpu`` *index* |
| 733 | Set the default CPU. |
| 734 | ERST |
| 735 | |
| 736 | { |
| 737 | .name = "mouse_move", |
| 738 | .args_type = "dx_str:s,dy_str:s,dz_str:s?", |
| 739 | .params = "dx dy [dz]", |
| 740 | .help = "send mouse move events", |
| 741 | .cmd = hmp_mouse_move, |
| 742 | }, |
| 743 | |
| 744 | SRST |
| 745 | ``mouse_move`` *dx* *dy* [*dz*] |
| 746 | Move the active mouse to the specified coordinates *dx* *dy* |
| 747 | with optional scroll axis *dz*. |
| 748 | ERST |
| 749 | |
| 750 | { |
| 751 | .name = "mouse_button", |
| 752 | .args_type = "button_state:i", |
| 753 | .params = "state", |
| 754 | .help = "change mouse button state (1=L, 2=R, 4=M)", |
| 755 | .cmd = hmp_mouse_button, |
| 756 | }, |
| 757 | |
| 758 | SRST |
| 759 | ``mouse_button`` *val* |
| 760 | Change the active mouse button state *val* (1=L, 2=R, 4=M). |
| 761 | ERST |
| 762 | |
| 763 | { |
| 764 | .name = "mouse_set", |
| 765 | .args_type = "index:i", |
| 766 | .params = "index", |
| 767 | .help = "set which mouse device receives events", |
| 768 | .cmd = hmp_mouse_set, |
| 769 | }, |
| 770 | |
| 771 | SRST |
| 772 | ``mouse_set`` *index* |
| 773 | Set which mouse device receives events at given *index*, index |
| 774 | can be obtained with:: |
| 775 | |
| 776 | info mice |
| 777 | |
| 778 | ERST |
| 779 | |
| 780 | /* BEGIN deprecated */ |
| 781 | { |
| 782 | .name = "wavcapture", |
| 783 | .args_type = "path:F,audiodev:s,freq:i?,bits:i?,nchannels:i?", |
| 784 | .params = "path audiodev [frequency [bits [channels]]]", |
| 785 | .help = "capture audio to a wave file (deprecated, default frequency=44100 bits=16 channels=2)", |
| 786 | .cmd = hmp_wavcapture, |
| 787 | }, |
| 788 | SRST |
| 789 | ``wavcapture`` *filename* *audiodev* [*frequency* [*bits* [*channels*]]] |
| 790 | Capture audio into *filename* from *audiodev*, using sample rate |
| 791 | *frequency* bits per sample *bits* and number of channels |
| 792 | *channels*. |
| 793 | |
| 794 | Defaults: |
| 795 | |
| 796 | - Sample rate = 44100 Hz - CD quality |
| 797 | - Bits = 16 |
| 798 | - Number of channels = 2 - Stereo |
| 799 | |
| 800 | Deprecated. |
| 801 | ERST |
| 802 | |
| 803 | { |
| 804 | .name = "stopcapture", |
| 805 | .args_type = "n:i", |
| 806 | .params = "capture index", |
| 807 | .help = "stop capture (deprecated)", |
| 808 | .cmd = hmp_stopcapture, |
| 809 | }, |
| 810 | SRST |
| 811 | ``stopcapture`` *index* |
| 812 | Stop capture with a given *index*, index can be obtained with:: |
| 813 | |
| 814 | info capture |
| 815 | |
| 816 | Deprecated. |
| 817 | ERST |
| 818 | /* END deprecated */ |
| 819 | |
| 820 | { |
| 821 | .name = "memsave", |
| 822 | .args_type = "val:l,size:i,filename:s", |
| 823 | .params = "addr size file", |
| 824 | .help = "save to disk virtual memory dump starting at 'addr' of size 'size'", |
| 825 | .cmd = hmp_memsave, |
| 826 | }, |
| 827 | |
| 828 | SRST |
| 829 | ``memsave`` *addr* *size* *file* |
| 830 | save to disk virtual memory dump starting at *addr* of size *size*. |
| 831 | ERST |
| 832 | |
| 833 | { |
| 834 | .name = "pmemsave", |
| 835 | .args_type = "val:l,size:i,filename:s", |
| 836 | .params = "addr size file", |
| 837 | .help = "save to disk physical memory dump starting at 'addr' of size 'size'", |
| 838 | .cmd = hmp_pmemsave, |
| 839 | }, |
| 840 | |
| 841 | SRST |
| 842 | ``pmemsave`` *addr* *size* *file* |
| 843 | save to disk physical memory dump starting at *addr* of size *size*. |
| 844 | ERST |
| 845 | |
| 846 | { |
| 847 | .name = "boot_set", |
| 848 | .args_type = "bootdevice:s", |
| 849 | .params = "bootdevice", |
| 850 | .help = "define new values for the boot device list", |
| 851 | .cmd = hmp_boot_set, |
| 852 | }, |
| 853 | |
| 854 | SRST |
| 855 | ``boot_set`` *bootdevicelist* |
| 856 | Define new values for the boot device list. Those values will override |
| 857 | the values specified on the command line through the ``-boot`` option. |
| 858 | |
| 859 | The values that can be specified here depend on the machine type, but are |
| 860 | the same that can be specified in the ``-boot`` command line option. |
| 861 | ERST |
| 862 | |
| 863 | { |
| 864 | .name = "nmi", |
| 865 | .args_type = "", |
| 866 | .params = "", |
| 867 | .help = "Inject an NMI, in a machine-specific way", |
| 868 | .cmd = hmp_nmi, |
| 869 | }, |
| 870 | SRST |
| 871 | ``nmi`` |
| 872 | Inject an NMI, in a machine-specific way. |
| 873 | Not all machines implement NMI handling. |
| 874 | ERST |
| 875 | |
| 876 | { |
| 877 | .name = "ringbuf_write", |
| 878 | .args_type = "device:s,data:s", |
| 879 | .params = "device data", |
| 880 | .help = "Write to a ring buffer character device", |
| 881 | .cmd = hmp_ringbuf_write, |
| 882 | .command_completion = ringbuf_write_completion, |
| 883 | }, |
| 884 | |
| 885 | SRST |
| 886 | ``ringbuf_write`` *device* *data* |
| 887 | Write *data* to ring buffer character device *device*. |
| 888 | *data* must be a UTF-8 string. |
| 889 | ERST |
| 890 | |
| 891 | { |
| 892 | .name = "ringbuf_read", |
| 893 | .args_type = "device:s,size:i", |
| 894 | .params = "device size", |
| 895 | .help = "Read from a ring buffer character device", |
| 896 | .cmd = hmp_ringbuf_read, |
| 897 | .command_completion = ringbuf_write_completion, |
| 898 | }, |
| 899 | |
| 900 | SRST |
| 901 | ``ringbuf_read`` *device* |
| 902 | Read and print up to *size* bytes from ring buffer character |
| 903 | device *device*. |
| 904 | Certain non-printable characters are printed ``\uXXXX``, where ``XXXX`` is the |
| 905 | character code in hexadecimal. Character ``\`` is printed ``\\``. |
| 906 | Bug: can screw up when the buffer contains invalid UTF-8 sequences, |
| 907 | NUL characters, after the ring buffer lost data, and when reading |
| 908 | stops because the size limit is reached. |
| 909 | ERST |
| 910 | |
| 911 | { |
| 912 | .name = "announce_self", |
| 913 | .args_type = "interfaces:s?,id:s?", |
| 914 | .params = "[interfaces] [id]", |
| 915 | .help = "Trigger GARP/RARP announcements", |
| 916 | .cmd = hmp_announce_self, |
| 917 | }, |
| 918 | |
| 919 | SRST |
| 920 | ``announce_self`` |
| 921 | Trigger a round of GARP/RARP broadcasts; this is useful for explicitly |
| 922 | updating the network infrastructure after a reconfiguration or some forms |
| 923 | of migration. The timings of the round are set by the migration announce |
| 924 | parameters. An optional comma separated *interfaces* list restricts the |
| 925 | announce to the named set of interfaces. An optional *id* can be used to |
| 926 | start a separate announce timer and to change the parameters of it later. |
| 927 | ERST |
| 928 | |
| 929 | { |
| 930 | .name = "migrate", |
| 931 | .args_type = "detach:-d,resume:-r,uri-cpr:-cs,uri:s", |
| 932 | .params = "[-d] [-r] [-c uri-cpr] uri", |
| 933 | .help = "migrate to URI (using -d to not wait for completion)" |
| 934 | "\n\t\t\t -r to resume a paused postcopy migration" |
| 935 | "\n\t\t\t -c to specify a CPR URI for cpr-transfer mode", |
| 936 | .cmd = hmp_migrate, |
| 937 | }, |
| 938 | |
| 939 | |
| 940 | SRST |
| 941 | ``migrate [-d] [-r] [-c uri-cpr]`` *uri* |
| 942 | Migrate the VM to *uri*. |
| 943 | |
| 944 | ``-d`` |
| 945 | Start the migration process, but do not wait for its completion. To |
| 946 | query an ongoing migration process, use "info migrate". |
| 947 | ``-r`` |
| 948 | Resume a paused postcopy migration. |
| 949 | ``-c`` *uri-cpr* |
| 950 | Specify the CPR URI for cpr-transfer mode. It must be a UNIX domain |
| 951 | socket. |
| 952 | ERST |
| 953 | |
| 954 | { |
| 955 | .name = "migrate_cancel", |
| 956 | .args_type = "", |
| 957 | .params = "", |
| 958 | .help = "cancel the current VM migration", |
| 959 | .cmd = hmp_migrate_cancel, |
| 960 | }, |
| 961 | |
| 962 | SRST |
| 963 | ``migrate_cancel`` |
| 964 | Cancel the current VM migration. |
| 965 | ERST |
| 966 | |
| 967 | { |
| 968 | .name = "migrate_continue", |
| 969 | .args_type = "state:s", |
| 970 | .params = "state", |
| 971 | .help = "Continue migration from the given paused state", |
| 972 | .cmd = hmp_migrate_continue, |
| 973 | }, |
| 974 | SRST |
| 975 | ``migrate_continue`` *state* |
| 976 | Continue migration from the paused state *state* |
| 977 | ERST |
| 978 | |
| 979 | { |
| 980 | .name = "migrate_incoming", |
| 981 | .args_type = "uri:s", |
| 982 | .params = "uri", |
| 983 | .help = "Continue an incoming migration from an -incoming defer", |
| 984 | .cmd = hmp_migrate_incoming, |
| 985 | }, |
| 986 | |
| 987 | SRST |
| 988 | ``migrate_incoming`` *uri* |
| 989 | Continue an incoming migration using the *uri* (that has the same syntax |
| 990 | as the ``-incoming`` option). |
| 991 | ERST |
| 992 | |
| 993 | { |
| 994 | .name = "migrate_recover", |
| 995 | .args_type = "uri:s", |
| 996 | .params = "uri", |
| 997 | .help = "Continue a paused incoming postcopy migration", |
| 998 | .cmd = hmp_migrate_recover, |
| 999 | }, |
| 1000 | |
| 1001 | SRST |
| 1002 | ``migrate_recover`` *uri* |
| 1003 | Continue a paused incoming postcopy migration using the *uri*. |
| 1004 | ERST |
| 1005 | |
| 1006 | { |
| 1007 | .name = "migrate_pause", |
| 1008 | .args_type = "", |
| 1009 | .params = "", |
| 1010 | .help = "Pause an ongoing migration (postcopy-only)", |
| 1011 | .cmd = hmp_migrate_pause, |
| 1012 | }, |
| 1013 | |
| 1014 | SRST |
| 1015 | ``migrate_pause`` |
| 1016 | Pause an ongoing migration. Currently it only supports postcopy. |
| 1017 | ERST |
| 1018 | |
| 1019 | { |
| 1020 | .name = "migrate_set_capability", |
| 1021 | .args_type = "capability:s,state:b", |
| 1022 | .params = "capability state", |
| 1023 | .help = "Enable/Disable the usage of a capability for migration", |
| 1024 | .cmd = hmp_migrate_set_capability, |
| 1025 | .command_completion = migrate_set_capability_completion, |
| 1026 | }, |
| 1027 | |
| 1028 | SRST |
| 1029 | ``migrate_set_capability`` *capability* *state* |
| 1030 | Enable/Disable the usage of a capability *capability* for migration. |
| 1031 | ERST |
| 1032 | |
| 1033 | { |
| 1034 | .name = "migrate_set_parameter", |
| 1035 | .args_type = "parameter:s,value:S", |
| 1036 | .params = "parameter value", |
| 1037 | .help = "Set the parameter for migration", |
| 1038 | .cmd = hmp_migrate_set_parameter, |
| 1039 | .command_completion = migrate_set_parameter_completion, |
| 1040 | }, |
| 1041 | |
| 1042 | SRST |
| 1043 | ``migrate_set_parameter`` *parameter* *value* |
| 1044 | Set the parameter *parameter* for migration. |
| 1045 | ERST |
| 1046 | |
| 1047 | { |
| 1048 | .name = "migrate_start_postcopy", |
| 1049 | .args_type = "", |
| 1050 | .params = "", |
| 1051 | .help = "Followup to a migration command to switch the migration" |
| 1052 | " to postcopy mode. The postcopy-ram capability must " |
| 1053 | "be set on both source and destination before the " |
| 1054 | "original migration command .", |
| 1055 | .cmd = hmp_migrate_start_postcopy, |
| 1056 | }, |
| 1057 | |
| 1058 | SRST |
| 1059 | ``migrate_start_postcopy`` |
| 1060 | Switch in-progress migration to postcopy mode. Ignored after the end of |
| 1061 | migration (or once already in postcopy). |
| 1062 | ERST |
| 1063 | |
| 1064 | #ifdef CONFIG_REPLICATION |
| 1065 | { |
| 1066 | .name = "x_colo_lost_heartbeat", |
| 1067 | .args_type = "", |
| 1068 | .params = "", |
| 1069 | .help = "Tell COLO that heartbeat is lost,\n\t\t\t" |
| 1070 | "a failover or takeover is needed.", |
| 1071 | .cmd = hmp_x_colo_lost_heartbeat, |
| 1072 | }, |
| 1073 | #endif |
| 1074 | |
| 1075 | SRST |
| 1076 | ``x_colo_lost_heartbeat`` |
| 1077 | Tell COLO that heartbeat is lost, a failover or takeover is needed. |
| 1078 | ERST |
| 1079 | |
| 1080 | { |
| 1081 | .name = "client_migrate_info", |
| 1082 | .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?", |
| 1083 | .params = "protocol hostname port tls-port cert-subject", |
| 1084 | .help = "set migration information for remote display", |
| 1085 | .cmd = hmp_client_migrate_info, |
| 1086 | }, |
| 1087 | |
| 1088 | SRST |
| 1089 | ``client_migrate_info`` *protocol* *hostname* *port* *tls-port* *cert-subject* |
| 1090 | Set migration information for remote display. This makes the server |
| 1091 | ask the client to automatically reconnect using the new parameters |
| 1092 | once migration finished successfully. Only implemented for SPICE. |
| 1093 | ERST |
| 1094 | |
| 1095 | { |
| 1096 | .name = "dump-guest-memory", |
| 1097 | .args_type = "paging:-p,detach:-d,windmp:-w,zlib:-z,lzo:-l,snappy:-s,raw:-R,filename:F,begin:l?,length:l?", |
| 1098 | .params = "[-p] [-d] [-z|-l|-s|-w] [-R] filename [begin length]", |
| 1099 | .help = "dump guest memory into file 'filename'.\n\t\t\t" |
| 1100 | "-p: do paging to get guest's memory mapping.\n\t\t\t" |
| 1101 | "-d: return immediately (do not wait for completion).\n\t\t\t" |
| 1102 | "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t" |
| 1103 | "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t" |
| 1104 | "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t" |
| 1105 | "-R: when using kdump (-z, -l, -s), use raw rather than makedumpfile-flattened\n\t\t\t" |
| 1106 | " format\n\t\t\t" |
| 1107 | "-w: dump in Windows crashdump format (can be used instead of ELF-dump converting),\n\t\t\t" |
| 1108 | " for Windows x86 and x64 guests with vmcoreinfo driver only.\n\t\t\t" |
| 1109 | "begin: the starting physical address.\n\t\t\t" |
| 1110 | "length: the memory size, in bytes.", |
| 1111 | .cmd = hmp_dump_guest_memory, |
| 1112 | }, |
| 1113 | |
| 1114 | SRST |
| 1115 | ``dump-guest-memory [-p]`` *filename* *begin* *length* |
| 1116 | \ |
| 1117 | ``dump-guest-memory [-z|-l|-s|-w]`` *filename* |
| 1118 | Dump guest memory to *protocol*. The file can be processed with crash or |
| 1119 | gdb. Without ``-z|-l|-s|-w``, the dump format is ELF. |
| 1120 | |
| 1121 | ``-p`` |
| 1122 | do paging to get guest's memory mapping. |
| 1123 | ``-z`` |
| 1124 | dump in kdump-compressed format, with zlib compression. |
| 1125 | ``-l`` |
| 1126 | dump in kdump-compressed format, with lzo compression. |
| 1127 | ``-s`` |
| 1128 | dump in kdump-compressed format, with snappy compression. |
| 1129 | ``-R`` |
| 1130 | when using kdump (-z, -l, -s), use raw rather than makedumpfile-flattened |
| 1131 | format |
| 1132 | ``-w`` |
| 1133 | dump in Windows crashdump format (can be used instead of ELF-dump converting), |
| 1134 | for Windows x64 guests with vmcoreinfo driver only |
| 1135 | *filename* |
| 1136 | dump file name. |
| 1137 | *begin* |
| 1138 | the starting physical address. It's optional, and should be |
| 1139 | specified together with *length*. |
| 1140 | *length* |
| 1141 | the memory size, in bytes. It's optional, and should be specified |
| 1142 | together with *begin*. |
| 1143 | |
| 1144 | ERST |
| 1145 | |
| 1146 | { |
| 1147 | .name = "dump-skeys", |
| 1148 | .args_type = "filename:F", |
| 1149 | .params = "", |
| 1150 | .help = "Save guest storage keys into file 'filename'.\n", |
| 1151 | .cmd = hmp_dump_skeys, |
| 1152 | .arch_bitmask = QEMU_ARCH_S390X, |
| 1153 | }, |
| 1154 | |
| 1155 | SRST |
| 1156 | ``dump-skeys`` *filename* |
| 1157 | Save guest storage keys to a file. |
| 1158 | ERST |
| 1159 | |
| 1160 | { |
| 1161 | .name = "migration_mode", |
| 1162 | .args_type = "mode:i", |
| 1163 | .params = "mode", |
| 1164 | .help = "Enables or disables migration mode\n", |
| 1165 | .cmd = hmp_migrationmode, |
| 1166 | .arch_bitmask = QEMU_ARCH_S390X, |
| 1167 | }, |
| 1168 | |
| 1169 | SRST |
| 1170 | ``migration_mode`` *mode* |
| 1171 | Enables or disables migration mode. |
| 1172 | ERST |
| 1173 | |
| 1174 | { |
| 1175 | .name = "snapshot_blkdev", |
| 1176 | .args_type = "reuse:-n,device:B,snapshot-file:s,format:s?", |
| 1177 | .params = "[-n] device [new-image-file] [format]", |
| 1178 | .help = "initiates a live snapshot\n\t\t\t" |
| 1179 | "of device. If a new image file is specified, the\n\t\t\t" |
| 1180 | "new image file will become the new root image.\n\t\t\t" |
| 1181 | "If format is specified, the snapshot file will\n\t\t\t" |
| 1182 | "be created in that format.\n\t\t\t" |
| 1183 | "The default format is qcow2. The -n flag requests QEMU\n\t\t\t" |
| 1184 | "to reuse the image found in new-image-file, instead of\n\t\t\t" |
| 1185 | "recreating it from scratch.", |
| 1186 | .cmd = hmp_snapshot_blkdev, |
| 1187 | }, |
| 1188 | |
| 1189 | SRST |
| 1190 | ``snapshot_blkdev`` |
| 1191 | Snapshot device, using snapshot file as target if provided |
| 1192 | ERST |
| 1193 | |
| 1194 | { |
| 1195 | .name = "snapshot_blkdev_internal", |
| 1196 | .args_type = "device:B,name:s", |
| 1197 | .params = "device name", |
| 1198 | .help = "take an internal snapshot of device.\n\t\t\t" |
| 1199 | "The format of the image used by device must\n\t\t\t" |
| 1200 | "support it, such as qcow2.\n\t\t\t", |
| 1201 | .cmd = hmp_snapshot_blkdev_internal, |
| 1202 | }, |
| 1203 | |
| 1204 | SRST |
| 1205 | ``snapshot_blkdev_internal`` |
| 1206 | Take an internal snapshot on device if it support |
| 1207 | ERST |
| 1208 | |
| 1209 | { |
| 1210 | .name = "snapshot_delete_blkdev_internal", |
| 1211 | .args_type = "device:B,name:s,id:s?", |
| 1212 | .params = "device name [id]", |
| 1213 | .help = "delete an internal snapshot of device.\n\t\t\t" |
| 1214 | "If id is specified, qemu will try delete\n\t\t\t" |
| 1215 | "the snapshot matching both id and name.\n\t\t\t" |
| 1216 | "The format of the image used by device must\n\t\t\t" |
| 1217 | "support it, such as qcow2.\n\t\t\t", |
| 1218 | .cmd = hmp_snapshot_delete_blkdev_internal, |
| 1219 | }, |
| 1220 | |
| 1221 | SRST |
| 1222 | ``snapshot_delete_blkdev_internal`` |
| 1223 | Delete an internal snapshot on device if it support |
| 1224 | ERST |
| 1225 | |
| 1226 | { |
| 1227 | .name = "drive_mirror", |
| 1228 | .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?", |
| 1229 | .params = "[-n] [-f] device target [format]", |
| 1230 | .help = "initiates live storage\n\t\t\t" |
| 1231 | "migration for a device. The device's contents are\n\t\t\t" |
| 1232 | "copied to the new image file, including data that\n\t\t\t" |
| 1233 | "is written after the command is started.\n\t\t\t" |
| 1234 | "The -n flag requests QEMU to reuse the image found\n\t\t\t" |
| 1235 | "in new-image-file, instead of recreating it from scratch.\n\t\t\t" |
| 1236 | "The -f flag requests QEMU to copy the whole disk,\n\t\t\t" |
| 1237 | "so that the result does not need a backing file.\n\t\t\t", |
| 1238 | .cmd = hmp_drive_mirror, |
| 1239 | }, |
| 1240 | SRST |
| 1241 | ``drive_mirror`` |
| 1242 | Start mirroring a block device's writes to a new destination, |
| 1243 | using the specified target. |
| 1244 | ERST |
| 1245 | |
| 1246 | { |
| 1247 | .name = "drive_backup", |
| 1248 | .args_type = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?", |
| 1249 | .params = "[-n] [-f] [-c] device target [format]", |
| 1250 | .help = "initiates a point-in-time\n\t\t\t" |
| 1251 | "copy for a device. The device's contents are\n\t\t\t" |
| 1252 | "copied to the new image file, excluding data that\n\t\t\t" |
| 1253 | "is written after the command is started.\n\t\t\t" |
| 1254 | "The -n flag requests QEMU to reuse the image found\n\t\t\t" |
| 1255 | "in new-image-file, instead of recreating it from scratch.\n\t\t\t" |
| 1256 | "The -f flag requests QEMU to copy the whole disk,\n\t\t\t" |
| 1257 | "so that the result does not need a backing file.\n\t\t\t" |
| 1258 | "The -c flag requests QEMU to compress backup data\n\t\t\t" |
| 1259 | "(if the target format supports it).\n\t\t\t", |
| 1260 | .cmd = hmp_drive_backup, |
| 1261 | }, |
| 1262 | SRST |
| 1263 | ``drive_backup`` |
| 1264 | Start a point-in-time copy of a block device to a specified target. |
| 1265 | ERST |
| 1266 | |
| 1267 | { |
| 1268 | .name = "drive_add", |
| 1269 | .args_type = "node:-n,pci_addr:s,opts:s", |
| 1270 | .params = "[-n] [[<domain>:]<bus>:]<slot>\n" |
| 1271 | "[file=file][,if=type][,bus=n]\n" |
| 1272 | "[,unit=m][,media=d][,index=i]\n" |
| 1273 | "[,snapshot=on|off][,cache=on|off]\n" |
| 1274 | "[,readonly=on|off][,copy-on-read=on|off]", |
| 1275 | .help = "add drive to PCI storage controller", |
| 1276 | .cmd = hmp_drive_add, |
| 1277 | }, |
| 1278 | |
| 1279 | SRST |
| 1280 | ``drive_add`` |
| 1281 | Add drive to PCI storage controller. |
| 1282 | ERST |
| 1283 | |
| 1284 | { |
| 1285 | .name = "pcie_aer_inject_error", |
| 1286 | .args_type = "advisory_non_fatal:-a,correctable:-c," |
| 1287 | "id:s,error_status:s," |
| 1288 | "header0:i?,header1:i?,header2:i?,header3:i?," |
| 1289 | "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?", |
| 1290 | .params = "[-a] [-c] id " |
| 1291 | "<error_status> [<tlp header> [<tlp header prefix>]]", |
| 1292 | .help = "inject pcie aer error\n\t\t\t" |
| 1293 | " -a for advisory non fatal error\n\t\t\t" |
| 1294 | " -c for correctable error\n\t\t\t" |
| 1295 | "<id> = qdev device id\n\t\t\t" |
| 1296 | "<error_status> = error string or 32bit\n\t\t\t" |
| 1297 | "<tlp header> = 32bit x 4\n\t\t\t" |
| 1298 | "<tlp header prefix> = 32bit x 4", |
| 1299 | .cmd = hmp_pcie_aer_inject_error, |
| 1300 | }, |
| 1301 | |
| 1302 | SRST |
| 1303 | ``pcie_aer_inject_error`` |
| 1304 | Inject PCIe AER error |
| 1305 | ERST |
| 1306 | |
| 1307 | { |
| 1308 | .name = "netdev_add", |
| 1309 | .args_type = "netdev:O", |
| 1310 | .params = "[user|tap|socket|stream|dgram|vde|bridge|hubport|netmap|vhost-user" |
| 1311 | #ifdef CONFIG_PASST |
| 1312 | "|passt" |
| 1313 | #endif |
| 1314 | #ifdef CONFIG_AF_XDP |
| 1315 | "|af-xdp" |
| 1316 | #endif |
| 1317 | #ifdef CONFIG_VMNET |
| 1318 | "|vmnet-host|vmnet-shared|vmnet-bridged" |
| 1319 | #endif |
| 1320 | "],id=str[,prop=value][,...]", |
| 1321 | .help = "add host network device", |
| 1322 | .cmd = hmp_netdev_add, |
| 1323 | .command_completion = netdev_add_completion, |
| 1324 | .flags = "p", |
| 1325 | }, |
| 1326 | |
| 1327 | SRST |
| 1328 | ``netdev_add`` |
| 1329 | Add host network device. |
| 1330 | ERST |
| 1331 | |
| 1332 | { |
| 1333 | .name = "netdev_del", |
| 1334 | .args_type = "id:s", |
| 1335 | .params = "id", |
| 1336 | .help = "remove host network device", |
| 1337 | .cmd = hmp_netdev_del, |
| 1338 | .command_completion = netdev_del_completion, |
| 1339 | .flags = "p", |
| 1340 | }, |
| 1341 | |
| 1342 | SRST |
| 1343 | ``netdev_del`` |
| 1344 | Remove host network device. |
| 1345 | ERST |
| 1346 | |
| 1347 | { |
| 1348 | .name = "object_add", |
| 1349 | .args_type = "object:S", |
| 1350 | .params = "[qom-type=]type,id=str[,prop=value][,...]", |
| 1351 | .help = "create QOM object", |
| 1352 | .cmd = hmp_object_add, |
| 1353 | .command_completion = object_add_completion, |
| 1354 | .flags = "p", |
| 1355 | }, |
| 1356 | |
| 1357 | SRST |
| 1358 | ``object_add`` |
| 1359 | Create QOM object. |
| 1360 | ERST |
| 1361 | |
| 1362 | { |
| 1363 | .name = "object_del", |
| 1364 | .args_type = "id:s", |
| 1365 | .params = "id", |
| 1366 | .help = "destroy QOM object", |
| 1367 | .cmd = hmp_object_del, |
| 1368 | .command_completion = object_del_completion, |
| 1369 | .flags = "p", |
| 1370 | }, |
| 1371 | |
| 1372 | SRST |
| 1373 | ``object_del`` |
| 1374 | Destroy QOM object. |
| 1375 | ERST |
| 1376 | |
| 1377 | #ifdef CONFIG_SLIRP |
| 1378 | { |
| 1379 | .name = "hostfwd_add", |
| 1380 | .args_type = "arg1:s,arg2:s?", |
| 1381 | .params = "[netdev_id] [tcp|udp|unix]:[[hostaddr]:hostport|hostpath]-[guestaddr]:guestport", |
| 1382 | .help = "redirect TCP, UDP or UNIX connections from host to guest (requires -net user)", |
| 1383 | .cmd = hmp_hostfwd_add, |
| 1384 | }, |
| 1385 | #endif |
| 1386 | SRST |
| 1387 | ``hostfwd_add`` |
| 1388 | Redirect TCP or UDP connections from host to guest (requires -net user). |
| 1389 | ERST |
| 1390 | |
| 1391 | #ifdef CONFIG_SLIRP |
| 1392 | { |
| 1393 | .name = "hostfwd_remove", |
| 1394 | .args_type = "arg1:s,arg2:s?", |
| 1395 | .params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport", |
| 1396 | .help = "remove host-to-guest TCP or UDP redirection", |
| 1397 | .cmd = hmp_hostfwd_remove, |
| 1398 | }, |
| 1399 | |
| 1400 | #endif |
| 1401 | SRST |
| 1402 | ``hostfwd_remove`` |
| 1403 | Remove host-to-guest TCP or UDP redirection. |
| 1404 | ERST |
| 1405 | |
| 1406 | { |
| 1407 | .name = "balloon", |
| 1408 | .args_type = "value:M", |
| 1409 | .params = "target", |
| 1410 | .help = "request VM to change its memory allocation (in MB)", |
| 1411 | .cmd = hmp_balloon, |
| 1412 | }, |
| 1413 | |
| 1414 | SRST |
| 1415 | ``balloon`` *value* |
| 1416 | Request VM to change its memory allocation to *value* (in MB). |
| 1417 | ERST |
| 1418 | |
| 1419 | { |
| 1420 | .name = "set_link", |
| 1421 | .args_type = "name:s,up:b", |
| 1422 | .params = "name on|off", |
| 1423 | .help = "change the link status of a network adapter", |
| 1424 | .cmd = hmp_set_link, |
| 1425 | .command_completion = set_link_completion, |
| 1426 | }, |
| 1427 | |
| 1428 | SRST |
| 1429 | ``set_link`` *name* ``[on|off]`` |
| 1430 | Switch link *name* on (i.e. up) or off (i.e. down). |
| 1431 | ERST |
| 1432 | |
| 1433 | { |
| 1434 | .name = "watchdog_action", |
| 1435 | .args_type = "action:s", |
| 1436 | .params = "[reset|shutdown|poweroff|pause|debug|none|inject-nmi]", |
| 1437 | .help = "change watchdog action", |
| 1438 | .cmd = hmp_watchdog_action, |
| 1439 | .command_completion = watchdog_action_completion, |
| 1440 | }, |
| 1441 | |
| 1442 | SRST |
| 1443 | ``watchdog_action`` |
| 1444 | Change watchdog action. |
| 1445 | ERST |
| 1446 | |
| 1447 | { |
| 1448 | .name = "nbd_server_start", |
| 1449 | .args_type = "all:-a,writable:-w,uri:s", |
| 1450 | .params = "nbd_server_start [-a] [-w] host:port", |
| 1451 | .help = "serve block devices on the given host and port", |
| 1452 | .cmd = hmp_nbd_server_start, |
| 1453 | .flags = "p", |
| 1454 | }, |
| 1455 | SRST |
| 1456 | ``nbd_server_start`` *host*:*port* |
| 1457 | Start an NBD server on the given host and/or port. If the ``-a`` |
| 1458 | option is included, all of the virtual machine's block devices that |
| 1459 | have an inserted media on them are automatically exported; in this case, |
| 1460 | the ``-w`` option makes the devices writable too. |
| 1461 | ERST |
| 1462 | |
| 1463 | { |
| 1464 | .name = "nbd_server_add", |
| 1465 | .args_type = "writable:-w,device:B,name:s?", |
| 1466 | .params = "nbd_server_add [-w] device [name]", |
| 1467 | .help = "export a block device via NBD", |
| 1468 | .cmd = hmp_nbd_server_add, |
| 1469 | .flags = "p", |
| 1470 | }, |
| 1471 | SRST |
| 1472 | ``nbd_server_add`` *device* [ *name* ] |
| 1473 | Export a block device through QEMU's NBD server, which must be started |
| 1474 | beforehand with ``nbd_server_start``. The ``-w`` option makes the |
| 1475 | exported device writable too. The export name is controlled by *name*, |
| 1476 | defaulting to *device*. |
| 1477 | ERST |
| 1478 | |
| 1479 | { |
| 1480 | .name = "nbd_server_remove", |
| 1481 | .args_type = "force:-f,name:s", |
| 1482 | .params = "nbd_server_remove [-f] name", |
| 1483 | .help = "remove an export previously exposed via NBD", |
| 1484 | .cmd = hmp_nbd_server_remove, |
| 1485 | .flags = "p", |
| 1486 | }, |
| 1487 | SRST |
| 1488 | ``nbd_server_remove [-f]`` *name* |
| 1489 | Stop exporting a block device through QEMU's NBD server, which was |
| 1490 | previously started with ``nbd_server_add``. The ``-f`` |
| 1491 | option forces the server to drop the export immediately even if |
| 1492 | clients are connected; otherwise the command fails unless there are no |
| 1493 | clients. |
| 1494 | ERST |
| 1495 | |
| 1496 | { |
| 1497 | .name = "nbd_server_stop", |
| 1498 | .args_type = "", |
| 1499 | .params = "nbd_server_stop", |
| 1500 | .help = "stop serving block devices using the NBD protocol", |
| 1501 | .cmd = hmp_nbd_server_stop, |
| 1502 | .flags = "p", |
| 1503 | }, |
| 1504 | SRST |
| 1505 | ``nbd_server_stop`` |
| 1506 | Stop the QEMU embedded NBD server. |
| 1507 | ERST |
| 1508 | |
| 1509 | { |
| 1510 | .name = "mce", |
| 1511 | .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l", |
| 1512 | .params = "[-b] cpu bank status mcgstatus addr misc", |
| 1513 | .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]", |
| 1514 | .cmd = hmp_mce, |
| 1515 | .arch_bitmask = QEMU_ARCH_I386, |
| 1516 | }, |
| 1517 | |
| 1518 | SRST |
| 1519 | ``mce`` *cpu* *bank* *status* *mcgstatus* *addr* *misc* |
| 1520 | Inject an MCE on the given CPU (x86 only). |
| 1521 | ERST |
| 1522 | |
| 1523 | #ifdef CONFIG_POSIX |
| 1524 | { |
| 1525 | .name = "getfd", |
| 1526 | .args_type = "fdname:s", |
| 1527 | .params = "getfd name", |
| 1528 | .help = "receive a file descriptor via SCM rights and assign it a name", |
| 1529 | .cmd = hmp_getfd, |
| 1530 | .flags = "p", |
| 1531 | }, |
| 1532 | |
| 1533 | SRST |
| 1534 | ``getfd`` *fdname* |
| 1535 | If a file descriptor is passed alongside this command using the SCM_RIGHTS |
| 1536 | mechanism on unix sockets, it is stored using the name *fdname* for |
| 1537 | later use by other monitor commands. |
| 1538 | ERST |
| 1539 | #endif |
| 1540 | |
| 1541 | { |
| 1542 | .name = "closefd", |
| 1543 | .args_type = "fdname:s", |
| 1544 | .params = "closefd name", |
| 1545 | .help = "close a file descriptor previously passed via SCM rights", |
| 1546 | .cmd = hmp_closefd, |
| 1547 | .flags = "p", |
| 1548 | }, |
| 1549 | |
| 1550 | SRST |
| 1551 | ``closefd`` *fdname* |
| 1552 | Close the file descriptor previously assigned to *fdname* using the |
| 1553 | ``getfd`` command. This is only needed if the file descriptor was never |
| 1554 | used by another monitor command. |
| 1555 | ERST |
| 1556 | |
| 1557 | { |
| 1558 | .name = "block_set_io_throttle", |
| 1559 | .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l", |
| 1560 | .params = "device bps bps_rd bps_wr iops iops_rd iops_wr", |
| 1561 | .help = "change I/O throttle limits for a block drive", |
| 1562 | .cmd = hmp_block_set_io_throttle, |
| 1563 | .flags = "p", |
| 1564 | }, |
| 1565 | |
| 1566 | SRST |
| 1567 | ``block_set_io_throttle`` *device* *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr* |
| 1568 | Change I/O throttle limits for a block drive to |
| 1569 | *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr*. |
| 1570 | *device* can be a block device name, a qdev ID or a QOM path. |
| 1571 | ERST |
| 1572 | |
| 1573 | { |
| 1574 | .name = "set_password", |
| 1575 | .args_type = "protocol:s,password:s,display:-ds,connected:s?", |
| 1576 | .params = "protocol password [-d display] [action-if-connected]", |
| 1577 | .help = "set spice/vnc password", |
| 1578 | .cmd = hmp_set_password, |
| 1579 | }, |
| 1580 | |
| 1581 | SRST |
| 1582 | ``set_password [ vnc | spice ] password [ -d display ] [ action-if-connected ]`` |
| 1583 | Change spice/vnc password. *display* can be used with 'vnc' to specify |
| 1584 | which display to set the password on. *action-if-connected* specifies |
| 1585 | what should happen in case a connection is established: *fail* makes |
| 1586 | the password change fail. *disconnect* changes the password and |
| 1587 | disconnects the client. *keep* changes the password and keeps the |
| 1588 | connection up. *keep* is the default. |
| 1589 | ERST |
| 1590 | |
| 1591 | { |
| 1592 | .name = "expire_password", |
| 1593 | .args_type = "protocol:s,time:s,display:-ds", |
| 1594 | .params = "protocol time [-d display]", |
| 1595 | .help = "set spice/vnc password expire-time", |
| 1596 | .cmd = hmp_expire_password, |
| 1597 | }, |
| 1598 | |
| 1599 | SRST |
| 1600 | ``expire_password [ vnc | spice ] expire-time [ -d display ]`` |
| 1601 | Specify when a password for spice/vnc becomes invalid. |
| 1602 | *display* behaves the same as in ``set_password``. |
| 1603 | *expire-time* accepts: |
| 1604 | |
| 1605 | ``now`` |
| 1606 | Invalidate password instantly. |
| 1607 | ``never`` |
| 1608 | Password stays valid forever. |
| 1609 | ``+``\ *nsec* |
| 1610 | Password stays valid for *nsec* seconds starting now. |
| 1611 | *nsec* |
| 1612 | Password is invalidated at the given time. *nsec* are the seconds |
| 1613 | passed since 1970, i.e. unix epoch. |
| 1614 | |
| 1615 | ERST |
| 1616 | |
| 1617 | { |
| 1618 | .name = "chardev-add", |
| 1619 | .args_type = "args:s", |
| 1620 | .params = "args", |
| 1621 | .help = "add chardev", |
| 1622 | .cmd = hmp_chardev_add, |
| 1623 | .command_completion = chardev_add_completion, |
| 1624 | }, |
| 1625 | |
| 1626 | SRST |
| 1627 | ``chardev-add`` *args* |
| 1628 | chardev-add accepts the same parameters as the -chardev command line switch. |
| 1629 | ERST |
| 1630 | |
| 1631 | { |
| 1632 | .name = "chardev-change", |
| 1633 | .args_type = "id:s,args:s", |
| 1634 | .params = "id args", |
| 1635 | .help = "change chardev", |
| 1636 | .cmd = hmp_chardev_change, |
| 1637 | }, |
| 1638 | |
| 1639 | SRST |
| 1640 | ``chardev-change`` *args* |
| 1641 | chardev-change accepts existing chardev *id* and then the same arguments |
| 1642 | as the -chardev command line switch (except for "id"). |
| 1643 | ERST |
| 1644 | |
| 1645 | { |
| 1646 | .name = "chardev-remove", |
| 1647 | .args_type = "id:s", |
| 1648 | .params = "id", |
| 1649 | .help = "remove chardev", |
| 1650 | .cmd = hmp_chardev_remove, |
| 1651 | .command_completion = chardev_remove_completion, |
| 1652 | }, |
| 1653 | |
| 1654 | SRST |
| 1655 | ``chardev-remove`` *id* |
| 1656 | Removes the chardev *id*. |
| 1657 | ERST |
| 1658 | |
| 1659 | { |
| 1660 | .name = "chardev-send-break", |
| 1661 | .args_type = "id:s", |
| 1662 | .params = "id", |
| 1663 | .help = "send a break on chardev", |
| 1664 | .cmd = hmp_chardev_send_break, |
| 1665 | .command_completion = chardev_remove_completion, |
| 1666 | }, |
| 1667 | |
| 1668 | SRST |
| 1669 | ``chardev-send-break`` *id* |
| 1670 | Send a break on the chardev *id*. |
| 1671 | ERST |
| 1672 | |
| 1673 | { |
| 1674 | .name = "qemu-io", |
| 1675 | .args_type = "qdev:-d,device:B,command:s", |
| 1676 | .params = "[-d] [device] \"[command]\"", |
| 1677 | .help = "run a qemu-io command on a block device\n\t\t\t" |
| 1678 | "-d: [device] is a device ID rather than a " |
| 1679 | "drive ID or node name", |
| 1680 | .cmd = hmp_qemu_io, |
| 1681 | }, |
| 1682 | |
| 1683 | SRST |
| 1684 | ``qemu-io`` *device* *command* |
| 1685 | Executes a qemu-io command on the given block device. |
| 1686 | ERST |
| 1687 | |
| 1688 | { |
| 1689 | .name = "qom-list", |
| 1690 | .args_type = "path:s?", |
| 1691 | .params = "path", |
| 1692 | .help = "list QOM properties", |
| 1693 | .cmd = hmp_qom_list, |
| 1694 | .flags = "p", |
| 1695 | }, |
| 1696 | |
| 1697 | SRST |
| 1698 | ``qom-list`` [*path*] |
| 1699 | Print QOM properties of object at location *path* |
| 1700 | ERST |
| 1701 | |
| 1702 | { |
| 1703 | .name = "qom-get", |
| 1704 | .args_type = "path:s,property:s", |
| 1705 | .params = "path property", |
| 1706 | .help = "print QOM property", |
| 1707 | .cmd = hmp_qom_get, |
| 1708 | .flags = "p", |
| 1709 | }, |
| 1710 | |
| 1711 | SRST |
| 1712 | ``qom-get`` *path* *property* |
| 1713 | Print QOM property *property* of object at location *path* |
| 1714 | ERST |
| 1715 | |
| 1716 | { |
| 1717 | .name = "qom-set", |
| 1718 | .args_type = "json:-j,path:s,property:s,value:S", |
| 1719 | .params = "[-j] path property value", |
| 1720 | .help = "set QOM property.\n\t\t\t" |
| 1721 | "-j: the value is specified in json format.", |
| 1722 | .cmd = hmp_qom_set, |
| 1723 | .flags = "p", |
| 1724 | }, |
| 1725 | |
| 1726 | SRST |
| 1727 | ``qom-set`` *path* *property* *value* |
| 1728 | Set QOM property *property* of object at location *path* to value *value* |
| 1729 | ERST |
| 1730 | |
| 1731 | { |
| 1732 | .name = "replay_break", |
| 1733 | .args_type = "icount:l", |
| 1734 | .params = "icount", |
| 1735 | .help = "set breakpoint at the specified instruction count", |
| 1736 | .cmd = hmp_replay_break, |
| 1737 | }, |
| 1738 | |
| 1739 | SRST |
| 1740 | ``replay_break`` *icount* |
| 1741 | Set replay breakpoint at instruction count *icount*. |
| 1742 | Execution stops when the specified instruction is reached. |
| 1743 | There can be at most one breakpoint. When breakpoint is set, any prior |
| 1744 | one is removed. The breakpoint may be set only in replay mode and only |
| 1745 | "in the future", i.e. at instruction counts greater than the current one. |
| 1746 | The current instruction count can be observed with ``info replay``. |
| 1747 | ERST |
| 1748 | |
| 1749 | { |
| 1750 | .name = "replay_delete_break", |
| 1751 | .args_type = "", |
| 1752 | .params = "", |
| 1753 | .help = "remove replay breakpoint", |
| 1754 | .cmd = hmp_replay_delete_break, |
| 1755 | }, |
| 1756 | |
| 1757 | SRST |
| 1758 | ``replay_delete_break`` |
| 1759 | Remove replay breakpoint which was previously set with ``replay_break``. |
| 1760 | The command is ignored when there are no replay breakpoints. |
| 1761 | ERST |
| 1762 | |
| 1763 | { |
| 1764 | .name = "replay_seek", |
| 1765 | .args_type = "icount:l", |
| 1766 | .params = "icount", |
| 1767 | .help = "replay execution to the specified instruction count", |
| 1768 | .cmd = hmp_replay_seek, |
| 1769 | }, |
| 1770 | |
| 1771 | SRST |
| 1772 | ``replay_seek`` *icount* |
| 1773 | Automatically proceed to the instruction count *icount*, when |
| 1774 | replaying the execution. The command automatically loads nearest |
| 1775 | snapshot and replays the execution to find the desired instruction. |
| 1776 | When there is no preceding snapshot or the execution is not replayed, |
| 1777 | then the command fails. |
| 1778 | *icount* for the reference may be observed with ``info replay`` command. |
| 1779 | ERST |
| 1780 | |
| 1781 | { |
| 1782 | .name = "calc_dirty_rate", |
| 1783 | .args_type = "dirty_ring:-r,dirty_bitmap:-b,second:l,sample_pages_per_GB:l?", |
| 1784 | .params = "[-r] [-b] second [sample_pages_per_GB]", |
| 1785 | .help = "start a round of guest dirty rate measurement (using -r to" |
| 1786 | "\n\t\t\t specify dirty ring as the method of calculation and" |
| 1787 | "\n\t\t\t -b to specify dirty bitmap as method of calculation)", |
| 1788 | .cmd = hmp_calc_dirty_rate, |
| 1789 | }, |
| 1790 | |
| 1791 | SRST |
| 1792 | ``calc_dirty_rate`` *second* |
| 1793 | Start a round of dirty rate measurement with the period specified in *second*. |
| 1794 | The result of the dirty rate measurement may be observed with ``info |
| 1795 | dirty_rate`` command. |
| 1796 | ERST |
| 1797 | |
| 1798 | { |
| 1799 | .name = "set_vcpu_dirty_limit", |
| 1800 | .args_type = "dirty_rate:l,cpu_index:l?", |
| 1801 | .params = "dirty_rate [cpu_index]", |
| 1802 | .help = "set dirty page rate limit, use cpu_index to set limit" |
| 1803 | "\n\t\t\t\t\t on a specified virtual cpu", |
| 1804 | .cmd = hmp_set_vcpu_dirty_limit, |
| 1805 | }, |
| 1806 | |
| 1807 | SRST |
| 1808 | ``set_vcpu_dirty_limit`` |
| 1809 | Set dirty page rate limit on virtual CPU, the information about all the |
| 1810 | virtual CPU dirty limit status can be observed with ``info vcpu_dirty_limit`` |
| 1811 | command. |
| 1812 | ERST |
| 1813 | |
| 1814 | { |
| 1815 | .name = "cancel_vcpu_dirty_limit", |
| 1816 | .args_type = "cpu_index:l?", |
| 1817 | .params = "[cpu_index]", |
| 1818 | .help = "cancel dirty page rate limit, use cpu_index to cancel" |
| 1819 | "\n\t\t\t\t\t limit on a specified virtual cpu", |
| 1820 | .cmd = hmp_cancel_vcpu_dirty_limit, |
| 1821 | }, |
| 1822 | |
| 1823 | SRST |
| 1824 | ``cancel_vcpu_dirty_limit`` |
| 1825 | Cancel dirty page rate limit on virtual CPU, the information about all the |
| 1826 | virtual CPU dirty limit status can be observed with ``info vcpu_dirty_limit`` |
| 1827 | command. |
| 1828 | ERST |
| 1829 | |
| 1830 | #if defined(CONFIG_FDT) |
| 1831 | { |
| 1832 | .name = "dumpdtb", |
| 1833 | .args_type = "filename:F", |
| 1834 | .params = "filename", |
| 1835 | .help = "dump the FDT in dtb format to 'filename'", |
| 1836 | .cmd = hmp_dumpdtb, |
| 1837 | }, |
| 1838 | |
| 1839 | SRST |
| 1840 | ``dumpdtb`` *filename* |
| 1841 | Dump the FDT in dtb format to *filename*. |
| 1842 | ERST |
| 1843 | #endif |
| 1844 | |
| 1845 | { |
| 1846 | .name = "xen-event-inject", |
| 1847 | .args_type = "port:i", |
| 1848 | .params = "port", |
| 1849 | .help = "inject event channel", |
| 1850 | .cmd = hmp_xen_event_inject, |
| 1851 | }, |
| 1852 | |
| 1853 | SRST |
| 1854 | ``xen-event-inject`` *port* |
| 1855 | Notify guest via event channel on port *port*. |
| 1856 | ERST |
| 1857 | |
| 1858 | |
| 1859 | { |
| 1860 | .name = "xen-event-list", |
| 1861 | .args_type = "", |
| 1862 | .params = "", |
| 1863 | .help = "list event channel state", |
| 1864 | .cmd = hmp_xen_event_list, |
| 1865 | }, |
| 1866 | |
| 1867 | SRST |
| 1868 | ``xen-event-list`` |
| 1869 | List event channels in the guest |
| 1870 | ERST |
| 1871 | |
| 1872 | HXCOMM *** MUST BE LAST ENTRY ** |
| 1873 | { |
| 1874 | .name = "info", |
| 1875 | .args_type = "item:s?", |
| 1876 | .params = "[subcommand]", |
| 1877 | .help = "show various information about the system state", |
| 1878 | .cmd = hmp_info_help, |
| 1879 | .sub_table = hmp_info_cmds, |
| 1880 | .flags = "p", |
| 1881 | }, |
| 1882 | |
| 1883 | SRST |
| 1884 | ``info`` *subcommand* |
| 1885 | Show various information about the system state. |
| 1886 | ERST |
| 1887 | HXCOMM *** MUST BE LAST ENTRY ** |