mirror of
https://github.com/rust-vmm/vhost-device.git
synced 2026-01-04 00:06:17 +00:00
fe1778a731
This adds a basic template crate, which will be useful for new developers to understand how things work and layout all basic stuff they are expected to write to make it work. The current implementation just parses all the requests from the virtqueue and prints the number of descriptor chains and size of each descriptor buffer in there. This adds basic sanity tests as well for the same, which can be run to test the working of the crate. Signed-off-by: Viresh Kumar <viresh.kumar@linaro.org>
38 lines
756 B
Markdown
38 lines
756 B
Markdown
# vhost-device-template - Template for a vhost-device backend implementation
|
|
|
|
## Description
|
|
This program is a template for developers who intend to write a new vhost-device
|
|
backend.
|
|
|
|
## Synopsis
|
|
|
|
**vhost-device-template** [*OPTIONS*]
|
|
|
|
## Options
|
|
|
|
.. program:: vhost-device-template
|
|
|
|
.. option:: -h, --help
|
|
|
|
Print help.
|
|
|
|
.. option:: -s, --socket-path=PATH
|
|
|
|
Location of vhost-user Unix domain socket. This supports a single socket /
|
|
guest.
|
|
|
|
## Examples
|
|
|
|
The daemon should be started first:
|
|
|
|
::
|
|
|
|
host# vhost-device-template --socket-path=vfoo.sock
|
|
|
|
## License
|
|
|
|
This project is licensed under either of
|
|
|
|
- [Apache License](http://www.apache.org/licenses/LICENSE-2.0), Version 2.0
|
|
- [BSD-3-Clause License](https://opensource.org/licenses/BSD-3-Clause)
|