mirror of https://gitee.com/openkylin/libvirt.git
list: Define new API virConnectListAllNodeDevices
This is to list the node device objects, supports to filter the results by capability types. include/libvirt/libvirt.h.in: Declare enum virConnectListAllNodeDeviceFlags and virConnectListAllNodeDevices. python/generator.py: Skip auto-generating src/driver.h: (virDrvConnectListAllNodeDevices) src/libvirt.c: Implement the public API src/libvirt_public.syms: Export the symbol to public
This commit is contained in:
parent
14dd70cca2
commit
c6a3be5dff
|
@ -2834,6 +2834,28 @@ int virNodeListDevices (virConnectPtr conn,
|
|||
char **const names,
|
||||
int maxnames,
|
||||
unsigned int flags);
|
||||
/*
|
||||
* virConnectListAllNodeDevices:
|
||||
*
|
||||
* Flags used to filter the returned node devices. Flags in each group
|
||||
* are exclusive. Currently only one group to filter the devices by cap
|
||||
* type.
|
||||
*/
|
||||
typedef enum {
|
||||
VIR_CONNECT_LIST_NODE_DEVICES_CAP_SYSTEM = 1 << 0, /* System capability */
|
||||
VIR_CONNECT_LIST_NODE_DEVICES_CAP_PCI_DEV = 1 << 1, /* PCI device */
|
||||
VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_DEV = 1 << 2, /* USB device */
|
||||
VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_INTERFACE = 1 << 3, /* USB interface */
|
||||
VIR_CONNECT_LIST_NODE_DEVICES_CAP_NET = 1 << 4, /* Network device */
|
||||
VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_HOST = 1 << 5, /* SCSI Host Bus Adapter */
|
||||
VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_TARGET = 1 << 6, /* SCSI Target */
|
||||
VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI = 1 << 7, /* SCSI device */
|
||||
VIR_CONNECT_LIST_NODE_DEVICES_CAP_STORAGE = 1 << 8, /* Storage device */
|
||||
} virConnectListAllNodeDeviceFlags;
|
||||
|
||||
int virConnectListAllNodeDevices (virConnectPtr conn,
|
||||
virNodeDevicePtr **devices,
|
||||
unsigned int flags);
|
||||
|
||||
virNodeDevicePtr virNodeDeviceLookupByName (virConnectPtr conn,
|
||||
const char *name);
|
||||
|
|
|
@ -464,6 +464,7 @@ skip_function = (
|
|||
'virStoragePoolListAllVolumes', # overridden in virStoragePool.py
|
||||
'virConnectListAllNetworks', # overridden in virConnect.py
|
||||
'virConnectListAllInterfaces', # overridden in virConnect.py
|
||||
'virConnectListAllNodeDevices', # overridden in virConnect.py
|
||||
|
||||
'virStreamRecvAll', # Pure python libvirt-override-virStream.py
|
||||
'virStreamSendAll', # Pure python libvirt-override-virStream.py
|
||||
|
|
|
@ -1483,6 +1483,9 @@ typedef int (*virDevMonListDevices)(virConnectPtr conn,
|
|||
char **const names,
|
||||
int maxnames,
|
||||
unsigned int flags);
|
||||
typedef int (*virDevMonListAllNodeDevices)(virConnectPtr conn,
|
||||
virNodeDevicePtr **devices,
|
||||
unsigned int flags);
|
||||
|
||||
typedef virNodeDevicePtr (*virDevMonDeviceLookupByName)(virConnectPtr conn,
|
||||
const char *name);
|
||||
|
@ -1516,6 +1519,7 @@ struct _virDeviceMonitor {
|
|||
virDrvClose close;
|
||||
virDevMonNumOfDevices numOfDevices;
|
||||
virDevMonListDevices listDevices;
|
||||
virDevMonListAllNodeDevices listAllNodeDevices;
|
||||
virDevMonDeviceLookupByName deviceLookupByName;
|
||||
virDevMonDeviceGetXMLDesc deviceGetXMLDesc;
|
||||
virDevMonDeviceGetParent deviceGetParent;
|
||||
|
|
|
@ -13796,6 +13796,75 @@ error:
|
|||
return -1;
|
||||
}
|
||||
|
||||
/**
|
||||
* virConnectListAllNodeDevices:
|
||||
* @conn: Pointer to the hypervisor connection.
|
||||
* @devices: Pointer to a variable to store the array containing the node
|
||||
* device objects or NULL if the list is not required (just returns
|
||||
* number of node devices).
|
||||
* @flags: bitwise-OR of virConnectListAllNodeDevices.
|
||||
*
|
||||
* Collect the list of node devices, and allocate an array to store those
|
||||
* objects.
|
||||
*
|
||||
* Normally, all node devices are returned; however, @flags can be used to
|
||||
* filter the results for a smaller list of targeted node devices. The valid
|
||||
* flags are divided into groups, where each group contains bits that
|
||||
* describe mutually exclusive attributes of a node device, and where all bits
|
||||
* within a group describe all possible node devices.
|
||||
*
|
||||
* Only one group of the @flags is provided to filter the node devices by
|
||||
* capability type, flags include:
|
||||
* VIR_CONNECT_LIST_NODE_DEVICES_CAP_SYSTEM
|
||||
* VIR_CONNECT_LIST_NODE_DEVICES_CAP_PCI_DEV
|
||||
* VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_DEV
|
||||
* VIR_CONNECT_LIST_NODE_DEVICES_CAP_USB_INTERFACE
|
||||
* VIR_CONNECT_LIST_NODE_DEVICES_CAP_NET
|
||||
* VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_HOST
|
||||
* VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI_TARGET
|
||||
* VIR_CONNECT_LIST_NODE_DEVICES_CAP_SCSI
|
||||
* VIR_CONNECT_LIST_NODE_DEVICES_CAP_STORAGE
|
||||
*
|
||||
* Returns the number of node devices found or -1 and sets @devices to NULL in
|
||||
* case of error. On success, the array stored into @devices is guaranteed to
|
||||
* have an extra allocated element set to NULL but not included in the return
|
||||
* count, to make iteration easier. The caller is responsible for calling
|
||||
* virNodeDeviceFree() on each array element, then calling free() on
|
||||
* @devices.
|
||||
*/
|
||||
int
|
||||
virConnectListAllNodeDevices(virConnectPtr conn,
|
||||
virNodeDevicePtr **devices,
|
||||
unsigned int flags)
|
||||
{
|
||||
VIR_DEBUG("conn=%p, devices=%p, flags=%x", conn, devices, flags);
|
||||
|
||||
virResetLastError();
|
||||
|
||||
if (devices)
|
||||
*devices = NULL;
|
||||
|
||||
if (!VIR_IS_CONNECT(conn)) {
|
||||
virLibConnError(VIR_ERR_INVALID_CONN, __FUNCTION__);
|
||||
virDispatchError(NULL);
|
||||
return -1;
|
||||
}
|
||||
|
||||
if (conn->deviceMonitor &&
|
||||
conn->deviceMonitor->listAllNodeDevices) {
|
||||
int ret;
|
||||
ret = conn->deviceMonitor->listAllNodeDevices(conn, devices, flags);
|
||||
if (ret < 0)
|
||||
goto error;
|
||||
return ret;
|
||||
}
|
||||
|
||||
virLibConnError(VIR_ERR_NO_SUPPORT, __FUNCTION__);
|
||||
|
||||
error:
|
||||
virDispatchError(conn);
|
||||
return -1;
|
||||
}
|
||||
|
||||
/**
|
||||
* virNodeListDevices:
|
||||
|
@ -13807,6 +13876,8 @@ error:
|
|||
*
|
||||
* Collect the list of node devices, and store their names in @names
|
||||
*
|
||||
* For more control over the results, see virConnectListAllNodeDevices().
|
||||
*
|
||||
* If the optional 'cap' argument is non-NULL, then the count
|
||||
* will be restricted to devices with the specified capability
|
||||
*
|
||||
|
|
|
@ -558,6 +558,7 @@ LIBVIRT_0.10.2 {
|
|||
global:
|
||||
virConnectListAllInterfaces;
|
||||
virConnectListAllNetworks;
|
||||
virConnectListAllNodeDevices;
|
||||
virConnectListAllStoragePools;
|
||||
virStoragePoolListAllVolumes;
|
||||
} LIBVIRT_0.10.0;
|
||||
|
|
Loading…
Reference in New Issue