[mirror_qemu.git] / include / net / net.h

#ifndef QEMU_NET_H
#define QEMU_NET_H

#include "qemu/queue.h"
#include "qemu-common.h"
#include "qapi/qmp/qdict.h"
#include "qemu/option.h"
#include "net/queue.h"
#include "migration/vmstate.h"
#include "qapi-types.h"

#define MAX_QUEUE_NUM 1024

/* Maximum GSO packet size (64k) plus plenty of room for
 * the ethernet and virtio_net headers
 */
#define NET_BUFSIZE (4096 + 65536)

struct MACAddr {
    uint8_t a[6];
};

/* qdev nic properties */

typedef struct NICPeers {
    NetClientState *ncs[MAX_QUEUE_NUM];
    int32_t queues;
} NICPeers;

typedef struct NICConf {
    MACAddr macaddr;
    NICPeers peers;
    int32_t bootindex;
} NICConf;

#define DEFINE_NIC_PROPERTIES(_state, _conf)                            \
    DEFINE_PROP_MACADDR("mac",   _state, _conf.macaddr),                \
    DEFINE_PROP_VLAN("vlan",     _state, _conf.peers),                   \
    DEFINE_PROP_NETDEV("netdev", _state, _conf.peers)


/* Net clients */

typedef void (NetPoll)(NetClientState *, bool enable);
typedef int (NetCanReceive)(NetClientState *);
typedef ssize_t (NetReceive)(NetClientState *, const uint8_t *, size_t);
typedef ssize_t (NetReceiveIOV)(NetClientState *, const struct iovec *, int);
typedef void (NetCleanup) (NetClientState *);
typedef void (LinkStatusChanged)(NetClientState *);
typedef void (NetClientDestructor)(NetClientState *);
typedef RxFilterInfo *(QueryRxFilter)(NetClientState *);
typedef bool (HasUfo)(NetClientState *);
typedef bool (HasVnetHdr)(NetClientState *);
typedef bool (HasVnetHdrLen)(NetClientState *, int);
typedef void (UsingVnetHdr)(NetClientState *, bool);
typedef void (SetOffload)(NetClientState *, int, int, int, int, int);
typedef void (SetVnetHdrLen)(NetClientState *, int);

typedef struct NetClientInfo {
    NetClientOptionsKind type;
    size_t size;
    NetReceive *receive;
    NetReceive *receive_raw;
    NetReceiveIOV *receive_iov;
    NetCanReceive *can_receive;
    NetCleanup *cleanup;
    LinkStatusChanged *link_status_changed;
    QueryRxFilter *query_rx_filter;
    NetPoll *poll;
    HasUfo *has_ufo;
    HasVnetHdr *has_vnet_hdr;
    HasVnetHdrLen *has_vnet_hdr_len;
    UsingVnetHdr *using_vnet_hdr;
    SetOffload *set_offload;
    SetVnetHdrLen *set_vnet_hdr_len;
} NetClientInfo;

struct NetClientState {
    NetClientInfo *info;
    int link_down;
    QTAILQ_ENTRY(NetClientState) next;
    NetClientState *peer;
    NetQueue *incoming_queue;
    char *model;
    char *name;
    char info_str[256];
    unsigned receive_disabled : 1;
    NetClientDestructor *destructor;
    unsigned int queue_index;
    unsigned rxfilter_notify_enabled:1;
};

typedef struct NICState {
    NetClientState *ncs;
    NICConf *conf;
    void *opaque;
    bool peer_deleted;
} NICState;

char *qemu_mac_strdup_printf(const uint8_t *macaddr);
NetClientState *qemu_find_netdev(const char *id);
int qemu_find_net_clients_except(const char *id, NetClientState **ncs,
                                 NetClientOptionsKind type, int max);
NetClientState *qemu_new_net_client(NetClientInfo *info,
                                    NetClientState *peer,
                                    const char *model,
                                    const char *name);
