libvirt/src/util/virnetdev.h
Peter Krempa d40e9d1df8 virNetDevGetVirtualFunctions: Directly return virPCIVirtualFunctionList
Remove the conversion from virPCIVirtualFunctionList which encapsulates
the list of virtual functions to two disjunct arrays.

This greatly simplifies the fetching of the parameters as well as
cleanup in the caller.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
2021-08-09 10:09:00 +02:00

341 lines
12 KiB
C

/*
* Copyright (C) 2007-2016 Red Hat, Inc.
*
* 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/>.
*/
#pragma once
#include "virbitmap.h"
#include "virsocketaddr.h"
#include "virmacaddr.h"
#include "virpci.h"
#include "virnetdevvlan.h"
#include "virenum.h"
#ifdef WITH_NET_IF_H
# include <net/if.h>
#endif
#ifdef WITH_STRUCT_IFREQ
typedef struct ifreq virIfreq;
#else
typedef void virIfreq;
#endif
/* Used for prefix of ifname of any tap device name generated
* dynamically by libvirt, cannot be used for a persistent network name.
*/
#define VIR_NET_GENERATED_VNET_PREFIX "vnet"
/* libvirt will start macvtap/macvlan interface names with one of
* these prefixes when it auto-generates the name
*/
#define VIR_NET_GENERATED_MACVTAP_PREFIX "macvtap"
#define VIR_NET_GENERATED_MACVLAN_PREFIX "macvlan"
typedef enum {
VIR_NETDEV_RX_FILTER_MODE_NONE = 0,
VIR_NETDEV_RX_FILTER_MODE_NORMAL,
VIR_NETDEV_RX_FILTER_MODE_ALL,
VIR_NETDEV_RX_FILTER_MODE_LAST
} virNetDevRxFilterMode;
VIR_ENUM_DECL(virNetDevRxFilterMode);
typedef struct _virNetDevRxFilter virNetDevRxFilter;
struct _virNetDevRxFilter {
char *name; /* the alias used by qemu, *not* name used by guest */
virMacAddr mac;
bool promiscuous;
bool broadcastAllowed;
struct {
int mode; /* enum virNetDevRxFilterMode */
bool overflow;
virMacAddr *table;
size_t nTable;
} unicast;
struct {
int mode; /* enum virNetDevRxFilterMode */
bool overflow;
virMacAddr *table;
size_t nTable;
} multicast;
struct {
int mode; /* enum virNetDevRxFilterMode */
unsigned int *table;
size_t nTable;
} vlan;
};
typedef enum {
VIR_NETDEV_IF_STATE_UNKNOWN = 1,
VIR_NETDEV_IF_STATE_NOT_PRESENT,
VIR_NETDEV_IF_STATE_DOWN,
VIR_NETDEV_IF_STATE_LOWER_LAYER_DOWN,
VIR_NETDEV_IF_STATE_TESTING,
VIR_NETDEV_IF_STATE_DORMANT,
VIR_NETDEV_IF_STATE_UP,
VIR_NETDEV_IF_STATE_LAST
} virNetDevIfState;
VIR_ENUM_DECL(virNetDevIfState);
typedef struct _virNetDevIfLink virNetDevIfLink;
struct _virNetDevIfLink {
virNetDevIfState state; /* link state */
unsigned int speed; /* link speed in Mbits per second */
};
typedef enum {
VIR_NET_DEV_FEAT_GRXCSUM,
VIR_NET_DEV_FEAT_GTXCSUM,
VIR_NET_DEV_FEAT_GSG,
VIR_NET_DEV_FEAT_GTSO,
VIR_NET_DEV_FEAT_GGSO,
VIR_NET_DEV_FEAT_GGRO,
VIR_NET_DEV_FEAT_LRO,
VIR_NET_DEV_FEAT_RXVLAN,
VIR_NET_DEV_FEAT_TXVLAN,
VIR_NET_DEV_FEAT_NTUPLE,
VIR_NET_DEV_FEAT_RXHASH,
VIR_NET_DEV_FEAT_RDMA,
VIR_NET_DEV_FEAT_TXUDPTNL,
VIR_NET_DEV_FEAT_SWITCHDEV,
VIR_NET_DEV_FEAT_LAST
} virNetDevFeature;
VIR_ENUM_DECL(virNetDevFeature);
/* Modeled after struct ethtool_coalesce, see linux/ethtool.h for explanations
* of particular fields */
typedef struct _virNetDevCoalesce virNetDevCoalesce;
struct _virNetDevCoalesce {
uint32_t rx_coalesce_usecs;
uint32_t rx_max_coalesced_frames;
uint32_t rx_coalesce_usecs_irq;
uint32_t rx_max_coalesced_frames_irq;
uint32_t tx_coalesce_usecs;
uint32_t tx_max_coalesced_frames;
uint32_t tx_coalesce_usecs_irq;
uint32_t tx_max_coalesced_frames_irq;
uint32_t stats_block_coalesce_usecs;
uint32_t use_adaptive_rx_coalesce;
uint32_t use_adaptive_tx_coalesce;
uint32_t pkt_rate_low;
uint32_t rx_coalesce_usecs_low;
uint32_t rx_max_coalesced_frames_low;
uint32_t tx_coalesce_usecs_low;
uint32_t tx_max_coalesced_frames_low;
uint32_t pkt_rate_high;
uint32_t rx_coalesce_usecs_high;
uint32_t rx_max_coalesced_frames_high;
uint32_t tx_coalesce_usecs_high;
uint32_t tx_max_coalesced_frames_high;
uint32_t rate_sample_interval;
};
typedef enum {
VIR_NET_DEV_GEN_NAME_VNET,
VIR_NET_DEV_GEN_NAME_MACVTAP,
VIR_NET_DEV_GEN_NAME_MACVLAN,
VIR_NET_DEV_GEN_NAME_LAST
} virNetDevGenNameType;
typedef struct _virNetDevGenName virNetDevGenName;
struct _virNetDevGenName {
int lastID; /* not "unsigned" because callers use %d */
const char *prefix;
virMutex mutex;
};
int virNetDevSetupControl(const char *ifname,
virIfreq *ifr)
G_GNUC_WARN_UNUSED_RESULT;
int virNetDevExists(const char *brname)
ATTRIBUTE_NONNULL(1) G_GNUC_WARN_UNUSED_RESULT G_GNUC_NO_INLINE;
int virNetDevSetOnline(const char *ifname,
bool online)
ATTRIBUTE_NONNULL(1) G_GNUC_WARN_UNUSED_RESULT G_GNUC_NO_INLINE;
int virNetDevGetOnline(const char *ifname,
bool *online)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevSetMAC(const char *ifname,
const virMacAddr *macaddr)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT G_GNUC_NO_INLINE;
int virNetDevGetMAC(const char *ifname,
virMacAddr *macaddr)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevReplaceMacAddress(const char *linkdev,
const virMacAddr *macaddress,
const char *stateDir)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3)
G_GNUC_WARN_UNUSED_RESULT;
int virNetDevRestoreMacAddress(const char *linkdev,
const char *stateDir)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevSetCoalesce(const char *ifname,
virNetDevCoalesce *coalesce,
bool update)
ATTRIBUTE_NONNULL(1) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevSetMTU(const char *ifname,
int mtu)
ATTRIBUTE_NONNULL(1) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevSetMTUFromDevice(const char *ifname,
const char *otherifname)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevGetMTU(const char *ifname)
ATTRIBUTE_NONNULL(1) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevSetNamespace(const char *ifname, pid_t pidInNs)
ATTRIBUTE_NONNULL(1) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevSetName(const char *ifname, const char *newifname)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
char *virNetDevGetName(int ifindex)
G_GNUC_WARN_UNUSED_RESULT;
int virNetDevGetIndex(const char *ifname, int *ifindex)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevGetVLanID(const char *ifname, int *vlanid)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevGetMaster(const char *ifname, char **master)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevValidateConfig(const char *ifname,
const virMacAddr *macaddr, int ifindex)
ATTRIBUTE_NONNULL(1) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevIsVirtualFunction(const char *ifname)
ATTRIBUTE_NONNULL(1) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevGetVirtualFunctionIndex(const char *pfname, const char *vfname,
int *vf_index)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3)
G_GNUC_WARN_UNUSED_RESULT;
int virNetDevGetPhysicalFunction(const char *ifname, char **pfname)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevPFGetVF(const char *pfname, int vf, char **vfname)
ATTRIBUTE_NONNULL(1) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevGetPhysPortID(const char *ifname,
char **physPortID)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2)
G_GNUC_WARN_UNUSED_RESULT;
int virNetDevGetPhysPortName(const char *ifname,
char **physPortName)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2)
G_GNUC_WARN_UNUSED_RESULT;
int virNetDevGetVirtualFunctions(const char *pfname,
virPCIVirtualFunctionList **vfs)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevSaveNetConfig(const char *linkdev, int vf,
const char *stateDir,
bool saveVlan)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(3) G_GNUC_WARN_UNUSED_RESULT;
int
virNetDevReadNetConfig(const char *linkdev, int vf,
const char *stateDir,
virMacAddr **adminMAC,
virNetDevVlan **vlan,
virMacAddr **MAC)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(3) ATTRIBUTE_NONNULL(4)
ATTRIBUTE_NONNULL(5) ATTRIBUTE_NONNULL(6) G_GNUC_WARN_UNUSED_RESULT;
int
virNetDevSetNetConfig(const char *linkdev, int vf,
const virMacAddr *adminMAC,
const virNetDevVlan *vlan,
const virMacAddr *MAC,
bool setVLan)
ATTRIBUTE_NONNULL(1) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevGetVirtualFunctionInfo(const char *vfname, char **pfname,
int *vf)
ATTRIBUTE_NONNULL(1);
int virNetDevGetFeatures(const char *ifname,
virBitmap **out)
ATTRIBUTE_NONNULL(1) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevGetLinkInfo(const char *ifname,
virNetDevIfLink *lnk)
ATTRIBUTE_NONNULL(1);
virNetDevRxFilter *virNetDevRxFilterNew(void)
G_GNUC_WARN_UNUSED_RESULT;
void virNetDevRxFilterFree(virNetDevRxFilter *filter);
int virNetDevGetRxFilter(const char *ifname,
virNetDevRxFilter **filter)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevAddMulti(const char *ifname,
virMacAddr *macaddr)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevDelMulti(const char *ifname,
virMacAddr *macaddr)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevSetPromiscuous(const char *ifname, bool promiscuous)
ATTRIBUTE_NONNULL(1) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevGetPromiscuous(const char *ifname, bool *promiscuous)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevSetRcvMulti(const char *ifname, bool receive)
ATTRIBUTE_NONNULL(1) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevGetRcvMulti(const char *ifname, bool *receive)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevSetRcvAllMulti(const char *ifname, bool receive)
ATTRIBUTE_NONNULL(1) G_GNUC_WARN_UNUSED_RESULT;
int virNetDevGetRcvAllMulti(const char *ifname, bool *receive)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) G_GNUC_WARN_UNUSED_RESULT;
#define SYSFS_NET_DIR "/sys/class/net/"
#define SYSFS_INFINIBAND_DIR "/sys/class/infiniband/"
int virNetDevSysfsFile(char **pf_sysfs_device_link,
const char *ifname,
const char *file)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2) ATTRIBUTE_NONNULL(3)
G_GNUC_WARN_UNUSED_RESULT G_GNUC_NO_INLINE;
int virNetDevRunEthernetScript(const char *ifname, const char *script)
G_GNUC_NO_INLINE;
int virNetDevVFInterfaceStats(virPCIDeviceAddress *vfAddr,
virDomainInterfaceStatsPtr stats)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
G_DEFINE_AUTOPTR_CLEANUP_FUNC(virNetDevRxFilter, virNetDevRxFilterFree);
void virNetDevReserveName(const char *name);
int virNetDevGenerateName(char **ifname, virNetDevGenNameType type);