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