Update and complete acrn-dm parameters description

Update and complete `acrn-dm` parameters description in the user guide and HLD

Tracked-On: #2036
Signed-off-by: Shuang Zheng shuang.zheng@intel.com
This commit is contained in:
Shuang Zheng
2019-01-03 19:15:28 +08:00
committed by David Kinder
parent 158ba62c33
commit 79f40a569b
3 changed files with 114 additions and 40 deletions

View File

@@ -38,6 +38,21 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
more than the total number of CPUs in the system, minus one (which is
used by the SOS).
* - :kbd:`--debugexit`
- Enable guest to write io port 0xf4 to exit guest. It's mainly used by
guest unit test.
* - :kbd:`--dump <vm_idx>`
- The option dumps detailed configuration of a VM with built-in configurations.
Example::
--dump 1
* - :kbd:`-E <elf image path>`
- This option is to define a static elf binary which could be loaded by
DM. DM will run elf as guest of ACRN.
* - :kbd:`--enable_trusty`
- Enable trusty for guest.
For Android guest OS, ACRN provides a VM environment with two worlds:
@@ -107,6 +122,24 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
-i /run/acrn/ioc_$vm_name,0x20
-l com2,/run/acrn/ioc_$vm_name
* - :kbd:`--intr_monitor <intr_monitor_params>`
- Enable interrupt storm monitor for UOS. Use this option to prevent an interrupt
storm from the UOS.
usage: ``--intr_monitor threshold/s probe-period(s) delay_time(ms) delay_duration(ms)``
Example::
--intr_monitor 10000,10,1,100
- ``10000``: interrupt rate larger than 10000/s will be treated as interrupt
storm
- ``10``: use the last 10s of interrupt data to detect an interrupt storm
- ``1``: when interrupts are identified as a storm, the next interrupt will
be delayed 1ms before being injected to the guest
- ``100``: after 100ms, we will cancel the interrupt injection delay and restore
to normal.
* - :kbd:`-k, --kernel <kernel_image_path>`
- Set the kernel (full path) for the UOS kernel. The maximum path length is
1023 characters. The DM handles bzImage image format.
@@ -124,6 +157,16 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
usage: ``-m 4g``: set UOS memory to 4 gigabytes.
* - :kbd:`--mac_seed <seed_string>`
- Set a platform unique string as a seed to generate the mac address.
Each VM should have a different “seed_string”. The “seed_string” can
be generated by the following method where $(vm_name) contains the
name of the VM you are going to launch.
``mac=$(cat /sys/class/net/e*/address)``
``seed_string=${mac:9:8}-${vm_name}``
* - :kbd:`-p, --pincpu <vcpu:hostcpu>`
- Pin host CPU to appointed vCPU:
@@ -132,6 +175,9 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
Example: ``-p "1:2"`` means pin the 2nd physical cpu to 1st vcpu in UOS
* - :kbd:`--part_info <part_info_name>`
- Set guest partition info path.
* - :kbd:`--ptdev_no_reset`
- Disable reset check for pci device.
When assigning a PCI device as a passthrough device, we will reset it
@@ -226,6 +272,31 @@ Here are descriptions for each of these ``acrn-dm`` command line parameters:
uses ``OVMF.fd`` as the OVMF image
* - :kbd:`--virtio_poll <poll_interval>`
- Enable virtio poll mode with poll interval xxx ns.
usage::
--virtio_poll 1000000
enable virtio poll mode with poll interval 1ms.
* - :kbd:`--vmcfg <sub-options>`
- It's an experimental option for built-in VM configuration. The
sub-options could be 'list' or <vm_idx>.
- ``--vmcfg list`` shows indexes of all VMs with built-in configuration.
- ``--vmcfg <vm_idx>`` launches UOS with selected config.
Examples::
--vmcfg list
--vmcfg 1
* - :kbd:`--vtpm2 <sock_path>`
- This option is to enable virtual TPM support. The sock_path is a mandatory
parameter for this option which is the path of swtpm socket fd.
* - :kbd:`-W, --virtio_msix`
- This option forces virtio to use single-vector MSI.
By default, any virtio-based devices will use MSI-X as its interrupt