aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Levon <john.levon@nutanix.com>2022-05-16 17:17:46 +0100
committerGitHub <noreply@github.com>2022-05-16 17:17:46 +0100
commite2b923744b9e17fefe0de2ae117092b2bf217f54 (patch)
tree60908c4cdc773b411aa0392d75bc87ef1dfd1450
parentaa3087d1ed5a29146e6ae9e29810e5dcba6c4bbe (diff)
downloadlibvfio-user-e2b923744b9e17fefe0de2ae117092b2bf217f54.zip
libvfio-user-e2b923744b9e17fefe0de2ae117092b2bf217f54.tar.gz
libvfio-user-e2b923744b9e17fefe0de2ae117092b2bf217f54.tar.bz2
add a diagram to README.md (#686)
Signed-off-by: John Levon <john.levon@nutanix.com> Reviewed-by: Thanos Makatos <thanos.makatos@nutanix.com>
-rw-r--r--README.md2
-rw-r--r--docs/libvfio-user.drawio1
-rw-r--r--docs/libvfio-user.pngbin0 -> 29709 bytes
3 files changed, 3 insertions, 0 deletions
diff --git a/README.md b/README.md
index 96d30b9..dcbe711 100644
--- a/README.md
+++ b/README.md
@@ -7,6 +7,8 @@ protocol](https://lists.gnu.org/archive/html/qemu-devel/2020-11/msg02458.html)
over a UNIX socket to a server. This library, `libvfio-user`, provides an API
for implementing such servers.
+![vfio-user example block diagram](docs/libvfio-user.png)
+
[VFIO](https://www.kernel.org/doc/Documentation/vfio.txt) is a kernel facility
for providing secure access to PCI devices in userspace (including pass-through
to a VM). With `vfio-user`, instead of talking to the kernel, all interactions
diff --git a/docs/libvfio-user.drawio b/docs/libvfio-user.drawio
new file mode 100644
index 0000000..16afb3f
--- /dev/null
+++ b/docs/libvfio-user.drawio
@@ -0,0 +1 @@
+<mxfile host="app.diagrams.net" modified="2021-08-20T12:51:21.195Z" agent="5.0 (X11)" etag="AYlB-JMCpR6h74k4k3Fb" version="14.9.8"><diagram id="GylRyqdljB-qn8E3LoDb" name="Page-1">3Vlbc+I2FP41PIax5QvmkUBomyZtZrJtt4+yJWNthEWFzGV/fSUkg22ZAI2huzuTmVhHOsfW+c6dnjeeb37icJE9M4RpDzho0/MmPQBcH4Ce+nPQVlMGgaMJM06QOXQgvJKv2BDLYwVBeFk7KBijgizqxITlOU5EjQY5Z+v6sZTR+lsXcIYtwmsCqU39iyCRaWoEBgf6z5jMsvLNbjjUO3NYHjY3WWYQsXWF5D30vDFnTOin+WaMqVJeqRfNNz2yu/8wjnNxDsPj06OTPQAAQ77wpv7j2+MduQu1lBWkhbkwwiuSYKW9xYKSBArCcnMBsS21wlmRI6wEuz3vfp0RgV8XMFG7a2kHkpaJOTXbK8yFFERHlMxySRNMHUgJpWNGGd9J9FCAI+RL+lJw9oYrOxGIvTCUO+ZTpTS8OaoDd69ZaZKYzbHgW3nEMIAB6AeaaVu3s/UBXC8ytKwCLPANHzQGNdsLP+hcPhi1XwCBa0HQAyGVr71HZCUfZ2J3d02KeZMi39lyrkKiJF6lhN0VS8yPMXUJb8yEYHMb4RSiIQraEIbYdz3QEcJRA982gIPABth1rwUwOAfgl/EvKoqlM4XETtdXgMrSfBwFvgzIFlbTaDgajrpBxC8RKBEBgYWI67S4nOdcCRDPAoTkAnNeLMTyR1Bw+H8r2LcUbMwbLr5HBQfu8AwLdm+o4OCckHIy6lscS5a8YaHgwXx14DuddD4CaTNNpClIkjaoURiHQWeFQHgaUuDfEFLXrgNWlmJxjkaqqFVplkqwPmUkbzoI5KLtzG5jSmh5UIqqrjZEfK48/y2fnX5gVhOlNadcbMtFLu/9ubqocKnlgW23Kvn0rTCyCu8GePLmrOAJfkdpkT4nrzbD4pS/2MbAMZX17ar+HW3IGtYXJhNF1YgagXfQKCH09xuuamneEOSdEqQvaAnaGdr+Ph+wPbtEqQSPpg1K4J5gLPs8757jJfkK492WUzdEaMrBBKvc2lInzglCitHYg2ngjLDevm064ebv+NIH8P6YJ9v1xZN6KXCeyYxfraH6NlJja+1xy9To2sXH5HmkDUxqiNIWk/5ete8531rl59qVyevL5Nee8mZdOqRsF/lSaAJ7+E+hJiD3YxkricLG+Q2vD+RKFys/KF/NU/lvH5z6SaUi0ZKvUJKMwcNgOj4KfRflSFQHMrBx9MIWHP3LcfxDqu33+IualQGH6jiuW6CEFkhGqWl1YNDP9Asoyd/0uUwINXobKflg+oVw2M8LAXOy6Sey7QfTWA3dlJyX0SeZWXwTIN43m0FFPcbOuvLPfZ65wEUno0lXLjqsB8iorc7sxkPlsgLuBU47sHw2oaxAd9l2IfsAsmRXiZjNASDEUdpa94dJhOO0GziarbI9HHKDm07/hpbujw6Hysnsuc2cKOLbdHDHETsWSDtAMmwiaUM57CZinpn5HAvJP59v4DdplOD2fnkf3rqo8xr5yVZ2m9tcrcyIzvGay+cfCSV4V0P8qGOPfarZNtYVINt+/fgPXiOXh9+2dKN6+IXQe/gX</diagram></mxfile> \ No newline at end of file
diff --git a/docs/libvfio-user.png b/docs/libvfio-user.png
new file mode 100644
index 0000000..b56f617
--- /dev/null
+++ b/docs/libvfio-user.png
Binary files differ