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 "hw/qdev-properties-system.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 bool (NetCanReceive)(NetClientState *);
47typedef int (NetStart)(NetClientState *);
48typedef int (NetLoad)(NetClientState *);
49typedef void (NetStop)(NetClientState *);
50typedef ssize_t (NetReceive)(NetClientState *, const uint8_t *, size_t);
51typedef ssize_t (NetReceiveIOV)(NetClientState *, const struct iovec *, int);
52typedef void (NetCleanup) (NetClientState *);
53typedef void (LinkStatusChanged)(NetClientState *);
54typedef void (NetClientDestructor)(NetClientState *);
55typedef RxFilterInfo *(QueryRxFilter)(NetClientState *);
56typedef bool (HasUfo)(NetClientState *);
57typedef bool (HasVnetHdr)(NetClientState *);
58typedef bool (HasVnetHdrLen)(NetClientState *, int);
59typedef void (UsingVnetHdr)(NetClientState *, bool);
60typedef void (SetOffload)(NetClientState *, int, int, int, int, int);
61typedef void (SetVnetHdrLen)(NetClientState *, int);
62typedef int (SetVnetLE)(NetClientState *, bool);
63typedef int (SetVnetBE)(NetClientState *, bool);
64typedef struct SocketReadState SocketReadState;
65typedef void (SocketReadStateFinalize)(SocketReadState *rs);
66typedef void (NetAnnounce)(NetClientState *);
67typedef bool (SetSteeringEBPF)(NetClientState *, int);
68typedef bool (NetCheckPeerType)(NetClientState *, ObjectClass *, Error **);
69
70typedef struct NetClientInfo {
71 NetClientDriver type;
72 size_t size;
73 NetReceive *receive;
74 NetReceive *receive_raw;
75 NetReceiveIOV *receive_iov;
76 NetCanReceive *can_receive;
77 NetStart *start;
78 NetLoad *load;
79 NetStop *stop;
80 NetCleanup *cleanup;
81 LinkStatusChanged *link_status_changed;
82 QueryRxFilter *query_rx_filter;
83 NetPoll *poll;
84 HasUfo *has_ufo;
85 HasVnetHdr *has_vnet_hdr;
86 HasVnetHdrLen *has_vnet_hdr_len;
87 UsingVnetHdr *using_vnet_hdr;
88 SetOffload *set_offload;
89 SetVnetHdrLen *set_vnet_hdr_len;
90 SetVnetLE *set_vnet_le;
91 SetVnetBE *set_vnet_be;
92 NetAnnounce *announce;
93 SetSteeringEBPF *set_steering_ebpf;
94 NetCheckPeerType *check_peer_type;
95} NetClientInfo;
96
97struct NetClientState {
98 NetClientInfo *info;
99 int link_down;
100 QTAILQ_ENTRY(NetClientState) next;
101 NetClientState *peer;
102 NetQueue *incoming_queue;
103 char *model;
104 char *name;
105 char info_str[256];
106 unsigned receive_disabled : 1;
107 NetClientDestructor *destructor;
108 unsigned int queue_index;
109 unsigned rxfilter_notify_enabled:1;
110 int vring_enable;
111 int vnet_hdr_len;
112 bool is_netdev;
113 bool do_not_pad;
114 bool is_datapath;
115 QTAILQ_HEAD(, NetFilterState) filters;
116};
117
118typedef struct NICState {
119 NetClientState *ncs;
120 NICConf *conf;
121 void *opaque;
122 bool peer_deleted;
123} NICState;
124
125struct SocketReadState {
126
127 int state;
128
129 bool vnet_hdr;
130 uint32_t index;
131 uint32_t packet_len;
132 uint32_t vnet_hdr_len;
133 uint8_t buf[NET_BUFSIZE];
134 SocketReadStateFinalize *finalize;
135};
136
137int net_fill_rstate(SocketReadState *rs, const uint8_t *buf, int size);
138char *qemu_mac_strdup_printf(const uint8_t *macaddr);
139NetClientState *qemu_find_netdev(const char *id);
140int qemu_find_net_clients_except(const char *id, NetClientState **ncs,
141 NetClientDriver type, int max);
142NetClientState *qemu_new_net_client(NetClientInfo *info,
143 NetClientState *peer,
144 const char *model,
145 const char *name);
146NetClientState *qemu_new_net_control_client(NetClientInfo *info,
147 NetClientState *peer,
148 const char *model,
149 const char *name);
150NICState *qemu_new_nic(NetClientInfo *info,
151 NICConf *conf,
152 const char *model,
153 const char *name,
154 void *opaque);
155void qemu_del_nic(NICState *nic);
156NetClientState *qemu_get_subqueue(NICState *nic, int queue_index);
157NetClientState *qemu_get_queue(NICState *nic);
158NICState *qemu_get_nic(NetClientState *nc);
159void *qemu_get_nic_opaque(NetClientState *nc);
160void qemu_del_net_client(NetClientState *nc);
161typedef void (*qemu_nic_foreach)(NICState *nic, void *opaque);
162void qemu_foreach_nic(qemu_nic_foreach func, void *opaque);
163int qemu_can_receive_packet(NetClientState *nc);
164int qemu_can_send_packet(NetClientState *nc);
165ssize_t qemu_sendv_packet(NetClientState *nc, const struct iovec *iov,
166 int iovcnt);
167ssize_t qemu_sendv_packet_async(NetClientState *nc, const struct iovec *iov,
168 int iovcnt, NetPacketSent *sent_cb);
169ssize_t qemu_send_packet(NetClientState *nc, const uint8_t *buf, int size);
170ssize_t qemu_receive_packet(NetClientState *nc, const uint8_t *buf, int size);
171ssize_t qemu_receive_packet_iov(NetClientState *nc,
172 const struct iovec *iov,
173 int iovcnt);
174ssize_t qemu_send_packet_raw(NetClientState *nc, const uint8_t *buf, int size);
175ssize_t qemu_send_packet_async(NetClientState *nc, const uint8_t *buf,
176 int size, NetPacketSent *sent_cb);
177void qemu_purge_queued_packets(NetClientState *nc);
178void qemu_flush_queued_packets(NetClientState *nc);
179void qemu_flush_or_purge_queued_packets(NetClientState *nc, bool purge);
180void qemu_set_info_str(NetClientState *nc,
181 const char *fmt, ...) G_GNUC_PRINTF(2, 3);
182void qemu_format_nic_info_str(NetClientState *nc, uint8_t macaddr[6]);
183bool qemu_has_ufo(NetClientState *nc);
184bool qemu_has_vnet_hdr(NetClientState *nc);
185bool qemu_has_vnet_hdr_len(NetClientState *nc, int len);
186void qemu_using_vnet_hdr(NetClientState *nc, bool enable);
187void qemu_set_offload(NetClientState *nc, int csum, int tso4, int tso6,
188 int ecn, int ufo);
189void qemu_set_vnet_hdr_len(NetClientState *nc, int len);
190int qemu_set_vnet_le(NetClientState *nc, bool is_le);
191int qemu_set_vnet_be(NetClientState *nc, bool is_be);
192void qemu_macaddr_default_if_unset(MACAddr *macaddr);
193int qemu_show_nic_models(const char *arg, const char *const *models);
194void qemu_check_nic_model(NICInfo *nd, const char *model);
195int qemu_find_nic_model(NICInfo *nd, const char * const *models,
196 const char *default_model);
197
198void print_net_client(Monitor *mon, NetClientState *nc);
199void hmp_info_network(Monitor *mon, const QDict *qdict);
200void net_socket_rs_init(SocketReadState *rs,
201 SocketReadStateFinalize *finalize,
202 bool vnet_hdr);
203NetClientState *qemu_get_peer(NetClientState *nc, int queue_index);
204
205
206
207#define MAX_NICS 8
208
209struct NICInfo {
210 MACAddr macaddr;
211 char *model;
212 char *name;
213 char *devaddr;
214 NetClientState *netdev;
215 int used;
216 int instantiated;
217 int nvectors;
218};
219
220extern int nb_nics;
221extern NICInfo nd_table[MAX_NICS];
222extern const char *host_net_devices[];
223
224
225bool netdev_is_modern(const char *optarg);
226void netdev_parse_modern(const char *optarg);
227void net_client_parse(QemuOptsList *opts_list, const char *str);
228void show_netdevs(void);
229void net_init_clients(void);
230void net_check_clients(void);
231void net_cleanup(void);
232void hmp_host_net_add(Monitor *mon, const QDict *qdict);
233void hmp_host_net_remove(Monitor *mon, const QDict *qdict);
234void netdev_add(QemuOpts *opts, Error **errp);
235
236int net_hub_id_for_client(NetClientState *nc, int *id);
237NetClientState *net_hub_port_find(int hub_id);
238
239#define DEFAULT_NETWORK_SCRIPT CONFIG_SYSCONFDIR "/qemu-ifup"
240#define DEFAULT_NETWORK_DOWN_SCRIPT CONFIG_SYSCONFDIR "/qemu-ifdown"
241#define DEFAULT_BRIDGE_HELPER CONFIG_QEMU_HELPERDIR "/qemu-bridge-helper"
242#define DEFAULT_BRIDGE_INTERFACE "br0"
243
244void qdev_set_nic_properties(DeviceState *dev, NICInfo *nd);
245
246#define POLYNOMIAL_BE 0x04c11db6
247#define POLYNOMIAL_LE 0xedb88320
248uint32_t net_crc32(const uint8_t *p, int len);
249uint32_t net_crc32_le(const uint8_t *p, int len);
250
251#define vmstate_offset_macaddr(_state, _field) \
252 vmstate_offset_array(_state, _field.a, uint8_t, \
253 sizeof(typeof_field(_state, _field)))
254
255#define VMSTATE_MACADDR(_field, _state) { \
256 .name = (stringify(_field)), \
257 .size = sizeof(MACAddr), \
258 .info = &vmstate_info_buffer, \
259 .flags = VMS_BUFFER, \
260 .offset = vmstate_offset_macaddr(_state, _field), \
261}
262
263static inline bool net_peer_needs_padding(NetClientState *nc)
264{
265 return nc->peer && !nc->peer->do_not_pad;
266}
267
268#endif
269