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

#ifndef QEMU_NET_H
#define QEMU_NET_H

#include "qemu/queue.h"
#include "qapi-types.h"
#include "net/queue.h"
#include "migration/vmstate.h"

#define MAC_FMT "%02X:%02X:%02X:%02X:%02X:%02X"
#define MAC_ARG(x) ((uint8_t *)(x))[0], ((uint8_t *)(x))[1], \
                   ((uint8_t *)(x))[2], ((uint8_t *)(x))[3], \
                   ((uint8_t *)(x))[4], ((uint8_t *)(x))[5]

#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 int (SetVnetLE)(NetClientState *, bool);
typedef int (SetVnetBE)(NetClientState *, bool);
typedef struct SocketReadState SocketReadState;
typedef void (SocketReadStateFinalize)(SocketReadState *rs);

typedef struct NetClientInfo {
    NetClientDriver 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;
    SetVnetLE *set_vnet_le;
    SetVnetBE *set_vnet_be;
} 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;
    int vring_enable;
    int vnet_hdr_len;
    QTAILQ_HEAD(NetFilterHead, NetFilterState) filters;
};

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

struct SocketReadState {
    /* 0 = getting length, 1 = getting vnet header length, 2 = getting data */
    int state;
    /* This flag decide whether to read the vnet_hdr_len field */
    bool vnet_hdr;
    uint32_t index;
    uint32_t packet_len;
    uint32_t vnet_hdr_len;
    uint8_t buf[NET_BUFSIZE];
    SocketReadStateFinalize *finalize;
};

int net_fill_rstate(SocketReadState *rs, const uint8_t *buf, int size);
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,
                                 NetClientDriver 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);
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);
int qemu_set_vnet_le(NetClientState *nc, bool is_le);
int qemu_set_vnet_be(NetClientState *nc, bool is_be);
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_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);
void net_socket_rs_init(SocketReadState *rs,
                        SocketReadStateFinalize *finalize,
                        bool vnet_hdr);

/* 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 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, bool 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);
void qmp_netdev_add(QDict *qdict, QObject **ret, Error **errp);

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_BE 0x04c11db6
#define POLYNOMIAL_LE 0xedb88320
uint32_t net_crc32(const uint8_t *p, int len);
uint32_t net_crc32_le(const uint8_t *p, int len);
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
87ecb68b PB	1	#ifndef QEMU_NET_H
	2	#define QEMU_NET_H
	3
1de7afc9	4	#include "qemu/queue.h"
452fcdbc	5	#include "qapi-types.h"
e1144d00	6	#include "net/queue.h"
caf71f86	7	#include "migration/vmstate.h"
fbe78f4f	8
6d1d4939 DF	9	#define MAC_FMT "%02X:%02X:%02X:%02X:%02X:%02X"
	10	#define MAC_ARG(x) ((uint8_t )(x))[0], ((uint8_t )(x))[1], \
	11	((uint8_t )(x))[2], ((uint8_t )(x))[3], \
	12	((uint8_t )(x))[4], ((uint8_t )(x))[5]
	13
1ceef9f2 JW	14	#define MAX_QUEUE_NUM 1024
1ceef9f2 JW	15
d32fcad3 SF	16	/* Maximum GSO packet size (64k) plus plenty of room for
	17	* the ethernet and virtio_net headers
	18	*/
	19	#define NET_BUFSIZE (4096 + 65536)
	20
76d32cba GH	21	struct MACAddr {
	22	uint8_t a[6];
	23	};
	24
ed16ab5a GH	25	/* qdev nic properties */
ed16ab5a GH	26
1ceef9f2 JW	27	typedef struct NICPeers {
1ceef9f2 JW	28	NetClientState *ncs[MAX_QUEUE_NUM];
575a1c0e	29	int32_t queues;
1ceef9f2 JW	30	} NICPeers;
1ceef9f2 JW	31
ed16ab5a GH	32	typedef struct NICConf {
ed16ab5a GH	33	MACAddr macaddr;
1ceef9f2	34	NICPeers peers;
1ca4d09a	35	int32_t bootindex;
ed16ab5a GH	36	} NICConf;
	37
	38	#define DEFINE_NIC_PROPERTIES(_state, _conf) \
	39	DEFINE_PROP_MACADDR("mac", _state, _conf.macaddr), \
