forked from aliguori/qemu
-
Notifications
You must be signed in to change notification settings - Fork 4
/
hmp-commands.hx
1863 lines (1602 loc) · 54.3 KB
/
hmp-commands.hx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
HXCOMM Use DEFHEADING() to define headings in both help text and rST.
HXCOMM Text between SRST and ERST is copied to the rST version and
HXCOMM discarded from C version.
HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
HXCOMM monitor commands
HXCOMM HXCOMM can be used for comments, discarded from both rST and C.
{
.name = "help|?",
.args_type = "name:S?",
.params = "[cmd]",
.help = "show the help",
.cmd = do_help_cmd,
.flags = "p",
},
SRST
``help`` or ``?`` [*cmd*]
Show the help for all commands or just for command *cmd*.
ERST
{
.name = "commit",
.args_type = "device:B",
.params = "device|all",
.help = "commit changes to the disk images (if -snapshot is used) or backing files",
.cmd = hmp_commit,
},
SRST
``commit``
Commit changes to the disk images (if -snapshot is used) or backing files.
If the backing file is smaller than the snapshot, then the backing file
will be resized to be the same size as the snapshot. If the snapshot is
smaller than the backing file, the backing file will not be truncated.
If you want the backing file to match the size of the smaller snapshot,
you can safely truncate it yourself once the commit operation successfully
completes.
ERST
{
.name = "quit|q",
.args_type = "",
.params = "",
.help = "quit the emulator",
.cmd = hmp_quit,
.flags = "p",
},
SRST
``quit`` or ``q``
Quit the emulator.
ERST
{
.name = "exit_preconfig",
.args_type = "",
.params = "",
.help = "exit the preconfig state",
.cmd = hmp_exit_preconfig,
.flags = "p",
},
SRST
``exit_preconfig``
This command makes QEMU exit the preconfig state and proceed with
VM initialization using configuration data provided on the command line
and via the QMP monitor during the preconfig state. The command is only
available during the preconfig state (i.e. when the --preconfig command
line option was in use).
ERST
{
.name = "block_resize",
.args_type = "device:B,size:o",
.params = "device size",
.help = "resize a block image",
.cmd = hmp_block_resize,
.coroutine = true,
},
SRST
``block_resize``
Resize a block image while a guest is running. Usually requires guest
action to see the updated size. Resize to a lower size is supported,
but should be used with extreme caution. Note that this command only
resizes image files, it can not resize block devices like LVM volumes.
ERST
{
.name = "block_stream",
.args_type = "device:B,speed:o?,base:s?",
.params = "device [speed [base]]",
.help = "copy data from a backing file into a block device",
.cmd = hmp_block_stream,
},
SRST
``block_stream``
Copy data from a backing file into a block device.
ERST
{
.name = "block_job_set_speed",
.args_type = "device:B,speed:o",
.params = "device speed",
.help = "set maximum speed for a background block operation",
.cmd = hmp_block_job_set_speed,
},
SRST
``block_job_set_speed``
Set maximum speed for a background block operation.
ERST
{
.name = "block_job_cancel",
.args_type = "force:-f,device:B",
.params = "[-f] device",
.help = "stop an active background block operation (use -f"
"\n\t\t\t if you want to abort the operation immediately"
"\n\t\t\t instead of keep running until data is in sync)",
.cmd = hmp_block_job_cancel,
},
SRST
``block_job_cancel``
Stop an active background block operation (streaming, mirroring).
ERST
{
.name = "block_job_complete",
.args_type = "device:B",
.params = "device",
.help = "stop an active background block operation",
.cmd = hmp_block_job_complete,
},
SRST
``block_job_complete``
Manually trigger completion of an active background block operation.
For mirroring, this will switch the device to the destination path.
ERST
{
.name = "block_job_pause",
.args_type = "device:B",
.params = "device",
.help = "pause an active background block operation",
.cmd = hmp_block_job_pause,
},
SRST
``block_job_pause``
Pause an active block streaming operation.
ERST
{
.name = "block_job_resume",
.args_type = "device:B",
.params = "device",
.help = "resume a paused background block operation",
.cmd = hmp_block_job_resume,
},
SRST
``block_job_resume``
Resume a paused block streaming operation.
ERST
{
.name = "eject",
.args_type = "force:-f,device:B",
.params = "[-f] device",
.help = "eject a removable medium (use -f to force it)",
.cmd = hmp_eject,
},
SRST
``eject [-f]`` *device*
Eject a removable medium (use -f to force it).
ERST
{
.name = "drive_del",
.args_type = "id:B",
.params = "device",
.help = "remove host block device",
.cmd = hmp_drive_del,
},
SRST
``drive_del`` *device*
Remove host block device. The result is that guest generated IO is no longer
submitted against the host device underlying the disk. Once a drive has
been deleted, the QEMU Block layer returns -EIO which results in IO
errors in the guest for applications that are reading/writing to the device.
These errors are always reported to the guest, regardless of the drive's error
actions (drive options rerror, werror).
ERST
{
.name = "change",
.args_type = "device:B,target:F,arg:s?,read-only-mode:s?",
.params = "device filename [format [read-only-mode]]",
.help = "change a removable medium, optional format",
.cmd = hmp_change,
},
SRST
``change`` *device* *setting*
Change the configuration of a device.
``change`` *diskdevice* *filename* [*format* [*read-only-mode*]]
Change the medium for a removable disk device to point to *filename*. eg::
(qemu) change ide1-cd0 /path/to/some.iso
*format* is optional.
*read-only-mode* may be used to change the read-only status of the device.
It accepts the following values:
retain
Retains the current status; this is the default.
read-only
Makes the device read-only.
read-write
Makes the device writable.
``change vnc password`` [*password*]
Change the password associated with the VNC server. If the new password
is not supplied, the monitor will prompt for it to be entered. VNC
passwords are only significant up to 8 letters. eg::
(qemu) change vnc password
Password: ********
ERST
{
.name = "screendump",
.args_type = "filename:F,device:s?,head:i?",
.params = "filename [device [head]]",
.help = "save screen from head 'head' of display device 'device' "
"into PPM image 'filename'",
.cmd = hmp_screendump,
.coroutine = true,
},
SRST
``screendump`` *filename*
Save screen into PPM image *filename*.
ERST
{
.name = "logfile",
.args_type = "filename:F",
.params = "filename",
.help = "output logs to 'filename'",
.cmd = hmp_logfile,
},
SRST
``logfile`` *filename*
Output logs to *filename*.
ERST
{
.name = "trace-event",
.args_type = "name:s,option:b,vcpu:i?",
.params = "name on|off [vcpu]",
.help = "changes status of a specific trace event "
"(vcpu: vCPU to set, default is all)",
.cmd = hmp_trace_event,
.command_completion = trace_event_completion,
},
SRST
``trace-event``
changes status of a trace event
ERST
#if defined(CONFIG_TRACE_SIMPLE)
{
.name = "trace-file",
.args_type = "op:s?,arg:F?",
.params = "on|off|flush|set [arg]",
.help = "open, close, or flush trace file, or set a new file name",
.cmd = hmp_trace_file,
},
SRST
``trace-file on|off|flush``
Open, close, or flush the trace file. If no argument is given, the
status of the trace file is displayed.
ERST
#endif
{
.name = "log",
.args_type = "items:s",
.params = "item1[,...]",
.help = "activate logging of the specified items",
.cmd = hmp_log,
},
SRST
``log`` *item1*\ [,...]
Activate logging of the specified items.
ERST
{
.name = "savevm",
.args_type = "name:s?",
.params = "tag",
.help = "save a VM snapshot. If no tag is provided, a new snapshot is created",
.cmd = hmp_savevm,
},
SRST
``savevm`` *tag*
Create a snapshot of the whole virtual machine. If *tag* is
provided, it is used as human readable identifier. If there is already
a snapshot with the same tag, it is replaced. More info at
:ref:`vm_005fsnapshots`.
Since 4.0, savevm stopped allowing the snapshot id to be set, accepting
only *tag* as parameter.
ERST
{
.name = "loadvm",
.args_type = "name:s",
.params = "tag",
.help = "restore a VM snapshot from its tag",
.cmd = hmp_loadvm,
.command_completion = loadvm_completion,
},
SRST
``loadvm`` *tag*
Set the whole virtual machine to the snapshot identified by the tag
*tag*.
Since 4.0, loadvm stopped accepting snapshot id as parameter.
ERST
{
.name = "delvm",
.args_type = "name:s",
.params = "tag",
.help = "delete a VM snapshot from its tag",
.cmd = hmp_delvm,
.command_completion = delvm_completion,
},
SRST
``delvm`` *tag*
Delete the snapshot identified by *tag*.
Since 4.0, delvm stopped deleting snapshots by snapshot id, accepting
only *tag* as parameter.
ERST
{
.name = "singlestep",
.args_type = "option:s?",
.params = "[on|off]",
.help = "run emulation in singlestep mode or switch to normal mode",
.cmd = hmp_singlestep,
},
SRST
``singlestep [off]``
Run the emulation in single step mode.
If called with option off, the emulation returns to normal mode.
ERST
{
.name = "stop",
.args_type = "",
.params = "",
.help = "stop emulation",
.cmd = hmp_stop,
},
SRST
``stop``
Stop emulation.
ERST
{
.name = "cont|c",
.args_type = "",
.params = "",
.help = "resume emulation",
.cmd = hmp_cont,
},
SRST
``cont`` or ``c``
Resume emulation.
ERST
{
.name = "system_wakeup",
.args_type = "",
.params = "",
.help = "wakeup guest from suspend",
.cmd = hmp_system_wakeup,
},
SRST
``system_wakeup``
Wakeup guest from suspend.
ERST
{
.name = "gdbserver",
.args_type = "device:s?",
.params = "[device]",
.help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
.cmd = hmp_gdbserver,
},
SRST
``gdbserver`` [*port*]
Start gdbserver session (default *port*\=1234)
ERST
{
.name = "x",
.args_type = "fmt:/,addr:l",
.params = "/fmt addr",
.help = "virtual memory dump starting at 'addr'",
.cmd = hmp_memory_dump,
},
SRST
``x/``\ *fmt* *addr*
Virtual memory dump starting at *addr*.
ERST
{
.name = "xp",
.args_type = "fmt:/,addr:l",
.params = "/fmt addr",
.help = "physical memory dump starting at 'addr'",
.cmd = hmp_physical_memory_dump,
},
SRST
``xp /``\ *fmt* *addr*
Physical memory dump starting at *addr*.
*fmt* is a format which tells the command how to format the
data. Its syntax is: ``/{count}{format}{size}``
*count*
is the number of items to be dumped.
*format*
can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
c (char) or i (asm instruction).
*size*
can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
``h`` or ``w`` can be specified with the ``i`` format to
respectively select 16 or 32 bit code instruction size.
Examples:
Dump 10 instructions at the current instruction pointer::
(qemu) x/10i $eip
0x90107063: ret
0x90107064: sti
0x90107065: lea 0x0(%esi,1),%esi
0x90107069: lea 0x0(%edi,1),%edi
0x90107070: ret
0x90107071: jmp 0x90107080
0x90107073: nop
0x90107074: nop
0x90107075: nop
0x90107076: nop
Dump 80 16 bit values at the start of the video memory::
(qemu) xp/80hx 0xb8000
0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
ERST
{
.name = "gpa2hva",
.args_type = "addr:l",
.params = "addr",
.help = "print the host virtual address corresponding to a guest physical address",
.cmd = hmp_gpa2hva,
},
SRST
``gpa2hva`` *addr*
Print the host virtual address at which the guest's physical address *addr*
is mapped.
ERST
#ifdef CONFIG_LINUX
{
.name = "gpa2hpa",
.args_type = "addr:l",
.params = "addr",
.help = "print the host physical address corresponding to a guest physical address",
.cmd = hmp_gpa2hpa,
},
#endif
SRST
``gpa2hpa`` *addr*
Print the host physical address at which the guest's physical address *addr*
is mapped.
ERST
{
.name = "gva2gpa",
.args_type = "addr:l",
.params = "addr",
.help = "print the guest physical address corresponding to a guest virtual address",
.cmd = hmp_gva2gpa,
},
SRST
``gva2gpa`` *addr*
Print the guest physical address at which the guest's virtual address *addr*
is mapped based on the mapping for the current CPU.
ERST
{
.name = "print|p",
.args_type = "fmt:/,val:l",
.params = "/fmt expr",
.help = "print expression value (use $reg for CPU register access)",
.cmd = do_print,
},
SRST
``print`` or ``p/``\ *fmt* *expr*
Print expression value. Only the *format* part of *fmt* is
used.
ERST
{
.name = "i",
.args_type = "fmt:/,addr:i,index:i.",
.params = "/fmt addr",
.help = "I/O port read",
.cmd = hmp_ioport_read,
},
SRST
``i/``\ *fmt* *addr* [.\ *index*\ ]
Read I/O port.
ERST
{
.name = "o",
.args_type = "fmt:/,addr:i,val:i",
.params = "/fmt addr value",
.help = "I/O port write",
.cmd = hmp_ioport_write,
},
SRST
``o/``\ *fmt* *addr* *val*
Write to I/O port.
ERST
{
.name = "sendkey",
.args_type = "keys:s,hold-time:i?",
.params = "keys [hold_ms]",
.help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
.cmd = hmp_sendkey,
.command_completion = sendkey_completion,
},
SRST
``sendkey`` *keys*
Send *keys* to the guest. *keys* could be the name of the
key or the raw value in hexadecimal format. Use ``-`` to press
several keys simultaneously. Example::
sendkey ctrl-alt-f1
This command is useful to send keys that your graphical user interface
intercepts at low level, such as ``ctrl-alt-f1`` in X Window.
ERST
{
.name = "sync-profile",
.args_type = "op:s?",
.params = "[on|off|reset]",
.help = "enable, disable or reset synchronization profiling. "
"With no arguments, prints whether profiling is on or off.",
.cmd = hmp_sync_profile,
},
SRST
``sync-profile [on|off|reset]``
Enable, disable or reset synchronization profiling. With no arguments, prints
whether profiling is on or off.
ERST
{
.name = "system_reset",
.args_type = "",
.params = "",
.help = "reset the system",
.cmd = hmp_system_reset,
},
SRST
``system_reset``
Reset the system.
ERST
{
.name = "system_powerdown",
.args_type = "",
.params = "",
.help = "send system power down event",
.cmd = hmp_system_powerdown,
},
SRST
``system_powerdown``
Power down the system (if supported).
ERST
{
.name = "sum",
.args_type = "start:i,size:i",
.params = "addr size",
.help = "compute the checksum of a memory region",
.cmd = hmp_sum,
},
SRST
``sum`` *addr* *size*
Compute the checksum of a memory region.
ERST
{
.name = "device_add",
.args_type = "device:O",
.params = "driver[,prop=value][,...]",
.help = "add device, like -device on the command line",
.cmd = hmp_device_add,
.command_completion = device_add_completion,
},
SRST
``device_add`` *config*
Add device.
ERST
{
.name = "device_del",
.args_type = "id:s",
.params = "device",
.help = "remove device",
.cmd = hmp_device_del,
.command_completion = device_del_completion,
},
SRST
``device_del`` *id*
Remove device *id*. *id* may be a short ID
or a QOM object path.
ERST
{
.name = "cpu",
.args_type = "index:i",
.params = "index",
.help = "set the default CPU",
.cmd = hmp_cpu,
},
SRST
``cpu`` *index*
Set the default CPU.
ERST
{
.name = "mouse_move",
.args_type = "dx_str:s,dy_str:s,dz_str:s?",
.params = "dx dy [dz]",
.help = "send mouse move events",
.cmd = hmp_mouse_move,
},
SRST
``mouse_move`` *dx* *dy* [*dz*]
Move the active mouse to the specified coordinates *dx* *dy*
with optional scroll axis *dz*.
ERST
{
.name = "mouse_button",
.args_type = "button_state:i",
.params = "state",
.help = "change mouse button state (1=L, 2=M, 4=R)",
.cmd = hmp_mouse_button,
},
SRST
``mouse_button`` *val*
Change the active mouse button state *val* (1=L, 2=M, 4=R).
ERST
{
.name = "mouse_set",
.args_type = "index:i",
.params = "index",
.help = "set which mouse device receives events",
.cmd = hmp_mouse_set,
},
SRST
``mouse_set`` *index*
Set which mouse device receives events at given *index*, index
can be obtained with::
info mice
ERST
{
.name = "wavcapture",
.args_type = "path:F,audiodev:s,freq:i?,bits:i?,nchannels:i?",
.params = "path audiodev [frequency [bits [channels]]]",
.help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
.cmd = hmp_wavcapture,
},
SRST
``wavcapture`` *filename* *audiodev* [*frequency* [*bits* [*channels*]]]
Capture audio into *filename* from *audiodev*, using sample rate
*frequency* bits per sample *bits* and number of channels
*channels*.
Defaults:
- Sample rate = 44100 Hz - CD quality
- Bits = 16
- Number of channels = 2 - Stereo
ERST
{
.name = "stopcapture",
.args_type = "n:i",
.params = "capture index",
.help = "stop capture",
.cmd = hmp_stopcapture,
},
SRST
``stopcapture`` *index*
Stop capture with a given *index*, index can be obtained with::
info capture
ERST
{
.name = "memsave",
.args_type = "val:l,size:i,filename:s",
.params = "addr size file",
.help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
.cmd = hmp_memsave,
},
SRST
``memsave`` *addr* *size* *file*
save to disk virtual memory dump starting at *addr* of size *size*.
ERST
{
.name = "pmemsave",
.args_type = "val:l,size:i,filename:s",
.params = "addr size file",
.help = "save to disk physical memory dump starting at 'addr' of size 'size'",
.cmd = hmp_pmemsave,
},
SRST
``pmemsave`` *addr* *size* *file*
save to disk physical memory dump starting at *addr* of size *size*.
ERST
{
.name = "boot_set",
.args_type = "bootdevice:s",
.params = "bootdevice",
.help = "define new values for the boot device list",
.cmd = hmp_boot_set,
},
SRST
``boot_set`` *bootdevicelist*
Define new values for the boot device list. Those values will override
the values specified on the command line through the ``-boot`` option.
The values that can be specified here depend on the machine type, but are
the same that can be specified in the ``-boot`` command line option.
ERST
{
.name = "nmi",
.args_type = "",
.params = "",
.help = "inject an NMI",
.cmd = hmp_nmi,
},
SRST
``nmi`` *cpu*
Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
ERST
{
.name = "ringbuf_write",
.args_type = "device:s,data:s",
.params = "device data",
.help = "Write to a ring buffer character device",
.cmd = hmp_ringbuf_write,
.command_completion = ringbuf_write_completion,
},
SRST
``ringbuf_write`` *device* *data*
Write *data* to ring buffer character device *device*.
*data* must be a UTF-8 string.
ERST
{
.name = "ringbuf_read",
.args_type = "device:s,size:i",
.params = "device size",
.help = "Read from a ring buffer character device",
.cmd = hmp_ringbuf_read,
.command_completion = ringbuf_write_completion,
},
SRST
``ringbuf_read`` *device*
Read and print up to *size* bytes from ring buffer character
device *device*.
Certain non-printable characters are printed ``\uXXXX``, where ``XXXX`` is the
character code in hexadecimal. Character ``\`` is printed ``\\``.
Bug: can screw up when the buffer contains invalid UTF-8 sequences,
NUL characters, after the ring buffer lost data, and when reading
stops because the size limit is reached.
ERST
{
.name = "announce_self",
.args_type = "interfaces:s?,id:s?",
.params = "[interfaces] [id]",
.help = "Trigger GARP/RARP announcements",
.cmd = hmp_announce_self,
},
SRST
``announce_self``
Trigger a round of GARP/RARP broadcasts; this is useful for explicitly
updating the network infrastructure after a reconfiguration or some forms
of migration. The timings of the round are set by the migration announce
parameters. An optional comma separated *interfaces* list restricts the
announce to the named set of interfaces. An optional *id* can be used to
start a separate announce timer and to change the parameters of it later.
ERST
{
.name = "migrate",
.args_type = "detach:-d,blk:-b,inc:-i,resume:-r,uri:s",
.params = "[-d] [-b] [-i] [-r] uri",
.help = "migrate to URI (using -d to not wait for completion)"
"\n\t\t\t -b for migration without shared storage with"
" full copy of disk\n\t\t\t -i for migration without "
"shared storage with incremental copy of disk "
"(base image shared between src and destination)"
"\n\t\t\t -r to resume a paused migration",
.cmd = hmp_migrate,
},
SRST
``migrate [-d] [-b] [-i]`` *uri*
Migrate to *uri* (using -d to not wait for completion).
``-b``
for migration with full copy of disk
``-i``
for migration with incremental copy of disk (base image is shared)
ERST
{
.name = "migrate_cancel",
.args_type = "",
.params = "",
.help = "cancel the current VM migration",
.cmd = hmp_migrate_cancel,
},
SRST
``migrate_cancel``
Cancel the current VM migration.
ERST
{
.name = "migrate_continue",
.args_type = "state:s",
.params = "state",
.help = "Continue migration from the given paused state",
.cmd = hmp_migrate_continue,
},
SRST
``migrate_continue`` *state*
Continue migration from the paused state *state*
ERST
{
.name = "migrate_incoming",
.args_type = "uri:s",
.params = "uri",
.help = "Continue an incoming migration from an -incoming defer",
.cmd = hmp_migrate_incoming,
},
SRST
``migrate_incoming`` *uri*
Continue an incoming migration using the *uri* (that has the same syntax
as the ``-incoming`` option).
ERST
{
.name = "migrate_recover",
.args_type = "uri:s",
.params = "uri",
.help = "Continue a paused incoming postcopy migration",
.cmd = hmp_migrate_recover,
},
SRST
``migrate_recover`` *uri*
Continue a paused incoming postcopy migration using the *uri*.
ERST
{
.name = "migrate_pause",
.args_type = "",
.params = "",
.help = "Pause an ongoing migration (postcopy-only)",
.cmd = hmp_migrate_pause,
},
SRST
``migrate_pause``
Pause an ongoing migration. Currently it only supports postcopy.
ERST
{
.name = "migrate_set_cache_size",
.args_type = "value:o",
.params = "value",
.help = "set cache size (in bytes) for XBZRLE migrations,"
"the cache size will be rounded down to the nearest "
"power of 2.\n"
"The cache size affects the number of cache misses."
"In case of a high cache miss ratio you need to increase"
" the cache size",
.cmd = hmp_migrate_set_cache_size,
},
SRST
``migrate_set_cache_size`` *value*
Set cache size to *value* (in bytes) for xbzrle migrations.
ERST
{