1#ifndef QEMU_NET_H
2#define QEMU_NET_H
3
4#include "qemu/queue.h"
5#include "qapi/qapi-types-net.h"
6#include "net/queue.h"
7#include "migration/vmstate.h"
8
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
14#define MAX_QUEUE_NUM 1024
15
16
17
18
19#define NET_BUFSIZE (4096 + 65536)
20
21struct MACAddr {
22 uint8_t a[6];
23};
24
25
26
27typedef struct NICPeers {
28 NetClientState *ncs[MAX_QUEUE_NUM];
29 int32_t queues;
30} NICPeers;
31
32typedef struct NICConf {
33 MACAddr macaddr;
34 NICPeers peers;
35 int32_t bootindex;
36} NICConf;
37
38#define DEFINE_NIC_PROPERTIES(_state, _conf) \
39 DEFINE_PROP_MACADDR("mac", _state, _conf.macaddr), \
40 DEFINE_PROP_NETDEV("netdev", _state, _conf.peers)
41
42
43
44
45typedef void (NetPoll)(NetClientState *, bool enable);
46typedef int (NetCanReceive)(NetClientState *);
47typedef ssize_t (NetReceive)(NetClientState *, const uint8_t *, size_t);
48typedef ssize_t (NetReceiveIOV)(NetClientState *, const struct iovec *, int);
49typedef void (NetCleanup) (NetClientState *);
50typedef void (LinkStatusChanged)(NetClientState *);
51typedef void (NetClientDestructor)(NetClientState *);
52typedef RxFilterInfo *(QueryRxFilter)(NetClientState *);
53typedef bool (HasUfo)(NetClientState *);
54typedef bool (HasVnetHdr)(NetClientState *);
55typedef bool (HasVnetHdrLen)(NetClientState *, int);
56typedef void (UsingVnetHdr)(NetClientState *, bool);
57typedef void (SetOffload)(NetClientState *, int, int, int, int, int);
58typedef void (SetVnetHdrLen)(NetClientState *, int);
59typedef int (SetVnetLE)(NetClientState *, bool);
60typedef int (SetVnetBE)(NetClientState *, bool);
61typedef struct SocketReadState SocketReadState;
62typedef void (SocketReadStateFinalize)(SocketReadState *rs);
63typedef void (NetAnnounce)(NetClientState *);
64
65typedef struct NetClientInfo {
66 NetClientDriver type;
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;
74 QueryRxFilter *query_rx_filter;
75 NetPoll *poll;
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;
82 SetVnetLE *set_vnet_le;
83 SetVnetBE *set_vnet_be;
84 NetAnnounce *announce;
85} NetClientInfo;
86
87struct NetClientState {
88 NetClientInfo *info;
89 int link_down;
90 QTAILQ_ENTRY(NetClientState) next;
91 NetClientState *peer;
92 NetQueue *incoming_queue;
93 char *model;
94 char *name;
95 char info_str[256];
96 unsigned receive_disabled : 1;
97 NetClientDestructor *destructor;
98 unsigned int queue_index;
99 unsigned rxfilter_notify_enabled:1;
100 int vring_enable;
101 int vnet_hdr_len;
102 QTAILQ_HEAD(, NetFilterState) filters;
103};
104
105typedef struct NICState {
106 NetClientState *ncs;
107 NICConf *conf;
108 void *opaque;
109 bool peer_deleted;
110} NICState;
111
112struct SocketReadState {
113
114 int state;
115
116 bool vnet_hdr;
117 uint32_t index;
118 uint32_t packet_len;
119 uint32_t vnet_hdr_len;
120 uint8_t buf[NET_BUFSIZE];
121 SocketReadStateFinalize *finalize;
122};
123
124int net_fill_rstate(SocketReadState *rs, const uint8_t *buf, int size);
125char *qemu_mac_strdup_printf(const uint8_t *macaddr);
126NetClientState *qemu_find_netdev(const char *id);
127int qemu_find_net_clients_except(const char *id, NetClientState **ncs,
128 NetClientDriver type, int max);
129NetClientState *qemu_new_net_client(NetClientInfo *info,
130 NetClientState *peer,
131 const char *model,
132 const char *name);
133NICState *qemu_new_nic(NetClientInfo *info,
134 NICConf *conf,
135 const char *model,
136 const char *name,
137 void *opaque);
138void qemu_del_nic(NICState *nic);
139NetClientState *qemu_get_subqueue(NICState *nic, int queue_index);
140NetClientState *qemu_get_queue(NICState *nic);
141NICState *qemu_get_nic(NetClientState *nc);
142void *qemu_get_nic_opaque(NetClientState *nc);
143void qemu_del_net_client(NetClientState *nc);
144typedef void (*qemu_nic_foreach)(NICState *nic, void *opaque);
145void qemu_foreach_nic(qemu_nic_foreach func, void *opaque);
146int qemu_can_send_packet(NetClientState *nc);
147ssize_t qemu_sendv_packet(NetClientState *nc, const struct iovec *iov,
148 int iovcnt);
149ssize_t qemu_sendv_packet_async(NetClientState *nc, const struct iovec *iov,
150 int iovcnt, NetPacketSent *sent_cb);
151ssize_t qemu_send_packet(NetClientState *nc, const uint8_t *buf, int size);
152ssize_t qemu_send_packet_raw(NetClientState *nc, const uint8_t *buf, int size);
153ssize_t qemu_send_packet_async(NetClientState *nc, const uint8_t *buf,
154 int size, NetPacketSent *sent_cb);
155void qemu_purge_queued_packets(NetClientState *nc);
156void qemu_flush_queued_packets(NetClientState *nc);
157void qemu_flush_or_purge_queued_packets(NetClientState *nc, bool purge);
158void qemu_format_nic_info_str(NetClientState *nc, uint8_t macaddr[6]);
159bool qemu_has_ufo(NetClientState *nc);
160bool qemu_has_vnet_hdr(NetClientState *nc);
161bool qemu_has_vnet_hdr_len(NetClientState *nc, int len);
162void qemu_using_vnet_hdr(NetClientState *nc, bool enable);
163void qemu_set_offload(NetClientState *nc, int csum, int tso4, int tso6,
164 int ecn, int ufo);
165void qemu_set_vnet_hdr_len(NetClientState *nc, int len);
166int qemu_set_vnet_le(NetClientState *nc, bool is_le);
167int qemu_set_vnet_be(NetClientState *nc, bool is_be);
168void qemu_macaddr_default_if_unset(MACAddr *macaddr);
169int qemu_show_nic_models(const char *arg, const char *const *models);
170void qemu_check_nic_model(NICInfo *nd, const char *model);
171int qemu_find_nic_model(NICInfo *nd, const char * const *models,
172 const char *default_model);
173
174void print_net_client(Monitor *mon, NetClientState *nc);
175void hmp_info_network(Monitor *mon, const QDict *qdict);
176void net_socket_rs_init(SocketReadState *rs,
177 SocketReadStateFinalize *finalize,
178 bool vnet_hdr);
179
180
181
182#define MAX_NICS 8
183
184struct NICInfo {
185 MACAddr macaddr;
186 char *model;
187 char *name;
188 char *devaddr;
189 NetClientState *netdev;
190 int used;
191 int instantiated;
192 int nvectors;
193};
194
195extern int nb_nics;
196extern NICInfo nd_table[MAX_NICS];
197extern const char *host_net_devices[];
198
199
200int net_client_parse(QemuOptsList *opts_list, const char *str);
201int net_init_clients(Error **errp);
202void net_check_clients(void);
203void net_cleanup(void);
204void hmp_host_net_add(Monitor *mon, const QDict *qdict);
205void hmp_host_net_remove(Monitor *mon, const QDict *qdict);
206void netdev_add(QemuOpts *opts, Error **errp);
207void qmp_netdev_add(QDict *qdict, QObject **ret, Error **errp);
208
209int net_hub_id_for_client(NetClientState *nc, int *id);
210NetClientState *net_hub_port_find(int hub_id);
211
212#define DEFAULT_NETWORK_SCRIPT "/etc/qemu-ifup"
213#define DEFAULT_NETWORK_DOWN_SCRIPT "/etc/qemu-ifdown"
214#define DEFAULT_BRIDGE_HELPER CONFIG_QEMU_HELPERDIR "/qemu-bridge-helper"
215#define DEFAULT_BRIDGE_INTERFACE "br0"
216
217void qdev_set_nic_properties(DeviceState *dev, NICInfo *nd);
218
219#define POLYNOMIAL_BE 0x04c11db6
220#define POLYNOMIAL_LE 0xedb88320
221uint32_t net_crc32(const uint8_t *p, int len);
222uint32_t net_crc32_le(const uint8_t *p, int len);
223
224#define vmstate_offset_macaddr(_state, _field) \
225 vmstate_offset_array(_state, _field.a, uint8_t, \
226 sizeof(typeof_field(_state, _field)))
227
228#define VMSTATE_MACADDR(_field, _state) { \
229 .name = (stringify(_field)), \
230 .size = sizeof(MACAddr), \
231 .info = &vmstate_info_buffer, \
232 .flags = VMS_BUFFER, \
233 .offset = vmstate_offset_macaddr(_state, _field), \
234}
235
236#endif
237