External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-02-22 11:22:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

lib: Add few flags for the bulk stats APIs

Browse Source 
Add domain list filtering functions and a flag to enforce checking
whether the remote daemon supports the requested stats groups.
This commit is contained in:
Peter Krempa 2014-08-27 17:02:50 +02:00
parent e41512246c
commit 1438807b7e
2 changed files with 46 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
include/libvirt/libvirt.h.in
View File

@ -2513,6 +2513,21 @@ typedef enum {
VIR_DOMAIN_STATS_STATE = (1 << 0), /* return domain state */ VIR_DOMAIN_STATS_STATE = (1 << 0), /* return domain state */
} virDomainStatsTypes; } virDomainStatsTypes;
typedef enum {
VIR_CONNECT_GET_ALL_DOMAINS_STATS_ACTIVE = VIR_CONNECT_LIST_DOMAINS_ACTIVE,
VIR_CONNECT_GET_ALL_DOMAINS_STATS_INACTIVE = VIR_CONNECT_LIST_DOMAINS_INACTIVE,
VIR_CONNECT_GET_ALL_DOMAINS_STATS_PERSISTENT = VIR_CONNECT_LIST_DOMAINS_PERSISTENT,
VIR_CONNECT_GET_ALL_DOMAINS_STATS_TRANSIENT = VIR_CONNECT_LIST_DOMAINS_TRANSIENT,
VIR_CONNECT_GET_ALL_DOMAINS_STATS_RUNNING = VIR_CONNECT_LIST_DOMAINS_RUNNING,
VIR_CONNECT_GET_ALL_DOMAINS_STATS_PAUSED = VIR_CONNECT_LIST_DOMAINS_PAUSED,
VIR_CONNECT_GET_ALL_DOMAINS_STATS_SHUTOFF = VIR_CONNECT_LIST_DOMAINS_SHUTOFF,
VIR_CONNECT_GET_ALL_DOMAINS_STATS_OTHER = VIR_CONNECT_LIST_DOMAINS_OTHER,
VIR_CONNECT_GET_ALL_DOMAINS_STATS_ENFORCE_STATS = 1 << 31, /* enforce requested stats */
} virConnectGetAllDomainStatsFlags;
int virConnectGetAllDomainStats(virConnectPtr conn, int virConnectGetAllDomainStats(virConnectPtr conn,
unsigned int stats, unsigned int stats,
virDomainStatsRecordPtr **retStats, virDomainStatsRecordPtr **retStats,

35
src/libvirt.c
View File

@ -21524,8 +21524,8 @@ virConnectGetDomainCapabilities(virConnectPtr conn,
* virConnectGetAllDomainStats: * virConnectGetAllDomainStats:
* @conn: pointer to the hypervisor connection * @conn: pointer to the hypervisor connection
* @stats: stats to return, binary-OR of virDomainStatsTypes * @stats: stats to return, binary-OR of virDomainStatsTypes
* @retStats: Pointer that will be filled with the array of returned stats. * @retStats: Pointer that will be filled with the array of returned stats
* @flags: extra flags; not used yet, so callers should always pass 0 * @flags: extra flags; binary-OR of virConnectGetAllDomainStatsFlags
* *
* Query statistics for all domains on a given connection. * Query statistics for all domains on a given connection.
* *
@ -21549,6 +21549,26 @@ virConnectGetDomainCapabilities(virConnectPtr conn,
* Using 0 for @stats returns all stats groups supported by the given * Using 0 for @stats returns all stats groups supported by the given
* hypervisor. * hypervisor.
* *
* Specifying VIR_CONNECT_GET_ALL_DOMAINS_STATS_ENFORCE_STATS as @flags makes
* the function return error in case some of the stat types in @stats were
* not recognized by the daemon.
*
* Similarly to virConnectListAllDomains, @flags can contain various flags to
* filter the list of domains to provide stats for.
*
* VIR_CONNECT_GET_ALL_DOMAINS_STATS_ACTIVE selects online domains while
* VIR_CONNECT_GET_ALL_DOMAINS_STATS_INACTIVE selects offline ones.
*
* VIR_CONNECT_GET_ALL_DOMAINS_STATS_PERSISTENT and
* VIR_CONNECT_GET_ALL_DOMAINS_STATS_TRANSIENT allow to filter the list
* according to their persistence.
*
* To filter the list of VMs by domain state @flags can contain
* VIR_CONNECT_GET_ALL_DOMAINS_STATS_RUNNING,
* VIR_CONNECT_GET_ALL_DOMAINS_STATS_PAUSED,
* VIR_CONNECT_GET_ALL_DOMAINS_STATS_SHUTOFF and/or
* VIR_CONNECT_GET_ALL_DOMAINS_STATS_OTHER for all other states.
*
* Returns the count of returned statistics structures on success, -1 on error. * Returns the count of returned statistics structures on success, -1 on error.
* The requested data are returned in the @retStats parameter. The returned * The requested data are returned in the @retStats parameter. The returned
* array should be freed by the caller. See virDomainStatsRecordListFree. * array should be freed by the caller. See virDomainStatsRecordListFree.
@ -21589,8 +21609,8 @@ virConnectGetAllDomainStats(virConnectPtr conn,
* virDomainListGetStats: * virDomainListGetStats:
* @doms: NULL terminated array of domains * @doms: NULL terminated array of domains
* @stats: stats to return, binary-OR of virDomainStatsTypes * @stats: stats to return, binary-OR of virDomainStatsTypes
* @retStats: Pointer that will be filled with the array of returned stats. * @retStats: Pointer that will be filled with the array of returned stats
* @flags: extra flags; not used yet, so callers should always pass 0 * @flags: extra flags; binary-OR of virConnectGetAllDomainStatsFlags
* *
* Query statistics for domains provided by @doms. Note that all domains in * Query statistics for domains provided by @doms. Note that all domains in
* @doms must share the same connection. * @doms must share the same connection.
@ -21615,6 +21635,13 @@ virConnectGetAllDomainStats(virConnectPtr conn,
* Using 0 for @stats returns all stats groups supported by the given * Using 0 for @stats returns all stats groups supported by the given
* hypervisor. * hypervisor.
* *
* Specifying VIR_CONNECT_GET_ALL_DOMAINS_STATS_ENFORCE_STATS as @flags makes
* the function return error in case some of the stat types in @stats were
* not recognized by the daemon.
*
* Note that any of the domain list filtering flags in @flags will be rejected
* by this function.
*
* Returns the count of returned statistics structures on success, -1 on error. * Returns the count of returned statistics structures on success, -1 on error.
* The requested data are returned in the @retStats parameter. The returned * The requested data are returned in the @retStats parameter. The returned
* array should be freed by the caller. See virDomainStatsRecordListFree. * array should be freed by the caller. See virDomainStatsRecordListFree.