openkylin
/
libvirt
mirror of https://gitee.com/openkylin/libvirt.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

src: Document virDomainInterfaceStats() limitation 

For unmanaged ethernet <interface/>, it is user's responsibility
to set up the interface. And as such it can be just anything.
Therefore, it's (almost) impossible for the
virDomainInterfaceStats() API to tell whether RX/TX values need
to be swapped or copied verbatim into the return structure.
Document this limitation.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Martin Kletzander <mkletzan@redhat.com>
This commit is contained in:
Michal Privoznik 2023-03-06 09:56:52 +01:00
parent 172dd3d9f7
commit 928e741172
2 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/manpages/virsh.rst
View File

@ -2012,7 +2012,8 @@ interface stats are only available for interfaces that have a
physical source interface. This does not include, for example, a
'user' interface type since it is a virtual LAN with NAT to the
outside world. *interface-device* can be the interface target by
name or MAC address.
name or MAC address. Please note, for an unmanaged *ethernet*
type returned stats might have RX/TX swapped.
domiftune

3
src/libvirt-domain.c
View File

@ -5965,6 +5965,9 @@ virDomainBlockStatsFlags(virDomainPtr dom,
*
* The returned stats are from domain's point of view.
*
* Please note, for an unmanaged ethernet type, returned stats
* might have RX/TX swapped.
*
* Returns: 0 in case of success or -1 in case of failure.
*
* Since: 0.3.2