NICState *qemu_new_nic(NetClientInfo *info,
                       NICConf *conf,
                       const char *model,
                       const char *name,
                       void *opaque);
void qemu_del_nic(NICState *nic);
NetClientState *qemu_get_subqueue(NICState *nic, int queue_index);
NetClientState *qemu_get_queue(NICState *nic);
NICState *qemu_get_nic(NetClientState *nc);
void *qemu_get_nic_opaque(NetClientState *nc);
void qemu_del_net_client(NetClientState *nc);
NetClientState *qemu_find_vlan_client_by_name(Monitor *mon, int vlan_id,
                                              const char *client_str);
typedef void (*qemu_nic_foreach)(NICState *nic, void *opaque);
void qemu_foreach_nic(qemu_nic_foreach func, void *opaque);
int qemu_can_send_packet(NetClientState *nc);
ssize_t qemu_sendv_packet(NetClientState *nc, const struct iovec *iov,
                          int iovcnt);
ssize_t qemu_sendv_packet_async(NetClientState *nc, const struct iovec *iov,
                                int iovcnt, NetPacketSent *sent_cb);
void qemu_send_packet(NetClientState *nc, const uint8_t *buf, int size);
ssize_t qemu_send_packet_raw(NetClientState *nc, const uint8_t *buf, int size);
ssize_t qemu_send_packet_async(NetClientState *nc, const uint8_t *buf,
                               int size, NetPacketSent *sent_cb);
void qemu_purge_queued_packets(NetClientState *nc);
void qemu_flush_queued_packets(NetClientState *nc);
void qemu_format_nic_info_str(NetClientState *nc, uint8_t macaddr[6]);
bool qemu_has_ufo(NetClientState *nc);
bool qemu_has_vnet_hdr(NetClientState *nc);
bool qemu_has_vnet_hdr_len(NetClientState *nc, int len);
void qemu_using_vnet_hdr(NetClientState *nc, bool enable);
void qemu_set_offload(NetClientState *nc, int csum, int tso4, int tso6,
                      int ecn, int ufo);
void qemu_set_vnet_hdr_len(NetClientState *nc, int len);
void qemu_macaddr_default_if_unset(MACAddr *macaddr);
int qemu_show_nic_models(const char *arg, const char *const *models);
void qemu_check_nic_model(NICInfo *nd, const char *model);
int qemu_find_nic_model(NICInfo *nd, const char * const *models,
                        const char *default_model);

ssize_t qemu_deliver_packet(NetClientState *sender,
                            unsigned flags,
                            const uint8_t *data,
                            size_t size,
                            void *opaque);
ssize_t qemu_deliver_packet_iov(NetClientState *sender,
                            unsigned flags,
                            const struct iovec *iov,
                            int iovcnt,
                            void *opaque);

void print_net_client(Monitor *mon, NetClientState *nc);
void hmp_info_network(Monitor *mon, const QDict *qdict);

/* NIC info */

#define MAX_NICS 8

struct NICInfo {
    MACAddr macaddr;
    char *model;
    char *name;
    char *devaddr;
    NetClientState *netdev;
    int used;         /* is this slot in nd_table[] being used? */
    int instantiated; /* does this NICInfo correspond to an instantiated NIC? */
    int nvectors;
};

extern int nb_nics;
extern NICInfo nd_table[MAX_NICS];
extern int default_net;
extern const char *host_net_devices[];

/* from net.c */
extern const char *legacy_tftp_prefix;
extern const char *legacy_bootp_filename;

int net_client_init(QemuOpts *opts, int is_netdev, Error **errp);
int net_client_parse(QemuOptsList *opts_list, const char *str);
int net_init_clients(void);
void net_check_clients(void);
void net_cleanup(void);
void hmp_host_net_add(Monitor *mon, const QDict *qdict);
void hmp_host_net_remove(Monitor *mon, const QDict *qdict);
void netdev_add(QemuOpts *opts, Error **errp);
int qmp_netdev_add(Monitor *mon, const QDict *qdict, QObject **ret);

