mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-10-07 06:45:45 +00:00
82c142b321
A new type to track USB addresses. Every <controller type='usb' index='i'/> is represented by an object of type virDomainUSBAddressHub located at buses[i]. Each of these hubs has up to 'nports' ports. If a port is occupied, it has the corresponding bit set in the 'ports' bitmap, e.g. port 1 would have the 0th bit set. If there is a hub on this port, then hubs[i] will point to this hub.
275 lines
11 KiB
C
275 lines
11 KiB
C
/*
|
|
* domain_addr.h: helper APIs for managing domain device addresses
|
|
*
|
|
* Copyright (C) 2006-2016 Red Hat, Inc.
|
|
* Copyright (C) 2006 Daniel P. Berrange
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2.1 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library. If not, see
|
|
* <http://www.gnu.org/licenses/>.
|
|
*
|
|
* Author: Daniel P. Berrange <berrange@redhat.com>
|
|
*/
|
|
|
|
#ifndef __DOMAIN_ADDR_H__
|
|
# define __DOMAIN_ADDR_H__
|
|
|
|
# include "domain_conf.h"
|
|
|
|
# define VIR_PCI_ADDRESS_SLOT_LAST 31
|
|
# define VIR_PCI_ADDRESS_FUNCTION_LAST 7
|
|
|
|
typedef enum {
|
|
VIR_PCI_CONNECT_HOTPLUGGABLE = 1 << 0, /* is hotplug needed/supported */
|
|
|
|
/* kinds of devices as a bitmap so they can be combined (some PCI
|
|
* controllers permit connecting multiple types of devices)
|
|
*/
|
|
VIR_PCI_CONNECT_TYPE_PCI_DEVICE = 1 << 1,
|
|
VIR_PCI_CONNECT_TYPE_PCIE_DEVICE = 1 << 2,
|
|
VIR_PCI_CONNECT_TYPE_PCIE_ROOT_PORT = 1 << 3,
|
|
VIR_PCI_CONNECT_TYPE_PCIE_SWITCH_UPSTREAM_PORT = 1 << 4,
|
|
VIR_PCI_CONNECT_TYPE_PCIE_SWITCH_DOWNSTREAM_PORT = 1 << 5,
|
|
} virDomainPCIConnectFlags;
|
|
|
|
/* a combination of all bits that describe the type of connections
|
|
* allowed, e.g. PCI, PCIe, switch
|
|
*/
|
|
# define VIR_PCI_CONNECT_TYPES_MASK \
|
|
(VIR_PCI_CONNECT_TYPE_PCI_DEVICE | VIR_PCI_CONNECT_TYPE_PCIE_DEVICE | \
|
|
VIR_PCI_CONNECT_TYPE_PCIE_SWITCH_UPSTREAM_PORT | \
|
|
VIR_PCI_CONNECT_TYPE_PCIE_SWITCH_DOWNSTREAM_PORT | \
|
|
VIR_PCI_CONNECT_TYPE_PCIE_ROOT_PORT)
|
|
|
|
/* combination of all bits that could be used to connect a normal
|
|
* endpoint device (i.e. excluding the connection possible between an
|
|
* upstream and downstream switch port, or a PCIe root port and a PCIe
|
|
* port)
|
|
*/
|
|
# define VIR_PCI_CONNECT_TYPES_ENDPOINT \
|
|
(VIR_PCI_CONNECT_TYPE_PCI_DEVICE | VIR_PCI_CONNECT_TYPE_PCIE_DEVICE)
|
|
|
|
virDomainPCIConnectFlags
|
|
virDomainPCIControllerModelToConnectType(virDomainControllerModelPCI model);
|
|
|
|
typedef struct {
|
|
virDomainControllerModelPCI model;
|
|
/* flags and min/max can be computed from model, but
|
|
* having them ready makes life easier.
|
|
*/
|
|
virDomainPCIConnectFlags flags;
|
|
size_t minSlot, maxSlot; /* usually 0,0 or 0,31, or 1,31 */
|
|
/* Each bit in a slot represents one function on that slot. If the
|
|
* bit is set, that function is in use by a device.
|
|
*/
|
|
uint8_t slots[VIR_PCI_ADDRESS_SLOT_LAST + 1];
|
|
} virDomainPCIAddressBus;
|
|
typedef virDomainPCIAddressBus *virDomainPCIAddressBusPtr;
|
|
|
|
struct _virDomainPCIAddressSet {
|
|
virDomainPCIAddressBus *buses;
|
|
size_t nbuses;
|
|
virPCIDeviceAddress lastaddr;
|
|
virDomainPCIConnectFlags lastFlags;
|
|
bool dryRun; /* on a dry run, new buses are auto-added
|
|
and addresses aren't saved in device infos */
|
|
};
|
|
typedef struct _virDomainPCIAddressSet virDomainPCIAddressSet;
|
|
typedef virDomainPCIAddressSet *virDomainPCIAddressSetPtr;
|
|
|
|
char *virDomainPCIAddressAsString(virPCIDeviceAddressPtr addr)
|
|
ATTRIBUTE_NONNULL(1);
|
|
|
|
virDomainPCIAddressSetPtr virDomainPCIAddressSetAlloc(unsigned int nbuses);
|
|
|
|
void virDomainPCIAddressSetFree(virDomainPCIAddressSetPtr addrs);
|
|
|
|
bool virDomainPCIAddressFlagsCompatible(virPCIDeviceAddressPtr addr,
|
|
const char *addrStr,
|
|
virDomainPCIConnectFlags busFlags,
|
|
virDomainPCIConnectFlags devFlags,
|
|
bool reportError,
|
|
bool fromConfig)
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
|
|
|
|
bool virDomainPCIAddressValidate(virDomainPCIAddressSetPtr addrs,
|
|
virPCIDeviceAddressPtr addr,
|
|
const char *addrStr,
|
|
virDomainPCIConnectFlags flags,
|
|
bool fromConfig)
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3);
|
|
|
|
|
|
int virDomainPCIAddressBusSetModel(virDomainPCIAddressBusPtr bus,
|
|
virDomainControllerModelPCI model)
|
|
ATTRIBUTE_NONNULL(1);
|
|
|
|
bool virDomainPCIAddressSlotInUse(virDomainPCIAddressSetPtr addrs,
|
|
virPCIDeviceAddressPtr addr)
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
|
|
|
|
int virDomainPCIAddressSetGrow(virDomainPCIAddressSetPtr addrs,
|
|
virPCIDeviceAddressPtr addr,
|
|
virDomainPCIConnectFlags flags)
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
|
|
|
|
int virDomainPCIAddressReserveAddr(virDomainPCIAddressSetPtr addrs,
|
|
virPCIDeviceAddressPtr addr,
|
|
virDomainPCIConnectFlags flags,
|
|
bool reserveEntireSlot,
|
|
bool fromConfig)
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
|
|
|
|
int virDomainPCIAddressReserveSlot(virDomainPCIAddressSetPtr addrs,
|
|
virPCIDeviceAddressPtr addr,
|
|
virDomainPCIConnectFlags flags)
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
|
|
|
|
int virDomainPCIAddressEnsureAddr(virDomainPCIAddressSetPtr addrs,
|
|
virDomainDeviceInfoPtr dev)
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
|
|
|
|
int virDomainPCIAddressReleaseAddr(virDomainPCIAddressSetPtr addrs,
|
|
virPCIDeviceAddressPtr addr)
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
|
|
|
|
int virDomainPCIAddressReleaseSlot(virDomainPCIAddressSetPtr addrs,
|
|
virPCIDeviceAddressPtr addr)
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
|
|
|
|
int virDomainPCIAddressGetNextSlot(virDomainPCIAddressSetPtr addrs,
|
|
virPCIDeviceAddressPtr next_addr,
|
|
virDomainPCIConnectFlags flags)
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
|
|
|
|
int virDomainPCIAddressReserveNextSlot(virDomainPCIAddressSetPtr addrs,
|
|
virDomainDeviceInfoPtr dev,
|
|
virDomainPCIConnectFlags flags)
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
|
|
|
|
struct _virDomainCCWAddressSet {
|
|
virHashTablePtr defined;
|
|
virDomainDeviceCCWAddress next;
|
|
};
|
|
typedef struct _virDomainCCWAddressSet virDomainCCWAddressSet;
|
|
typedef virDomainCCWAddressSet *virDomainCCWAddressSetPtr;
|
|
|
|
int virDomainCCWAddressAssign(virDomainDeviceInfoPtr dev,
|
|
virDomainCCWAddressSetPtr addrs,
|
|
bool autoassign)
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
|
|
void virDomainCCWAddressSetFree(virDomainCCWAddressSetPtr addrs);
|
|
int virDomainCCWAddressAllocate(virDomainDefPtr def,
|
|
virDomainDeviceDefPtr dev,
|
|
virDomainDeviceInfoPtr info,
|
|
void *data)
|
|
ATTRIBUTE_NONNULL(3) ATTRIBUTE_NONNULL(4);
|
|
int virDomainCCWAddressValidate(virDomainDefPtr def,
|
|
virDomainDeviceDefPtr dev,
|
|
virDomainDeviceInfoPtr info,
|
|
void *data)
|
|
ATTRIBUTE_NONNULL(3) ATTRIBUTE_NONNULL(4);
|
|
|
|
int virDomainCCWAddressReleaseAddr(virDomainCCWAddressSetPtr addrs,
|
|
virDomainDeviceInfoPtr dev)
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
|
|
virDomainCCWAddressSetPtr virDomainCCWAddressSetCreate(void);
|
|
|
|
struct _virDomainVirtioSerialController {
|
|
unsigned int idx;
|
|
virBitmapPtr ports;
|
|
};
|
|
|
|
typedef struct _virDomainVirtioSerialController virDomainVirtioSerialController;
|
|
typedef virDomainVirtioSerialController *virDomainVirtioSerialControllerPtr;
|
|
|
|
struct _virDomainVirtioSerialAddrSet {
|
|
virDomainVirtioSerialControllerPtr *controllers;
|
|
size_t ncontrollers;
|
|
};
|
|
typedef struct _virDomainVirtioSerialAddrSet virDomainVirtioSerialAddrSet;
|
|
typedef virDomainVirtioSerialAddrSet *virDomainVirtioSerialAddrSetPtr;
|
|
|
|
virDomainVirtioSerialAddrSetPtr
|
|
virDomainVirtioSerialAddrSetCreate(void);
|
|
int
|
|
virDomainVirtioSerialAddrSetAddControllers(virDomainVirtioSerialAddrSetPtr addrs,
|
|
virDomainDefPtr def)
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
|
|
void
|
|
virDomainVirtioSerialAddrSetFree(virDomainVirtioSerialAddrSetPtr addrs);
|
|
bool
|
|
virDomainVirtioSerialAddrIsComplete(virDomainDeviceInfoPtr info);
|
|
int
|
|
virDomainVirtioSerialAddrAutoAssign(virDomainDefPtr def,
|
|
virDomainVirtioSerialAddrSetPtr addrs,
|
|
virDomainDeviceInfoPtr info,
|
|
bool allowZero)
|
|
ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3);
|
|
|
|
int
|
|
virDomainVirtioSerialAddrAssign(virDomainDefPtr def,
|
|
virDomainVirtioSerialAddrSetPtr addrs,
|
|
virDomainDeviceInfoPtr info,
|
|
bool allowZero,
|
|
bool portOnly)
|
|
ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3);
|
|
|
|
int
|
|
virDomainVirtioSerialAddrReserve(virDomainDefPtr def,
|
|
virDomainDeviceDefPtr dev,
|
|
virDomainDeviceInfoPtr info,
|
|
void *data)
|
|
ATTRIBUTE_NONNULL(3) ATTRIBUTE_NONNULL(4);
|
|
|
|
int
|
|
virDomainVirtioSerialAddrRelease(virDomainVirtioSerialAddrSetPtr addrs,
|
|
virDomainDeviceInfoPtr info)
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
|
|
|
|
bool
|
|
virDomainUSBAddressPortIsValid(unsigned int *port)
|
|
ATTRIBUTE_NONNULL(1);
|
|
|
|
void
|
|
virDomainUSBAddressPortFormatBuf(virBufferPtr buf,
|
|
unsigned int *port)
|
|
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
|
|
char *
|
|
virDomainUSBAddressPortFormat(unsigned int *port)
|
|
ATTRIBUTE_NONNULL(1);
|
|
|
|
typedef struct _virDomainUSBAddressHub virDomainUSBAddressHub;
|
|
typedef virDomainUSBAddressHub *virDomainUSBAddressHubPtr;
|
|
struct _virDomainUSBAddressHub {
|
|
/* indexes are shifted by one:
|
|
* ports[0] represents port 1, because ports are numbered from 1 */
|
|
virBitmapPtr portmap;
|
|
size_t nports;
|
|
virDomainUSBAddressHubPtr *ports;
|
|
};
|
|
|
|
struct _virDomainUSBAddressSet {
|
|
/* every <controller type='usb' index='i'> is represented
|
|
* as a hub at buses[i] */
|
|
virDomainUSBAddressHubPtr *buses;
|
|
size_t nbuses;
|
|
};
|
|
typedef struct _virDomainUSBAddressSet virDomainUSBAddressSet;
|
|
typedef virDomainUSBAddressSet *virDomainUSBAddressSetPtr;
|
|
|
|
virDomainUSBAddressSetPtr virDomainUSBAddressSetCreate(void);
|
|
void virDomainUSBAddressSetFree(virDomainUSBAddressSetPtr addrs);
|
|
|
|
#endif /* __DOMAIN_ADDR_H__ */
|