Skip to content

Commit

Permalink
update(ipc): add overview of IPC workflow
Browse files Browse the repository at this point in the history
Signed-off-by: Diogo Costa <diogoandreveigacosta@gmail.com>
  • Loading branch information
Diogo21Costa committed Jan 19, 2024
1 parent 404de5a commit 854fe14
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
13 changes: 13 additions & 0 deletions source/bao_hyp/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,19 @@ mappings. This feature provides a means to define the physical memory region exp
####################################
.. _Inter-Process Communication (IPC):

Inter-Process Communication (IPC) enables seamless communication between distinct processes in a
computing system. This mechanism facilitates data exchange, synchronization, and coordination,
fostering enhanced functionality and system efficiency.

Bao provides support for IPC, allowing VMs to establish communication channels. The IPC
configuration involves defining the number of IPCs using the ``ipc_num`` field within the
``vm_config`` struct. The specifics of each IPC are then outlined through the ``ipcs`` structure,
including fields such as ``base``, ``size``, ``shmem_id``, ``interrupt_num``, and ``interrupts``.

.. figure:: img/ipc.svg
:align: center
:name: ipc-fig

- **ipc_num** [optional] - defines the number of IPCs assigned to the VM. By default, ``ipc_num``
equals to zero;
- **ipcs** [mandatory if ``ipc_num`` > 0] - corresponds to the specification of the IPC and is
Expand Down
4 changes: 4 additions & 0 deletions source/bao_hyp/img/ipc.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 854fe14

Please sign in to comment.