From 3c18696427c4db338919f9a9e1943589a5a523b5 Mon Sep 17 00:00:00 2001 From: John Levon Date: Mon, 18 Sep 2023 10:51:10 +0100 Subject: [PATCH] Add some notes on live migration version and SPDK usage. (#783) Signed-off-by: John Levon --- README.md | 9 +++++++++ docs/spdk.md | 5 +++++ 2 files changed, 14 insertions(+) diff --git a/README.md b/README.md index 1a01e357..3f8ae54e 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 50072394..2af2a39f 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 -------