patches and low-level development discussion
 help / color / mirror / code / Atom feed
From: Alyssa Ross <hi@alyssa.is>
To: devel@spectrum-os.org
Cc: Alyssa Ross <hi@alyssa.is>, impaqt <impaqt@vendek.net>,
	Cole Helbling <cole.e.helbling@outlook.com>
Subject: [PATCH doc v2] Document crosvm memfd server
Date: Wed, 27 May 2020 23:27:09 +0000	[thread overview]
Message-ID: <20200527232709.22211-1-hi@alyssa.is> (raw)
In-Reply-To: <20200526173709.20503-1-hi@alyssa.is>

---
Thanks for the comments.  Should be addressed now.

Please take a(nother) look.  If you think it looks good, I'd
appreciate a Reviewed-by tag from you. :)

(Last bit is just something nice for me to put in the git log,
e.g. Reviewed-by: Alyssa Ross <hi@alyssa.is>, and means that you had a
look and don't see anything wrong with the changes.  By convention
those should be sent by the reviewer rather than just made up by
me. :))

 developer-manual.adoc | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/developer-manual.adoc b/developer-manual.adoc
index a538437..d69707d 100644
--- a/developer-manual.adoc
+++ b/developer-manual.adoc
@@ -194,6 +194,31 @@ compile the policy files into the crosvm binary so paths don't have to
 be hardcoded.
 
 
+==== The memfd server
+
+Spectrum's crosvm has been augmented with a feature called the "`memfd
+server`", (currently only on the
+https://spectrum-os.org/git/crosvm/log/?h=interguest[interguest]
+branch).  This is a small server that listens on a Unix stream socket.
+It receives a request consisting of a name and a size, uses those to
+allocate a
+https://man7.org/linux/man-pages/man2/memfd_create.2.html[memfd], and
+then sends the resulting memfd file descriptor back over the socket in
+response, along with a single byte status code.
+
+The purpose of this is that it can be exposed to the guest over
+virtio_wl.  This means that the guest can request and receive
+allocations of host memory.  This is important, because virtio_wl only
+allows file descriptors pointing to host memory to be sent over
+virtio_wl -- a memfd allocated in a guest cannot be sent over virtio_wl.
+It is rare that a guest needs to be able to allocate and send shared
+memory in this way, but it is important for a Wayland compositor
+running in a guest to be able to do this.
+
+The memfd server is disabled by default, but is enabled at startup
+with the `--wl-memfd` flag.
+
+
 === Sommelier
 
 https://chromium.googlesource.com/chromiumos/platform2/+/master/vm_tools/sommelier[Sommelier]
-- 
2.26.2

  parent reply	other threads:[~2020-05-27 23:27 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-05-26 17:37 [PATCH doc] Document crosvm memfd server Alyssa Ross
2020-05-27  0:13 ` impaqt
2020-05-27 23:27 ` Alyssa Ross [this message]
2020-05-28  0:40   ` [PATCH doc v2] " impaqt
2020-05-29 18:12     ` Alyssa Ross
2020-05-29 18:49   ` Cole Helbling
2020-05-29 18:59   ` Alyssa Ross

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200527232709.22211-1-hi@alyssa.is \
    --to=hi@alyssa.is \
    --cc=cole.e.helbling@outlook.com \
    --cc=devel@spectrum-os.org \
    --cc=impaqt@vendek.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://spectrum-os.org/git/crosvm
	https://spectrum-os.org/git/doc
	https://spectrum-os.org/git/mktuntap
	https://spectrum-os.org/git/nixpkgs
	https://spectrum-os.org/git/spectrum
	https://spectrum-os.org/git/ucspi-vsock
	https://spectrum-os.org/git/www

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).