int net_hub_id_for_client(NetClientState *nc, int *id);
NetClientState *net_hub_port_find(int hub_id);

#define DEFAULT_NETWORK_SCRIPT "/etc/qemu-ifup"
#define DEFAULT_NETWORK_DOWN_SCRIPT "/etc/qemu-ifdown"
#define DEFAULT_BRIDGE_HELPER CONFIG_QEMU_HELPERDIR "/qemu-bridge-helper"
#define DEFAULT_BRIDGE_INTERFACE "br0"

void qdev_set_nic_properties(DeviceState *dev, NICInfo *nd);

#define POLYNOMIAL 0x04c11db6
unsigned compute_mcast_idx(const uint8_t *ep);

#define vmstate_offset_macaddr(_state, _field)                       \
    vmstate_offset_array(_state, _field.a, uint8_t,                \
                         sizeof(typeof_field(_state, _field)))

#define VMSTATE_MACADDR(_field, _state) {                            \
    .name       = (stringify(_field)),                               \
    .size       = sizeof(MACAddr),                                   \
    .info       = &vmstate_info_buffer,                              \
    .flags      = VMS_BUFFER,                                        \
    .offset     = vmstate_offset_macaddr(_state, _field),            \
}

#endif
Commit	Line	Data
	1	#ifndef QEMU_NET_H
	2	#define QEMU_NET_H
	3
	4	#include "qemu/queue.h"
	5	#include "qemu-common.h"
	6	#include "qapi/qmp/qdict.h"
	7	#include "qemu/option.h"
	8	#include "net/queue.h"
	9	#include "migration/vmstate.h"
	10	#include "qapi-types.h"
	11
	12	#define MAX_QUEUE_NUM 1024
	13
	14	/* Maximum GSO packet size (64k) plus plenty of room for
	15	* the ethernet and virtio_net headers
	16	*/
	17	#define NET_BUFSIZE (4096 + 65536)
	18
	19	struct MACAddr {
	20	uint8_t a[6];
	21	};
	22
	23	/* qdev nic properties */
	24
	25	typedef struct NICPeers {
	26	NetClientState *ncs[MAX_QUEUE_NUM];
	27	int32_t queues;
	28	} NICPeers;
	29
	30	typedef struct NICConf {
	31	MACAddr macaddr;
	32	NICPeers peers;
	33	int32_t bootindex;
	34	} NICConf;
	35
	36	#define DEFINE_NIC_PROPERTIES(_state, _conf) \
	37	DEFINE_PROP_MACADDR("mac", _state, _conf.macaddr), \
	38	DEFINE_PROP_VLAN("vlan", _state, _conf.peers), \
	39	DEFINE_PROP_NETDEV("netdev", _state, _conf.peers)
	40
	41
	42	/* Net clients */
	43
	44	typedef void (NetPoll)(NetClientState *, bool enable);
	45	typedef int (NetCanReceive)(NetClientState *);
	46	typedef ssize_t (NetReceive)(NetClientState , const uint8_t , size_t);
	47	typedef ssize_t (NetReceiveIOV)(NetClientState , const struct iovec , int);
	48	typedef void (NetCleanup) (NetClientState *);
	49	typedef void (LinkStatusChanged)(NetClientState *);
	50	typedef void (NetClientDestructor)(NetClientState *);
	51	typedef RxFilterInfo (QueryRxFilter)(NetClientState );
	52	typedef bool (HasUfo)(NetClientState *);
	53	typedef bool (HasVnetHdr)(NetClientState *);
	54	typedef bool (HasVnetHdrLen)(NetClientState *, int);
	55	typedef void (UsingVnetHdr)(NetClientState *, bool);
	56	typedef void (SetOffload)(NetClientState *, int, int, int, int, int);
	57	typedef void (SetVnetHdrLen)(NetClientState *, int);
	58
	59	typedef struct NetClientInfo {
	60	NetClientOptionsKind type;
	61	size_t size;
	62	NetReceive *receive;
	63	NetReceive *receive_raw;
	64	NetReceiveIOV *receive_iov;
	65	NetCanReceive *can_receive;
	66	NetCleanup *cleanup;
	67	LinkStatusChanged *link_status_changed;
	68	QueryRxFilter *query_rx_filter;
	69	NetPoll *poll;
	70	HasUfo *has_ufo;
	71	HasVnetHdr *has_vnet_hdr;
	72	HasVnetHdrLen *has_vnet_hdr_len;
	73	UsingVnetHdr *using_vnet_hdr;
	74	SetOffload *set_offload;
	75	SetVnetHdrLen *set_vnet_hdr_len;
	76	} NetClientInfo;
	77
	78	struct NetClientState {
	79	NetClientInfo *info;
	80	int link_down;
	81	QTAILQ_ENTRY(NetClientState) next;
	82	NetClientState *peer;
	83	NetQueue *incoming_queue;
	84	char *model;
	85	char *name;
	86	char info_str[256];
	87	unsigned receive_disabled : 1;
	88	NetClientDestructor *destructor;
	89	unsigned int queue_index;
	90	unsigned rxfilter_notify_enabled:1;
	91	};
	92
	93	typedef struct NICState {
	94	NetClientState *ncs;
	95	NICConf *conf;
	96	void *opaque;
	97	bool peer_deleted;
	98	} NICState;
	99
	100	char qemu_mac_strdup_printf(const uint8_t macaddr);
	101	NetClientState qemu_find_netdev(const char id);
	102	int qemu_find_net_clients_except(const char id, NetClientState *ncs,
	103	NetClientOptionsKind type, int max);
	104	NetClientState qemu_new_net_client(NetClientInfo info,
	105	NetClientState *peer,
	106	const char *model,
	107	const char *name);
	108	NICState qemu_new_nic(NetClientInfo info,
	109	NICConf *conf,
	110	const char *model,
	111	const char *name,
	112	void *opaque);
	113	void qemu_del_nic(NICState *nic);
	114	NetClientState qemu_get_subqueue(NICState nic, int queue_index);
	115	NetClientState qemu_get_queue(NICState nic);
	116	NICState qemu_get_nic(NetClientState nc);
	117	void qemu_get_nic_opaque(NetClientState nc);
	118	void qemu_del_net_client(NetClientState *nc);
	119	NetClientState qemu_find_vlan_client_by_name(Monitor mon, int vlan_id,
	120	const char *client_str);
	121	typedef void (qemu_nic_foreach)(NICState nic, void *opaque);
	122	void qemu_foreach_nic(qemu_nic_foreach func, void *opaque);
	123	int qemu_can_send_packet(NetClientState *nc);
	124	ssize_t qemu_sendv_packet(NetClientState nc, const struct iovec iov,
	125	int iovcnt);
	126	ssize_t qemu_sendv_packet_async(NetClientState nc, const struct iovec iov,
	127	int iovcnt, NetPacketSent *sent_cb);
	128	void qemu_send_packet(NetClientState nc, const uint8_t buf, int size);
	129	ssize_t qemu_send_packet_raw(NetClientState nc, const uint8_t buf, int size);
	130	ssize_t qemu_send_packet_async(NetClientState nc, const uint8_t buf,
	131	int size, NetPacketSent *sent_cb);
	132	void qemu_purge_queued_packets(NetClientState *nc);
	133	void qemu_flush_queued_packets(NetClientState *nc);
	134	void qemu_format_nic_info_str(NetClientState *nc, uint8_t macaddr[6]);
	135	bool qemu_has_ufo(NetClientState *nc);
	136	bool qemu_has_vnet_hdr(NetClientState *nc);
	137	bool qemu_has_vnet_hdr_len(NetClientState *nc, int len);
	138	void qemu_using_vnet_hdr(NetClientState *nc, bool enable);
	139	void qemu_set_offload(NetClientState *nc, int csum, int tso4, int tso6,
	140	int ecn, int ufo);
	141	void qemu_set_vnet_hdr_len(NetClientState *nc, int len);
	142	void qemu_macaddr_default_if_unset(MACAddr *macaddr);
	143	int qemu_show_nic_models(const char arg, const char const *models);
	144	void qemu_check_nic_model(NICInfo nd, const char model);
	145	int qemu_find_nic_model(NICInfo nd, const char const *models,
	146	const char *default_model);
	147
	148	ssize_t qemu_deliver_packet(NetClientState *sender,
	149	unsigned flags,
	150	const uint8_t *data,
	151	size_t size,
	152	void *opaque);
	153	ssize_t qemu_deliver_packet_iov(NetClientState *sender,
	154	unsigned flags,
	155	const struct iovec *iov,
	156	int iovcnt,
	157	void *opaque);
	158
	159	void print_net_client(Monitor mon, NetClientState nc);
	160	void hmp_info_network(Monitor mon, const QDict qdict);
	161
	162	/* NIC info */
	163
	164	#define MAX_NICS 8
	165
	166	struct NICInfo {
	167	MACAddr macaddr;
	168	char *model;
	169	char *name;
	170	char *devaddr;
	171	NetClientState *netdev;
	172	int used; /* is this slot in nd_table[] being used? */
	173	int instantiated; /* does this NICInfo correspond to an instantiated NIC? */
	174	int nvectors;
	175	};
	176
	177	extern int nb_nics;
	178	extern NICInfo nd_table[MAX_NICS];
	179	extern int default_net;
	180	extern const char *host_net_devices[];
	181
	182	/* from net.c */
	183	extern const char *legacy_tftp_prefix;
	184	extern const char *legacy_bootp_filename;
	185
	186	int net_client_init(QemuOpts opts, int is_netdev, Error *errp);
	187	int net_client_parse(QemuOptsList opts_list, const char str);
	188	int net_init_clients(void);
	189	void net_check_clients(void);
	190	void net_cleanup(void);
	191	void hmp_host_net_add(Monitor mon, const QDict qdict);
	192	void hmp_host_net_remove(Monitor mon, const QDict qdict);
	193	void netdev_add(QemuOpts opts, Error *errp);
	194	int qmp_netdev_add(Monitor mon, const QDict qdict, QObject **ret);
	195
	196	int net_hub_id_for_client(NetClientState nc, int id);
	197	NetClientState *net_hub_port_find(int hub_id);
	198
	199	#define DEFAULT_NETWORK_SCRIPT "/etc/qemu-ifup"
	200	#define DEFAULT_NETWORK_DOWN_SCRIPT "/etc/qemu-ifdown"
	201	#define DEFAULT_BRIDGE_HELPER CONFIG_QEMU_HELPERDIR "/qemu-bridge-helper"
	202	#define DEFAULT_BRIDGE_INTERFACE "br0"
	203
	204	void qdev_set_nic_properties(DeviceState dev, NICInfo nd);
	205
	206	#define POLYNOMIAL 0x04c11db6
	207	unsigned compute_mcast_idx(const uint8_t *ep);
	208
	209	#define vmstate_offset_macaddr(_state, _field) \
	210	vmstate_offset_array(_state, _field.a, uint8_t, \
	211	sizeof(typeof_field(_state, _field)))
	212
	213	#define VMSTATE_MACADDR(_field, _state) { \
	214	.name = (stringify(_field)), \
	215	.size = sizeof(MACAddr), \
	216	.info = &vmstate_info_buffer, \
	217	.flags = VMS_BUFFER, \
	218	.offset = vmstate_offset_macaddr(_state, _field), \
	219	}
	220
	221	#endif