1ceef9f2	40	DEFINE_PROP_VLAN("vlan", _state, _conf.peers), \
45e8a9e1	41	DEFINE_PROP_NETDEV("netdev", _state, _conf.peers)
ed16ab5a	42
1ceef9f2	43
4e68f7a0	44	/* Net clients */
87ecb68b	45
4e68f7a0 SH	46	typedef void (NetPoll)(NetClientState *, bool enable);
	47	typedef int (NetCanReceive)(NetClientState *);
	48	typedef ssize_t (NetReceive)(NetClientState , const uint8_t , size_t);
	49	typedef ssize_t (NetReceiveIOV)(NetClientState , const struct iovec , int);
	50	typedef void (NetCleanup) (NetClientState *);
	51	typedef void (LinkStatusChanged)(NetClientState *);
f7860455	52	typedef void (NetClientDestructor)(NetClientState *);
b1be4280	53	typedef RxFilterInfo (QueryRxFilter)(NetClientState );
1f55ac45 VM	54	typedef bool (HasUfo)(NetClientState *);
	55	typedef bool (HasVnetHdr)(NetClientState *);
	56	typedef bool (HasVnetHdrLen)(NetClientState *, int);
	57	typedef void (UsingVnetHdr)(NetClientState *, bool);
	58	typedef void (SetOffload)(NetClientState *, int, int, int, int, int);
	59	typedef void (SetVnetHdrLen)(NetClientState *, int);
c80cd6bb GK	60	typedef int (SetVnetLE)(NetClientState *, bool);
c80cd6bb GK	61	typedef int (SetVnetBE)(NetClientState *, bool);
16a3df40 ZC	62	typedef struct SocketReadState SocketReadState;
16a3df40 ZC	63	typedef void (SocketReadStateFinalize)(SocketReadState *rs);
34b25ca7	64
3ed79cc9	65	typedef struct NetClientInfo {
f394b2e2	66	NetClientDriver type;
3ed79cc9 MM	67	size_t size;
	68	NetReceive *receive;
	69	NetReceive *receive_raw;
	70	NetReceiveIOV *receive_iov;
	71	NetCanReceive *can_receive;
	72	NetCleanup *cleanup;
	73	LinkStatusChanged *link_status_changed;
b1be4280	74	QueryRxFilter *query_rx_filter;
ceb69615	75	NetPoll *poll;
1f55ac45 VM	76	HasUfo *has_ufo;
	77	HasVnetHdr *has_vnet_hdr;
	78	HasVnetHdrLen *has_vnet_hdr_len;
	79	UsingVnetHdr *using_vnet_hdr;
	80	SetOffload *set_offload;
	81	SetVnetHdrLen *set_vnet_hdr_len;
c80cd6bb GK	82	SetVnetLE *set_vnet_le;
c80cd6bb GK	83	SetVnetBE *set_vnet_be;
3ed79cc9 MM	84	} NetClientInfo;
3ed79cc9 MM	85
4e68f7a0	86	struct NetClientState {
665a3b07	87	NetClientInfo *info;
436e5e53	88	int link_down;
4e68f7a0 SH	89	QTAILQ_ENTRY(NetClientState) next;
4e68f7a0 SH	90	NetClientState *peer;
067404be	91	NetQueue *incoming_queue;
bf38c1a0	92	char *model;
676cff29	93	char *name;
87ecb68b	94	char info_str[256];
893379ef	95	unsigned receive_disabled : 1;
f7860455	96	NetClientDestructor *destructor;
1ceef9f2	97	unsigned int queue_index;
b1be4280	98	unsigned rxfilter_notify_enabled:1;
bfc6cf31	99	int vring_enable;
d6b732e9	100	int vnet_hdr_len;
25aaadf0	101	QTAILQ_HEAD(NetFilterHead, NetFilterState) filters;
87ecb68b PB	102	};
87ecb68b PB	103
ebef2c09	104	typedef struct NICState {
f6b26cf2	105	NetClientState *ncs;
ebef2c09 MM	106	NICConf *conf;
ebef2c09 MM	107	void *opaque;
a083a89d	108	bool peer_deleted;
ebef2c09 MM	109	} NICState;
ebef2c09 MM	110
16a3df40	111	struct SocketReadState {
3cde5ea2 ZC	112	/* 0 = getting length, 1 = getting vnet header length, 2 = getting data */
	113	int state;
	114	/* This flag decide whether to read the vnet_hdr_len field */
	115	bool vnet_hdr;
16a3df40 ZC	116	uint32_t index;
16a3df40 ZC	117	uint32_t packet_len;
3cde5ea2	118	uint32_t vnet_hdr_len;
16a3df40 ZC	119	uint8_t buf[NET_BUFSIZE];
	120	SocketReadStateFinalize *finalize;
	121	};
	122
	123	int net_fill_rstate(SocketReadState rs, const uint8_t buf, int size);
