diff --git a/doc/README.md b/doc/README.md index 5b3367794..26a03c56a 100644 --- a/doc/README.md +++ b/doc/README.md @@ -15,3 +15,6 @@ For specific brick'informations and shemas: * [VTEP brick.](VTEP.md) * [SWITCH brick.](SWITCH.md) +About out testing architecture: +* `wip` + diff --git a/doc/VHOST.md b/doc/VHOST.md index 11a15f181..71807988e 100644 --- a/doc/VHOST.md +++ b/doc/VHOST.md @@ -34,6 +34,14 @@ As previously described, VHOST use an unix socket and a hugepage to communicate It manages a queue and reduce memmory write/free operatons.
It's based on a cient(s)/server model, meaning that one server can handle multiple connections through the socket.
Only packet address in the hugepage are flowing through the socket.
+## How to use it + +* `pg_vhost_start("/tmp", &error)`: start the vhost driver and setup the socket's folder. +* `pg_vhost_new("vhost-0", flags, &error);`: create the brick. The socket will be named `qemu-vhost-0`. Here are some flags availables: + * `PG_VHOST_USER_CLIENT` + * `PG_VHOST_USER_DEQUEUE_ZERO_COPY` + ## Current VHOST brick's status -Currently the VHOST brick only works in SERVER mode... Which means that if packetgraph crash, we will need to reboot VMs...
Not a good thing! +Currently the VHOST brick only works in SERVER mode... Which means that if packetgraph crash, we will need to reboot VMs...
Not a good thing!
+However, a PR in in progress to adress this issue.