dsg/vhost
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

doc: add postcopy feature description

Browse source 
New sections in README files describe what `postcopy`
feature enables and the limitation of using it with
`xen` feature.

Signed-off-by: Egor Lazarchuk <yegorlz@amazon.co.uk>
This commit is contained in:
Egor Lazarchuk 2024-01-22 13:38:12 +00:00 • committed by Erik Schilling
parent a051b5c3b2
commit ee2ffdf890
2 changed files with 16 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

10
vhost-user-backend/README.md
View file

@ -98,6 +98,16 @@ impl VhostUserBackendMut for VhostUserService {
}
```
## Postcopy support
To enabled POSTCOPY_* messages support there is a `postcopy` feature.
Due to how Xen handles memory mappings the `postcopy` feature is not compatible
with `xen` feature. Enabling both at the same time will result in a compilation error.
`postcopy` feature enables optional `userfaultfd` dependency in order to create and
interact with `userfaultfd` object. This requires access permission to `/dev/userfaultfd`
file from the backend.
## Xen support
Supporting Xen requires special handling while mapping the guest memory. The

6
vhost/README.md
View file

@ -31,6 +31,12 @@ Frontend is the application that shares its virtqueues, backend is the consumer
of the virtqueues. Frontend and backend can be either a client (i.e. connecting)
or server (listening) in the socket communication.
## Postcopy support
To enabled POSTCOPY_* messages support there is a `postcopy` feature.
Due to how Xen handles memory mappings the `postcopy` feature is not compatible
with `xen` feature. Enabling both at the same time will result in a compilation error.
## Xen support
Supporting Xen requires special handling while mapping the guest memory. The