OrgACRN
/
acrn-hypervisor
mirror of https://github.com/projectacrn/acrn-hypervisor.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Doc: Grammatical edits to Shared mem based inter-VM comm doc 

Signed-off-by: Deb Taylor <deb.taylor@intel.com>
This commit is contained in:
Deb Taylor 2020-06-12 16:11:00 -04:00 committed by deb-intel
parent e707cdc768
commit 315b7f3c00
1 changed files with 10 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/developer-guides/hld/ivshmem-hld.rst
View File

@ -4,7 +4,7 @@ ACRN Shared Memory Based Inter-VM Communication
############################################### ###############################################
ACRN supports inter-virtual machine communication based on a shared ACRN supports inter-virtual machine communication based on a shared
memory mechanism. The ACRN device model or hypervisor emulate a virtual memory mechanism. The ACRN device model or hypervisor emulates a virtual
PCI device (called an ``ivshmem`` device) to expose the base address and PCI device (called an ``ivshmem`` device) to expose the base address and
size of this shared memory. size of this shared memory.
@ -38,7 +38,7 @@ ivshmem dm:
It will support notification/interrupt mechanism in the future. It will support notification/interrupt mechanism in the future.
ivshmem server: ivshmem server:
A daemon for inter-VM notification capability, that will work with **ivshmem A daemon for inter-VM notification capability that will work with **ivshmem
dm**. This is currently **not implemented**, so the inter-VM communication dm**. This is currently **not implemented**, so the inter-VM communication
doesn't support a notification mechanism. doesn't support a notification mechanism.
@ -46,9 +46,8 @@ Ivshmem Device Introduction
*************************** ***************************
The ``ivshmem`` device is a virtual standard PCI device consisting of The ``ivshmem`` device is a virtual standard PCI device consisting of
two Base Address Registers (BARs): BAR0 is used for emulating interrupt related registers, two Base Address Registers (BARs): BAR0 is used for emulating interrupt
and BAR2 is used for exposing shared memory region. The ``ivshmem`` device related registers, and BAR2 is used for exposing shared memory region. The ``ivshmem`` device doesn't support any extra capabilities.
doesn't support any extra capabilities.
Configuration Space Definition Configuration Space Definition
@ -121,13 +120,13 @@ where
Inter-VM Communication Example Inter-VM Communication Example
****************************** ******************************
The following example uses inter-vm communication between two Linux-based post-launched VMs (VM1 and The following example uses inter-vm communication between two Linux-based
VM2). post-launched VMs (VM1 and VM2).
.. note:: An ``ivshmem`` Windows driver exists and can be found `here <https://github.com/virtio-win/kvm-guest-drivers-windows/tree/master/ivshmem>`_ .. note:: An ``ivshmem`` Windows driver exists and can be found `here <https://github.com/virtio-win/kvm-guest-drivers-windows/tree/master/ivshmem>`_
1. Add a new virtual PCI device for both VMs: the device type is 1. Add a new virtual PCI device for both VMs: the device type is
``ivshmem``, shared memory name is ``test`` and shared memory size is ``ivshmem``, shared memory name is ``test``, and shared memory size is
4096 bytes. Both VMs must have the same shared memory name and size: 4096 bytes. Both VMs must have the same shared memory name and size:
- VM1 Launch Script Sample - VM1 Launch Script Sample
@ -160,7 +159,7 @@ VM2).
--ovmf /usr/share/acrn/bios/OVMF.fd \ --ovmf /usr/share/acrn/bios/OVMF.fd \
$vm_name $vm_name
2. Boot two VMs and use ``lspci | grep "shared memory"`` to check the virtual device is ready for each VM. 2. Boot two VMs and use ``lspci | grep "shared memory"`` to verify that the virtual device is ready for each VM.
- For VM1, it shows ``00:06.0 RAM memory: Red Hat, Inc. Inter-VM shared memory (rev 01)`` - For VM1, it shows ``00:06.0 RAM memory: Red Hat, Inc. Inter-VM shared memory (rev 01)``
- For VM2, it shows ``00:05.0 RAM memory: Red Hat, Inc. Inter-VM shared memory (rev 01)`` - For VM2, it shows ``00:05.0 RAM memory: Red Hat, Inc. Inter-VM shared memory (rev 01)``