890ee6ab	124	char qemu_mac_strdup_printf(const uint8_t macaddr);
4e68f7a0	125	NetClientState qemu_find_netdev(const char id);
6c51ae73	126	int qemu_find_net_clients_except(const char id, NetClientState *ncs,
f394b2e2	127	NetClientDriver type, int max);
4e68f7a0 SH	128	NetClientState qemu_new_net_client(NetClientInfo info,
	129	NetClientState *peer,
	130	const char *model,
	131	const char *name);
ebef2c09 MM	132	NICState qemu_new_nic(NetClientInfo info,
	133	NICConf *conf,
	134	const char *model,
	135	const char *name,
	136	void *opaque);
948ecf21	137	void qemu_del_nic(NICState *nic);
1ceef9f2	138	NetClientState qemu_get_subqueue(NICState nic, int queue_index);
b356f76d	139	NetClientState qemu_get_queue(NICState nic);
cc1f0f45 JW	140	NICState qemu_get_nic(NetClientState nc);
cc1f0f45 JW	141	void qemu_get_nic_opaque(NetClientState nc);
b20c6b9e	142	void qemu_del_net_client(NetClientState *nc);
57f9ef17 MM	143	typedef void (qemu_nic_foreach)(NICState nic, void *opaque);
57f9ef17 MM	144	void qemu_foreach_nic(qemu_nic_foreach func, void *opaque);
35277d14 SH	145	int qemu_can_send_packet(NetClientState *nc);
35277d14 SH	146	ssize_t qemu_sendv_packet(NetClientState nc, const struct iovec iov,
fbe78f4f	147	int iovcnt);
35277d14	148	ssize_t qemu_sendv_packet_async(NetClientState nc, const struct iovec iov,
f3b6c7fc	149	int iovcnt, NetPacketSent *sent_cb);
35277d14 SH	150	void qemu_send_packet(NetClientState nc, const uint8_t buf, int size);
	151	ssize_t qemu_send_packet_raw(NetClientState nc, const uint8_t buf, int size);
	152	ssize_t qemu_send_packet_async(NetClientState nc, const uint8_t buf,
f3b6c7fc	153	int size, NetPacketSent *sent_cb);
35277d14 SH	154	void qemu_purge_queued_packets(NetClientState *nc);
	155	void qemu_flush_queued_packets(NetClientState *nc);
	156	void qemu_format_nic_info_str(NetClientState *nc, uint8_t macaddr[6]);
d6085e3a SH	157	bool qemu_has_ufo(NetClientState *nc);
	158	bool qemu_has_vnet_hdr(NetClientState *nc);
	159	bool qemu_has_vnet_hdr_len(NetClientState *nc, int len);
	160	void qemu_using_vnet_hdr(NetClientState *nc, bool enable);
	161	void qemu_set_offload(NetClientState *nc, int csum, int tso4, int tso6,
	162	int ecn, int ufo);
	163	void qemu_set_vnet_hdr_len(NetClientState *nc, int len);
c80cd6bb GK	164	int qemu_set_vnet_le(NetClientState *nc, bool is_le);
c80cd6bb GK	165	int qemu_set_vnet_be(NetClientState *nc, bool is_be);
76d32cba	166	void qemu_macaddr_default_if_unset(MACAddr *macaddr);
07caea31	167	int qemu_show_nic_models(const char arg, const char const *models);
d07f22c5	168	void qemu_check_nic_model(NICInfo nd, const char model);
07caea31 MA	169	int qemu_find_nic_model(NICInfo nd, const char const *models,
07caea31 MA	170	const char *default_model);
87ecb68b	171
86a77c38 ZYW	172	ssize_t qemu_deliver_packet_iov(NetClientState *sender,
	173	unsigned flags,
	174	const struct iovec *iov,
	175	int iovcnt,
	176	void *opaque);
	177
