External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-03-07 17:28:15 +00:00
Code

virDomainGetBlockJobInfo: Reword docs for fallback values

Browse Source 
Explicitly state that if 'end == 1' the data doesn't represent actual
progress in most cases.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
This commit is contained in:
Peter Krempa 2020-12-04 16:07:57 +01:00 committed by Michal Privoznik
parent a015b5c0a1
commit 29976c0de9
1 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
src/libvirt-domain.c
View File

@ -9940,12 +9940,18 @@ virDomainBlockJobAbort(virDomainPtr dom, const char *disk,
* can be found by calling virDomainGetXMLDesc() and inspecting * can be found by calling virDomainGetXMLDesc() and inspecting
* elements within //domain/devices/disk. * elements within //domain/devices/disk.
* *
* As a corner case underlying hypervisor may report cur == 0 and * In cases when libvirt can't determine actual progress of the block job from
* end == 0 when the block job hasn't been started yet. In this * the underlying hypervisor due to corner cases such as the job wasn't yet
* case libvirt reports cur = 0 and end = 1. However, hypervisor * fully initialized, or finalized and thus the progress can't be queried,
* may return cur == 0 and end == 0 if the block job has finished * libvirt reports 'cur = 0, end = 1'.
* and was no-op. In this case libvirt reports cur = 1 and end = 1. *
* Since 2.3.0. * For jobs requiring finalizing via qemuDomainBlockJobAbort() with
* VIR_DOMAIN_BLOCK_JOB_ABORT_PIVOT flag which reached synchronised phase, but
* were empty, or the progress can't be determined libvirt returns
* 'cur = 1, end = 1'.
*
* Users thus should not consider any data where 'end = 1' as absolute progress
* value.
* *
* Applications looking for a reliable and low-overhead way to determine whether * Applications looking for a reliable and low-overhead way to determine whether
* a block job already finished or reached synchronised phase should register a * a block job already finished or reached synchronised phase should register a