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