On Fri, Mar 24, 2023 at 12:51:13AM -0400, Parav Pandit wrote:
>
>
> On 2/8/2023 10:30 PM, Xuan Zhuo wrote:
> > An ISM(Internal Shared Memory) device provides the ability to access memory
> > shared between multiple devices. This allows low-overhead communication in
> > presence of such memory. For example, memory can be shared with guests of
> > multiple virtual machines running on the same host, with each virtual
> > machine
>
> I am still learning this new memory sharing beast, so mostly cosmetics
> comments below.
>
> instead of guest of virtual machines is confusing.
> It can be just written as - can be shared between virtual machines running
> on same host ..
> > including an ism device and with the guests getting the shared memory by
> > the ism
> > devices.
> >
> > An ism device can communicate with multiple peers simultaneously. This
> > communication can be dynamically started and ended.
> >
> multiple peers mean, multiple peer ism device?
> Or you meant multiple vms?
>
> > |-------------------------------------------------------------------------------------------------------------|
> > | |------------------------------------------------|
> > |------------------------------------------------| |
> > | | Guest | | Guest
> > | |
> > | | | |
> > | |
> instead of guest, naming it VM makes it consistent with the spec and
> description.
Ideally we just talk about drivers. But it's just a commit log,
it does not matter.
If you are talking about software that runs then calling it VM
is wrong - VM is the interface between guest software and hypervisor.
> > | | ---------------- | |
> > ---------------- | |
> > | | | driver | [M1] [M2] [M3] | | | driver
> > | [M2] [M3] | |
> > | | ---------------- | | | | |
> > ---------------- | | | |
> > | | |cq| |map |map |map | | |cq|
> > |map |map | |
> > | | | | | | | | | | |
> > | | | |
> > | | | | ------------------- | | | |
> > -------------------- | |
> > | |----|--|----------------| device memory |-----|
> > |----|--|----------------| device memory |----| |
> > | | | | ------------------- | | | |
> > -------------------- | |
> > | | | | |
> > | | |
> > | | | | |
> > | | |
> > | | Qemu | | | Qemu
> > | | |
> > | |--------------------------------+---------------|
> > |-------------------------------+----------------| |
> > | |
> > | |
> > | |
> > | |
> > |
> > |------------------------------+------------------------| |
> > | |
> > |
> > | |
> > |
> > |
> > -------------------------- |
> > | | M1 | | M2 | | M3
> > | |
> > |
> > -------------------------- |
> > |
> > |
> > | HOST
> > |
> > ---------------------------------------------------------------------------------------------------------------
> >
> You might want to show the event q as well next to control q as its so
> fundamental for this whole operation.
>
> > ---
> > conformance.tex | 26 +++
> > content.tex | 1 +
> > virtio-ism.tex | 573 ++++++++++++++++++++++++++++++++++++++++++++++++
> > 3 files changed, 600 insertions(+)
> > create mode 100644 virtio-ism.tex
> >
> > diff --git a/conformance.tex b/conformance.tex
> > index c3c1d3e..0a1456a 100644
> > --- a/conformance.tex
> > +++ b/conformance.tex
> > @@ -335,6 +335,17 @@ \section{Conformance Targets}\label{sec:Conformance /
> > Conformance Targets}
> > \item \ref{drivernormative:Device Types / PMEM Device / Device
> > Initialization}
> > \end{itemize}
> > +\conformance{\subsection}{ISM Driver Conformance}\label{sec:Conformance /
> > Driver Conformance / ISM Driver Conformance}
> > +
> > +A ISM driver MUST conform to the following normative statements:
> > +
> > +\begin{itemize}
> > +\item \ref{drivernormative:Device Types / ISM Device / Device
> > Initialization}
> > +\item \ref{drivernormative:Device Types / ISM Device / Device Operation /
> > Alloc ISM Region}
> > +\item \ref{drivernormative:Device Types / ISM Device / Device Operation /
> > Attach ISM Region}
> > +\item \ref{drivernormative:Device Types / ISM Device / Device Operation /
> > Detach ISM Region}
> > +\end{itemize}
> > +
> > \conformance{\section}{Device Conformance}\label{sec:Conformance / Device
> > Conformance}
> > A device MUST conform to the following normative statements:
> > @@ -621,6 +632,21 @@ \section{Conformance Targets}\label{sec:Conformance /
> > Conformance Targets}
> > \item \ref{devicenormative:Device Types / PMEM Device / Device Operation
> > / Virtqueue return}
> > \end{itemize}
> > +\conformance{\subsection}{ISM Device Conformance}\label{sec:Conformance /
> > Device Conformance / ISM Device Conformance}
> > +
> > +A ISM device MUST conform to the following normative statements:
> > +
> > +\begin{itemize}
> > +\item \ref{devicenormative:Device Types / ISM Device / Device
> > configuration layout}
> > +\item \ref{devicenormative:Device Types / ISM Device / Device
> > Initialization}
> > +\item \ref{devicenormative:Device Types / ISM Device / Device Operation /
> > Alloc ISM Region}
> > +\item \ref{devicenormative:Device Types / ISM Device / Device Operation /
> > Query ISM Region}
> > +\item \ref{devicenormative:Device Types / ISM Device / Device Operation /
> > Attach ISM Region}
> > +\item \ref{devicenormative:Device Types / ISM Device / Device Operation /
> > Detach ISM Region}
> > +\item \ref{devicenormative:Device Types / ISM Device / Device Operation /
> > Grant ISM Region}
> > +\item \ref{devicenormative:Device Types / ISM Device / Device Operation /
> > Inform Event IRQ Vector}
> Though using control vq to configure irq is good idea, I guess
> queue_msix_vector can be used. It needs some more text that
> queue_msix_vector will not be used etc.
>
> if the event queue create interface exists over ctrl vq than things tied up
> well. Else I think transport specific existing scheme more aligns to the
> spec.
>
> > +\end{itemize}
> > +
> > \conformance{\section}{Legacy Interface: Transitional Device and
> > Transitional Driver Conformance}\label{sec:Conformance / Legacy Interface:
> > Transitional Device and Transitional Driver Conformance}
> > A conformant implementation MUST be either transitional or
> > non-transitional, see \ref{intro:Legacy
> > diff --git a/content.tex b/content.tex
> > index 96f4723..fe02aec 100644
> > --- a/content.tex
> > +++ b/content.tex
> > @@ -7545,6 +7545,7 @@ \subsubsection{Legacy Interface: Framing
> > Requirements}\label{sec:Device
> > \input{virtio-scmi.tex}
> > \input{virtio-gpio.tex}
> > \input{virtio-pmem.tex}
> > +\input{virtio-ism.tex}
> > \chapter{Reserved Feature Bits}\label{sec:Reserved Feature Bits}
> > diff --git a/virtio-ism.tex b/virtio-ism.tex
> > new file mode 100644
> > index 0000000..a1720d8
> > --- /dev/null
> > +++ b/virtio-ism.tex
> > @@ -0,0 +1,573 @@
> > +\section{ISM Device}\label{sec:Device Types / ISM Device}
> > +
> > +\begin{lstlisting}
> > +|-------------------------------------------------------------------------------------------------------------|
> > +| |------------------------------------------------|
> > |------------------------------------------------| |
> > +| | VM [M1] [M2] [M3] | | VM
> > [M2] [M3] | |
> > +| | | | | | |
> > | | | |
> > +| | -----------------------|------|------|--- | |
> > ------------------------------|------|--- | |
> > +| | | driver | | | | | | |
> > driver | | | | |
> > +| | -----------------------|------|------|--- | |
> > ------------------------------|------|--- | |
> > +| | |cq| |map |map |map | | |cq|
> > |map |map | |
> > +| | | | | | | | | | |
> > | | | |
> > +| | | | ------------------- | | | |
> > ------------------- | |
> > +| |----|--|----------------| device memory |-----|
> > |----|--|----------------| device memory |-----| |
> > +| | | | ------------------- | | | |
> > ------------------- | |
> > +| | | | |
> > | | |
> > +| | | | |
> > | | |
> > +| | | | |
> > | | |
> > +| |--------------------------------+---------------|
> > |--------------------------------+---------------| |
> > +| |
> > | |
> > +| |
> > | |
> > +|
> > |------------------------------+------------------------| |
> > +| |
> > |
> Above line is misaligned.
>
> > +| |
> > |
> > +|
> > -------------------------- |
> > +| | M1 | | M2 | |
> > M3 | |
> > +|
> > -------------------------- |
> > +|
> > |
> > +|
> > |
> > +|-------------------------------------------------------------------------------------------------------------|
And I think this is a bad way to include drawings.
There are lots of latex packages for diagrams, please
pick one.
> > +\end{lstlisting}
> > +
> > +An ISM(Internal Shared Memory) device provides the ability to access memory
> > +shared between multiple devices. This allows low-overhead communication in
> > +presence of such memory. For example, memory can be shared with guests of
> > +multiple virtual machines running on the same host, with each virtual
> > machine
> > +including an ism device and with the guests getting the shared memory by
> > the ism
> > +devices.
> > +
> > +An ism device can communicate with multiple peers simultaneously. This
> > +communication can be dynamically started and ended.
> > +
> > +All the devices with the ability to communicate with each other form a
> > +communication domain. Two devices from different communication domains
> > can't
> > +communicate.
> > +
> > +The device memory of the ism device is divided into multiple chunks with
> > the
> > +same size. Every ism region contains multiple chunks. When communicating
> > between
> > +two devices, an ism region is used as a shared memory.
> > +
> > +The ism region is the basis for communication between ism devices.
> > +
> > +The process of communication between two drivers is that one driver
> > allocates an
> > +ism region and obtains a token. Then the peer uses this token to attach
> > the same
> The peer driver will make it more clear.
>
> > +ism region, the two drivers realize the memory(ism region) sharing. The
> > driver
> > +can also notify peer by kick notify-address the ism region has been
> > updated.
> > +
> > +An ism region can be referred by its \field{token}, or the \field{offset}.
> > +The \field{offset} is the offset of the first chunk inside the ism region
> > +starting from the device memory head.
> > +
> > +\subsection{Device ID}\label{sec:Device Types / ISM Device / Device ID}
> > + 44
> > +
> > +\subsection{Virtqueues}\label{sec:Device Types / ISM Device / Virtqueues}
> > +\begin{description}
> > +\item[0] controlq
> > +\item[1] eventq
> > +\end{description}
> > +
> > +\subsection{Feature bits}\label{sec:Device Types / ISM Device / Feature
> > bits}
> > +\begin{description}
> > +\item[VIRTIO_ISM_F_DEV_MEM(0)] Device provide memory for ism region, driver
> > + don't need to provide memory for alloc/attach operation.
> > +
> > +\end{description}
> > +
> > +\subsection{Device configuration layout}\label{sec:Device Types / ISM
> > Device / Device configuration layout}
> > +
> > +\begin{lstlisting}
> > +struct virtio_ism_config {
> > + le128 cdid;
> le128 data type is not present in the spec.
> Better to define uuid data structure and refer here.
>
> struct uuid {..}
>
> struct uuid cdid;
> ...
Agree. And is it really little endian?
--
MST
---------------------------------------------------------------------
To unsubscribe, e-mail: virtio-dev-unsubscr...@lists.oasis-open.org
For additional commands, e-mail: virtio-dev-h...@lists.oasis-open.org
