aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Levon <john.levon@nutanix.com>2023-09-18 10:51:10 +0100
committerGitHub <noreply@github.com>2023-09-18 10:51:10 +0100
commit3c18696427c4db338919f9a9e1943589a5a523b5 (patch)
treeb4593cdc5eabd081fd8bf6212bc17ec23cbb5048
parent190f85bf9c114bf7c981bb8908394368f84c0c04 (diff)
downloadlibvfio-user-3c18696427c4db338919f9a9e1943589a5a523b5.zip
libvfio-user-3c18696427c4db338919f9a9e1943589a5a523b5.tar.gz
libvfio-user-3c18696427c4db338919f9a9e1943589a5a523b5.tar.bz2
Add some notes on live migration version and SPDK usage. (#783)
Signed-off-by: John Levon <john.levon@nutanix.com>
-rw-r--r--README.md9
-rw-r--r--docs/spdk.md5
2 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1a01e35..3f8ae54 100644
--- a/README.md
+++ b/README.md
@@ -241,6 +241,15 @@ demonstrate the benefits of shadow ioeventfd, see
Other usage notes
=================
+Live migration
+--------------
+
+The `master` branch of `libvfio-user` implements live migration with a protocol
+based on vfio's v2 protocol. Currently, there is no support for this in any qemu
+client. For current use cases that support live migration, such as SPDK, you
+should refer to the [https://github.com/nutanix/libvfio-user/tree/migration-v1]
+(migration-v1 branch).
+
qemu
----
diff --git a/docs/spdk.md b/docs/spdk.md
index 5007239..2af2a39 100644
--- a/docs/spdk.md
+++ b/docs/spdk.md
@@ -96,6 +96,11 @@ Finally, type `q` in the source QEMU monitor to exit source QEMU.
For more information in live migration see
https://www.linux-kvm.org/page/Migration.
+Note that the above live migration code in `qemu` and `SPDK` relies on the older
+live migration format, this is kept in the
+[https://github.com/nutanix/libvfio-user/tree/migration-v1](migration-v1)
+branch of `libvfio-user`.
+
libvirt
-------