Signed-off-by: Jiri Denemark <jdenemar@xxxxxxxxxx>
Reviewed-by: Peter Krempa <pkrempa@xxxxxxxxxx>
Reviewed-by: Pavel Hrdina <phrdina@xxxxxxxxxx>
---
Notes:
Version 2:
- no change
include/libvirt/libvirt-domain.h | 16 ++++++++++++++++
src/libvirt-domain.c | 10 ++++++----
2 files changed, 22 insertions(+), 4 deletions(-)
diff --git a/include/libvirt/libvirt-domain.h b/include/libvirt/libvirt-domain.h
index 0b321f364a..2aec69bc54 100644
--- a/include/libvirt/libvirt-domain.h
+++ b/include/libvirt/libvirt-domain.h
@@ -4099,6 +4099,22 @@ int virDomainGetJobStats(virDomainPtr domain,
unsigned int flags);
int virDomainAbortJob(virDomainPtr dom);
+/**
+ * virDomainAbortJobFlagsValues:
+ *
+ * Flags OR'ed together to provide specific behavior when aborting a domain job.
+ *
+ * Since: 8.5.0
+ */
+typedef enum {
+ /* Interrupt post-copy migration. Since migration in a post-copy phase
+ * cannot be aborted without losing the domain (none of the hosts involved
+ * in migration has a complete state of the domain), the migration will be
+ * suspended and it can later be resumed using virDomainMigrate* APIs with
+ * VIR_MIGRATE_POSTCOPY_RESUME flag. (Since: 8.5.0) */
+ VIR_DOMAIN_ABORT_JOB_POSTCOPY = 1 << 0,
+} virDomainAbortJobFlagsValues;
+
int virDomainAbortJobFlags(virDomainPtr dom,
unsigned int flags);
diff --git a/src/libvirt-domain.c b/src/libvirt-domain.c
index 1b367ca9ba..4a4f6424d7 100644
--- a/src/libvirt-domain.c
+++ b/src/libvirt-domain.c
@@ -9473,12 +9473,12 @@ virDomainAbortJob(virDomainPtr domain)
/**
* virDomainAbortJobFlags:
* @domain: a domain object
- * @flags: extra flags; not used yet, callers should always pass 0
+ * @flags: bitwise-OR of virDomainAbortJobFlagsValues
*
* Requests that the current background job be aborted at the
* soonest opportunity. In case the job is a migration in a post-copy mode,
- * this function will report an error (see virDomainMigrateStartPostCopy for
- * more details).
+ * this function will report an error unless VIR_DOMAIN_ABORT_JOB_POSTCOPY
+ * flag is used (see virDomainMigrateStartPostCopy for more details).
*
* Returns 0 in case of success and -1 in case of failure.
*
@@ -9820,7 +9820,9 @@ virDomainMigrateGetMaxSpeed(virDomainPtr domain,
* VIR_DOMAIN_PAUSED_POSTCOPY_FAILED if even the connection between QEMU
* processes gets broken. It's up to the upper layer to decide what to do in
* such case. Because of this, libvirt will refuse to cancel post-copy
- * migration via virDomainAbortJob.
+ * migration via virDomainAbortJobFlags unless it is called with
+ * VIR_DOMAIN_ABORT_JOB_POSTCOPY, in which case the post-copy migration will be
+ * paused.
*
* Failed post-copy migration can be recovered once the cause for the failure
* (e.g., a network issue) is resolved by repeating the migration with an
--
2.35.1
