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