aboutsummaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)AuthorFilesLines
2024-05-15improve documentation on testing with qemu (#797)John Levon1-53/+10
Pull out the qemu testing documentation into a separate file, and expand it with step-by-step instructions on how to use the gpio example. In addition switch to the jlevon/master.vfio-user branch, which is much more up to date than the previous Oracle series. Signed-off-by: John Levon <john.levon@nutanix.com>
2024-05-14docs: correct markdown links (#796)John Levon1-2/+1
The syntax is [free text](https:/..). Signed-off-by: John Levon <john.levon@nutanix.com>
2023-09-18Add some notes on live migration version and SPDK usage. (#783)John Levon1-0/+9
Signed-off-by: John Levon <john.levon@nutanix.com>
2023-06-22fix build instructions for samples (#739)William Henderson1-5/+5
Signed-off-by: William Henderson <william.henderson@nutanix.com> Reviewed-by: Thanos Makatos <thanos.makatos@nutanix.com>
2022-11-22shadow ioeventfd: add demo (#722)Thanos Makatos1-0/+8
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com> Reviewed-by: John Levon <john.levon@nutanix.com>
2022-11-16check spelling (#720)John Levon1-1/+1
Use misspell-fixer if available, and correct the small number of errors it found. Rather than trying to install into the CI, run it directly from a github action. Signed-off-by: John Levon <john.levon@nutanix.com> Reviewed-by: Swapnil Ingle <swapnil.ingle@nutanix.com> Reviewed-by: Thanos Makatos <thanos.makatos@nutanix.com>
2022-06-16improve README.md (#696)John Levon1-114/+100
Re-organize the README so it flows better, and make several fixes/improvements. Signed-off-by: John Levon <john.levon@nutanix.com> Reviewed-by: Thanos Makatos <thanos.makatos@nutanix.com>
2022-05-27add some documentation on memory handling (#676)John Levon1-1/+2
Cover briefly how to access client memory. Signed-off-by: John Levon <john.levon@nutanix.com> Reviewed-by: Raphael Norwitz <raphael.norwitz@nutanix.com> Reviewed-by: Thanos Makatos <thanos.makatos@nutanix.com>
2022-05-16add a slack invite link (#685)John Levon1-1/+2
Signed-off-by: John Levon <john.levon@nutanix.com> Reviewed-by: Swapnil Ingle <swapnil.ingle@nutanix.com> Reviewed-by: Thanos Makatos <thanos.makatos@nutanix.com>
2022-05-16add a diagram to README.md (#686)John Levon1-0/+2
Signed-off-by: John Levon <john.levon@nutanix.com> Reviewed-by: Thanos Makatos <thanos.makatos@nutanix.com>
2022-05-09docs: rewrite to refer to meson commands instead of cmakeDaniel P. Berrangé1-6/+3
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2022-05-09drop usage of MD5_*() (#667)John Levon1-2/+2
These functions from openssl are deprecated, and hence break builds with openssl 3.0, which now has a compiler warning for them. We only use them to check buffer contents; replace them with CRC code from DPDK instead, and entirely drop use of openssl. Signed-off-by: John Levon <john.levon@nutanix.com> Reviewed-by: Swapnil Ingle <swapnil.ingle@nutanix.com> Reviewed-by: Thanos Makatos <thanos.makatos@nutanix.com>
2021-12-01add SPDK instructions (#632)Thanos Makatos1-21/+5
And move them to separate file. Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com> Reviewed-by: John Levon <john.levon@nutanix.com>
2021-11-30introduce device quiesce callback (#609)Thanos Makatos1-0/+5
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com> Reviewed-by: John Leon <john.levon@nutanix.com>
2021-11-12add a doc on testingJohn Levon1-3/+5
Split out testing information to a separate document. Signed-off-by: John Levon <john.levon@nutanix.com> Reviewed-by: Swapnil Ingle <swapnil.ingle@nutanix.com>
2021-08-18improve README, mention vIOMMU (#590)John Levon1-36/+50
Re-organize the README some more, and explicitly document that vIOMMU doesn't work well currently. Signed-off-by: John Levon <john.levon@nutanix.com> Reviewed-by: Sebastien Boeuf <sebastien.boeuf@intel.com> Reviewed-by: Swapnil Ingle <swapnil.ingle@nutanix.com>
2021-08-18improve API docs a little bit (#587)John Levon1-8/+11
Clarify a couple of minor things in the API documentation and README. Signed-off-by: John Levon <john.levon@nutanix.com> Reviewed-by: Swapnil Ingle <swapnil.ingle@nutanix.com>
2021-06-09Add valgrind build requirement for running tests (e.g. 'make test')Ivan Efremov1-0/+1
2021-05-20migration: various dirty page tracking fixes (#457)Thanos Makatos1-0/+43
- document how to use a vfio-user device with libvirt - document how to use SPDK's nvmf/vfio-user target with libvirt - replace vfio_bitmap with vfio_user_bitmap and vfio_iommu_type1_dirty_bitmap_get with vfio_user_bitmap_range - fix bug for calculating number of pages needed for dirty page bitmap - align number of bytes for dirty page bitmap to QWORD - add debug messages around dirty page tracking - only support flags=0 when doing DMA unmap - set device state to running after reset - allow region read/write even if device is in stopped state - allow transitioning from stopped/stop-and-copy state to running state - fix unit tests Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com> Reviewed-by: John Levon <john.levon@nutanix.com>
2021-05-04README: fix a small typo (#455)John Levon1-1/+1
Signed-off-by: John Levon <john.levon@nutanix.com> Reviewed-by: Thanos Makatos <thanos.makatos@nutanix.com>
2021-04-08update README.md with chat and contributing info (#436)John Levon1-2/+16
Signed-off-by: John Levon <john.levon@nutanix.com> Reviewed-by: Swapnil Ingle <swapnil.ingle@nutanix.com>
2021-03-22README: fix qemu cmdline (#398)John Levon1-6/+7
For the GPIO demo, we were asking qemu to create a file-backed hostmem backend, but neglecting to actually allocate guest RAM from it. While we're here, let's give some clues on how to use hugepages and share memory with libvfio-user. Signed-off-by: John Levon <john.levon@nutanix.com> Reviewed-by: Swapnil Ingle <swapnil.ingle@nutanix.com>
2021-01-27fix obsolete reference to muser (#268)Thanos Makatos1-2/+2
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2021-01-25add pre-copy phase in live migration example (#247)Thanos Makatos1-6/+16
This patch adds a simplistic pre-copy phase in the live migration sample. The end goal is have a separate thread in the client to modify device state while the device is in the pre-copy phase. This will be done in later patches. BAR1 is saved during the pre-copy phase and BAR0 is saved during the stop-and-copy phase. This is purely for convenience. There are quite a few assumptions and FIXMEs, even in the client code. We plan to address them in future patches. Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2021-01-04remove Python bindings (#223)John Levon1-5/+1
They haven't kept pace with recent changes, and at this point are of no real use (and besides, options like CFFI are likely better than hand-rolled bindings). Signed-off-by: John Levon <john.levon@nutanix.com> Reviewed-by: Thanos Makatos <thanos.makatos@nutanix.com>
2020-12-15add CentOS 7 build to github pull_request workflow (#194)John Levon1-2/+2
Signed-off-by: John Levon <john.levon@nutanix.com> Reviewed-by: Thanos Makatos <thanos.makatos@nutanix.com>
2020-12-10add docs on running the gpio server back to README (#181)John Levon1-3/+36
Signed-off-by: John Levon <john.levon@nutanix.com> Reviewed-by: Thanos Makatos <thanos.makatos@nutanix.com>
2020-12-07add lspci sampleThanos Makatos1-6/+39
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2020-12-03document mailing listThanos Makatos1-0/+8
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2020-12-01include entire license text in READMEThanos Makatos1-2/+27
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2020-11-30add copyright notice in READMEThanos Makatos1-0/+1
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2020-11-30add license notice in READMEThanos Makatos1-0/+6
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2020-11-27rename to libvfio-user (#128)John Levon1-41/+79
The muser name no longer reflects the implementation, and will just serve to confuse. Bite the bullet now, and rename ourselves to reflect the actual implementation. Signed-off-by: John Levon <john.levon@nutanix.com> Reviewed-by: Thanos Makatos <thanos.makatos@nutanix.com> Reviewed-by: Swapnil Ingle <swapnil.ingle@nutanix.com>
2020-11-20document how to create release buildThanos Makatos1-0/+4
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2020-11-18document how to run client/server sampleThanos Makatos1-0/+31
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2020-11-16Makefile: Remove unused KDIRSwapnil Ingle1-2/+0
Also remove kernel build from travis.yml Signed-off-by: Swapnil Ingle <swapnil.ingle@nutanix.com>
2020-11-11drop the kernel moduleThanos Makatos1-129/+5
vfio-user is on track to be accepted upstream, so we shouldn't need muser.ko. This patch removes it since keeping it in the source is a maintanance burden. The last version is stashed in https://github.com/nutanix/muser/tree/kmod. If there is a valid use case we can reconsider reinstating it. fixes #67 Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2020-11-11Merge branch 'master' into vfio-userThanos Makatos1-0/+11
Last merge before we drop muser.ko. Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2020-07-21document current work regarding VFIO-over-socketThanos Makatos1-0/+11
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2020-07-21focus README on VFIO-over-socketThanos Makatos1-81/+71
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2020-01-20explain how to enable VFIO tracing in QEMUThanos Makatos1-0/+5
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2019-11-12fix instructions on how to patchThanos Makatos1-2/+2
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2019-11-12explain improperly patched kernel errorThanos Makatos1-0/+9
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2019-09-20experimental support for Python bindings plus sampleThanos Makatos1-0/+2
This patch introduces experimental support for Python bindings, plus the GPIO sample in Python. There are many issues with extending Python (from module stuff to error handling), the most important one is the inability to modify the buf argument to the region access callbacks when a region is read from. For now I've resorted to returning the value since in libmuser we limit accesses to 8 bytes (maybe we should consider that for the C API as well?). Also, the fact that we don't pass the region being accessed as an argument to a region access callback results in clunky code (see the REGION_WRAP macro). Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2019-09-20update documentation on how to buildThanos Makatos1-10/+4
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2019-09-05Improve README overview sectionFelipe Franciosi1-21/+26
2019-09-05use numerical steps in example explanationThanos Makatos1-21/+21
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2019-09-05use numerical steps in example explanationThanos Makatos1-4/+3
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2019-09-05introduce gpio sampleThanos Makatos1-1/+37
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
2019-09-05Initial commitFelipe Franciosi1-0/+134
generated by cgit v1.1 at 2024-06-29 13:11:45 +0000