1a859593	178	void print_net_client(Monitor mon, NetClientState nc);
1ce6be24	179	void hmp_info_network(Monitor mon, const QDict qdict);
16a3df40	180	void net_socket_rs_init(SocketReadState *rs,
3cde5ea2 ZC	181	SocketReadStateFinalize *finalize,
3cde5ea2 ZC	182	bool vnet_hdr);
87ecb68b PB	183
	184	/* NIC info */
	185
	186	#define MAX_NICS 8
	187
	188	struct NICInfo {
6eed1856	189	MACAddr macaddr;
9203f520 MM	190	char *model;
	191	char *name;
	192	char *devaddr;
4e68f7a0	193	NetClientState *netdev;
48e2faf2 PM	194	int used; /* is this slot in nd_table[] being used? */
48e2faf2 PM	195	int instantiated; /* does this NICInfo correspond to an instantiated NIC? */
ffe6370c	196	int nvectors;
87ecb68b PB	197	};
	198
	199	extern int nb_nics;
	200	extern NICInfo nd_table[MAX_NICS];
84007e81	201	extern const char *host_net_devices[];
87ecb68b	202
63a01ef8	203	/* from net.c */
ad196a9d JK	204	extern const char *legacy_tftp_prefix;
	205	extern const char *legacy_bootp_filename;
	206
0e55c381	207	int net_client_init(QemuOpts opts, bool is_netdev, Error *errp);
7f161aae	208	int net_client_parse(QemuOptsList opts_list, const char str);
dc1c9fe8	209	int net_init_clients(void);
668680f7	210	void net_check_clients(void);
63a01ef8	211	void net_cleanup(void);
3e5a50d6 MA	212	void hmp_host_net_add(Monitor mon, const QDict qdict);
3e5a50d6 MA	213	void hmp_host_net_remove(Monitor mon, const QDict qdict);
928059a3	214	void netdev_add(QemuOpts opts, Error *errp);
485febc6	215	void qmp_netdev_add(QDict qdict, QObject ret, Error *errp);
63a01ef8	216
1422e32d PB	217	int net_hub_id_for_client(NetClientState nc, int id);
	218	NetClientState *net_hub_port_find(int hub_id);
	219
f54825cc AJ	220	#define DEFAULT_NETWORK_SCRIPT "/etc/qemu-ifup"
f54825cc AJ	221	#define DEFAULT_NETWORK_DOWN_SCRIPT "/etc/qemu-ifdown"
a7c36ee4 CB	222	#define DEFAULT_BRIDGE_HELPER CONFIG_QEMU_HELPERDIR "/qemu-bridge-helper"
a7c36ee4 CB	223	#define DEFAULT_BRIDGE_INTERFACE "br0"
f54825cc	224
ed16ab5a	225	void qdev_set_nic_properties(DeviceState dev, NICInfo nd);
9d07d757	226
eaba8f34	227	#define POLYNOMIAL_BE 0x04c11db6
f1a7deb9	228	#define POLYNOMIAL_LE 0xedb88320
eaba8f34	229	uint32_t net_crc32(const uint8_t *p, int len);
f1a7deb9	230	uint32_t net_crc32_le(const uint8_t *p, int len);
7fc8d918 JW	231	unsigned compute_mcast_idx(const uint8_t *ep);
7fc8d918 JW	232
701a8f76 PB	233	#define vmstate_offset_macaddr(_state, _field) \
	234	vmstate_offset_array(_state, _field.a, uint8_t, \
	235	sizeof(typeof_field(_state, _field)))
	236
	237	#define VMSTATE_MACADDR(_field, _state) { \
	238	.name = (stringify(_field)), \
	239	.size = sizeof(MACAddr), \
	240	.info = &vmstate_info_buffer, \
	241	.flags = VMS_BUFFER, \
	242	.offset = vmstate_offset_macaddr(_state, _field), \
	243	}
	244
87ecb68b	245	#endif