xref: /openbmc/qemu/include/net/net.h (revision b9ad513e)
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 /* 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 
21 struct MACAddr {
22     uint8_t a[6];
23 };
24 
25 /* qdev nic properties */
26 
27 typedef struct NICPeers {
28     NetClientState *ncs[MAX_QUEUE_NUM];
29     int32_t queues;
30 } NICPeers;
31 
32 typedef 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 /* Net clients */
44 
45 typedef void (NetPoll)(NetClientState *, bool enable);
46 typedef bool (NetCanReceive)(NetClientState *);
47 typedef int (NetStart)(NetClientState *);
48 typedef int (NetLoad)(NetClientState *);
49 typedef void (NetStop)(NetClientState *);
50 typedef ssize_t (NetReceive)(NetClientState *, const uint8_t *, size_t);
51 typedef ssize_t (NetReceiveIOV)(NetClientState *, const struct iovec *, int);
52 typedef void (NetCleanup) (NetClientState *);
53 typedef void (LinkStatusChanged)(NetClientState *);
54 typedef void (NetClientDestructor)(NetClientState *);
55 typedef RxFilterInfo *(QueryRxFilter)(NetClientState *);
56 typedef bool (HasUfo)(NetClientState *);
57 typedef bool (HasUso)(NetClientState *);
58 typedef bool (HasVnetHdr)(NetClientState *);
59 typedef bool (HasVnetHdrLen)(NetClientState *, int);
60 typedef void (SetOffload)(NetClientState *, int, int, int, int, int, int, int);
61 typedef int (GetVnetHdrLen)(NetClientState *);
62 typedef void (SetVnetHdrLen)(NetClientState *, int);
63 typedef int (SetVnetLE)(NetClientState *, bool);
64 typedef int (SetVnetBE)(NetClientState *, bool);
65 typedef struct SocketReadState SocketReadState;
66 typedef void (SocketReadStateFinalize)(SocketReadState *rs);
67 typedef void (NetAnnounce)(NetClientState *);
68 typedef bool (SetSteeringEBPF)(NetClientState *, int);
69 typedef bool (NetCheckPeerType)(NetClientState *, ObjectClass *, Error **);
70 
71 typedef struct NetClientInfo {
72     NetClientDriver type;
73     size_t size;
74     NetReceive *receive;
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     HasUso *has_uso;
86     HasVnetHdr *has_vnet_hdr;
87     HasVnetHdrLen *has_vnet_hdr_len;
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 
97 struct 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; /* do not pad to the minimum ethernet frame length */
114     bool is_datapath;
115     QTAILQ_HEAD(, NetFilterState) filters;
116 };
117 
118 typedef QTAILQ_HEAD(NetClientStateList, NetClientState) NetClientStateList;
119 
120 typedef struct NICState {
121     NetClientState *ncs;
122     NICConf *conf;
123     MemReentrancyGuard *reentrancy_guard;
124     void *opaque;
125     bool peer_deleted;
126 } NICState;
127 
128 struct SocketReadState {
129     /* 0 = getting length, 1 = getting vnet header length, 2 = getting data */
130     int state;
131     /* This flag decide whether to read the vnet_hdr_len field */
132     bool vnet_hdr;
133     uint32_t index;
134     uint32_t packet_len;
135     uint32_t vnet_hdr_len;
136     uint8_t buf[NET_BUFSIZE];
137     SocketReadStateFinalize *finalize;
138 };
139 
140 int net_fill_rstate(SocketReadState *rs, const uint8_t *buf, int size);
141 char *qemu_mac_strdup_printf(const uint8_t *macaddr);
142 NetClientState *qemu_find_netdev(const char *id);
143 int qemu_find_net_clients_except(const char *id, NetClientState **ncs,
144                                  NetClientDriver type, int max);
145 NetClientState *qemu_new_net_client(NetClientInfo *info,
146                                     NetClientState *peer,
147                                     const char *model,
148                                     const char *name);
149 NetClientState *qemu_new_net_control_client(NetClientInfo *info,
150                                         NetClientState *peer,
151                                         const char *model,
152                                         const char *name);
153 NICState *qemu_new_nic(NetClientInfo *info,
154                        NICConf *conf,
155                        const char *model,
156                        const char *name,
157                        MemReentrancyGuard *reentrancy_guard,
158                        void *opaque);
159 void qemu_del_nic(NICState *nic);
160 NetClientState *qemu_get_subqueue(NICState *nic, int queue_index);
161 NetClientState *qemu_get_queue(NICState *nic);
162 NICState *qemu_get_nic(NetClientState *nc);
163 void *qemu_get_nic_opaque(NetClientState *nc);
164 void qemu_del_net_client(NetClientState *nc);
165 typedef void (*qemu_nic_foreach)(NICState *nic, void *opaque);
166 void qemu_foreach_nic(qemu_nic_foreach func, void *opaque);
167 int qemu_can_receive_packet(NetClientState *nc);
168 int qemu_can_send_packet(NetClientState *nc);
169 ssize_t qemu_sendv_packet(NetClientState *nc, const struct iovec *iov,
170                           int iovcnt);
171 ssize_t qemu_sendv_packet_async(NetClientState *nc, const struct iovec *iov,
172                                 int iovcnt, NetPacketSent *sent_cb);
173 ssize_t qemu_send_packet(NetClientState *nc, const uint8_t *buf, int size);
174 ssize_t qemu_receive_packet(NetClientState *nc, const uint8_t *buf, int size);
175 ssize_t qemu_receive_packet_iov(NetClientState *nc,
176                                 const struct iovec *iov,
177                                 int iovcnt);
178 ssize_t qemu_send_packet_raw(NetClientState *nc, const uint8_t *buf, int size);
179 ssize_t qemu_send_packet_async(NetClientState *nc, const uint8_t *buf,
180                                int size, NetPacketSent *sent_cb);
181 void qemu_purge_queued_packets(NetClientState *nc);
182 void qemu_flush_queued_packets(NetClientState *nc);
183 void qemu_flush_or_purge_queued_packets(NetClientState *nc, bool purge);
184 void qemu_set_info_str(NetClientState *nc,
185                        const char *fmt, ...) G_GNUC_PRINTF(2, 3);
186 void qemu_format_nic_info_str(NetClientState *nc, uint8_t macaddr[6]);
187 bool qemu_has_ufo(NetClientState *nc);
188 bool qemu_has_uso(NetClientState *nc);
189 bool qemu_has_vnet_hdr(NetClientState *nc);
190 bool qemu_has_vnet_hdr_len(NetClientState *nc, int len);
191 void qemu_set_offload(NetClientState *nc, int csum, int tso4, int tso6,
192                       int ecn, int ufo, int uso4, int uso6);
193 int qemu_get_vnet_hdr_len(NetClientState *nc);
194 void qemu_set_vnet_hdr_len(NetClientState *nc, int len);
195 int qemu_set_vnet_le(NetClientState *nc, bool is_le);
196 int qemu_set_vnet_be(NetClientState *nc, bool is_be);
197 void qemu_macaddr_default_if_unset(MACAddr *macaddr);
198 /**
199  * qemu_find_nic_info: Obtain NIC configuration information
200  * @typename: Name of device object type
201  * @match_default: Match NIC configurations with no model specified
202  * @alias: Additional model string to match (for user convenience and
203  *         backward compatibility).
204  *
205  * Search for a NIC configuration matching the NIC model constraints.
206  */
207 NICInfo *qemu_find_nic_info(const char *typename, bool match_default,
208                             const char *alias);
209 /**
210  * qemu_configure_nic_device: Apply NIC configuration to a given device
211  * @dev: Network device to be configured
212  * @match_default: Match NIC configurations with no model specified
213  * @alias: Additional model string to match
214  *
215  * Search for a NIC configuration for the provided device, using the
216  * additionally specified matching constraints. If found, apply the
217  * configuration using qdev_set_nic_properties() and return %true.
218  *
219  * This is used by platform code which creates the device anyway,
220  * regardless of whether there is a configuration for it. This tends
221  * to be platforms which ignore `--nodefaults` and create net devices
222  * anyway, for example because the Ethernet device on that board is
223  * always physically present.
224  */
225 bool qemu_configure_nic_device(DeviceState *dev, bool match_default,
226                                const char *alias);
227 
228 /**
229  * qemu_create_nic_device: Create a NIC device if a configuration exists for it
230  * @typename: Object typename of network device
231  * @match_default: Match NIC configurations with no model specified
232  * @alias: Additional model string to match
233  *
234  * Search for a NIC configuration for the provided device type. If found,
235  * create an object of the corresponding type and return it.
236  */
237 DeviceState *qemu_create_nic_device(const char *typename, bool match_default,
238                                     const char *alias);
239 
240 /*
241  * qemu_create_nic_bus_devices: Create configured NIC devices for a given bus
242  * @bus: Bus on which to create devices
243  * @parent_type: Object type for devices to be created (e.g. TYPE_PCI_DEVICE)
244  * @default_model: Object type name for default NIC model (or %NULL)
245  * @alias: Additional model string to replace, for user convenience
246  * @alias_target: Actual object type name to be used in place of @alias
247  *
248  * Instantiate dynamic NICs on a given bus, typically a PCI bus. This scans
249  * for available NIC configurations which either specify a model which is
250  * a child type of @parent_type, or which do not specify a model when
251  * @default_model is non-NULL. Each device is instantiated on the given @bus.
252  *
253  * A single substitution is supported, e.g. "xen" → "xen-net-device" for the
254  * Xen bus, or "virtio" → "virtio-net-pci" for PCI. This allows the user to
255  * specify a more understandable "model=" parameter on the command line, not
256  * only the real object typename.
257  */
258 void qemu_create_nic_bus_devices(BusState *bus, const char *parent_type,
259                                  const char *default_model,
260                                  const char *alias, const char *alias_target);
261 void print_net_client(Monitor *mon, NetClientState *nc);
262 void net_socket_rs_init(SocketReadState *rs,
263                         SocketReadStateFinalize *finalize,
264                         bool vnet_hdr);
265 NetClientState *qemu_get_peer(NetClientState *nc, int queue_index);
266 
267 /**
268  * qemu_get_nic_models:
269  * @device_type: Defines which devices should be taken into consideration
270  *               (e.g. TYPE_DEVICE for all devices, or TYPE_PCI_DEVICE for PCI)
271  *
272  * Get an array of pointers to names of NIC devices that are available in
273  * the QEMU binary. The array is terminated with a NULL pointer entry.
274  * The caller is responsible for freeing the memory when it is not required
275  * anymore, e.g. with g_ptr_array_free(..., true).
276  *
277  * Returns: Pointer to the array that contains the pointers to the names.
278  */
279 GPtrArray *qemu_get_nic_models(const char *device_type);
280 
281 /* NIC info */
282 
283 #define MAX_NICS 8
284 
285 struct NICInfo {
286     MACAddr macaddr;
287     char *model;
288     char *name;
289     char *devaddr;
290     NetClientState *netdev;
291     int used;         /* is this slot in nd_table[] being used? */
292     int instantiated; /* does this NICInfo correspond to an instantiated NIC? */
293     int nvectors;
294 };
295 
296 /* from net.c */
297 extern NetClientStateList net_clients;
298 bool netdev_is_modern(const char *optstr);
299 void netdev_parse_modern(const char *optstr);
300 void net_client_parse(QemuOptsList *opts_list, const char *optstr);
301 void show_netdevs(void);
302 void net_init_clients(void);
303 void net_check_clients(void);
304 void net_cleanup(void);
305 void hmp_host_net_add(Monitor *mon, const QDict *qdict);
306 void hmp_host_net_remove(Monitor *mon, const QDict *qdict);
307 void netdev_add(QemuOpts *opts, Error **errp);
308 
309 int net_hub_id_for_client(NetClientState *nc, int *id);
310 NetClientState *net_hub_port_find(int hub_id);
311 
312 #define DEFAULT_NETWORK_SCRIPT CONFIG_SYSCONFDIR "/qemu-ifup"
313 #define DEFAULT_NETWORK_DOWN_SCRIPT CONFIG_SYSCONFDIR "/qemu-ifdown"
314 #define DEFAULT_BRIDGE_HELPER CONFIG_QEMU_HELPERDIR "/qemu-bridge-helper"
315 #define DEFAULT_BRIDGE_INTERFACE "br0"
316 
317 void qdev_set_nic_properties(DeviceState *dev, NICInfo *nd);
318 
319 #define POLYNOMIAL_BE 0x04c11db6
320 #define POLYNOMIAL_LE 0xedb88320
321 uint32_t net_crc32(const uint8_t *p, int len);
322 uint32_t net_crc32_le(const uint8_t *p, int len);
323 
324 #define vmstate_offset_macaddr(_state, _field)                       \
325     vmstate_offset_array(_state, _field.a, uint8_t,                \
326                          sizeof(typeof_field(_state, _field)))
327 
328 #define VMSTATE_MACADDR(_field, _state) {                            \
329     .name       = (stringify(_field)),                               \
330     .size       = sizeof(MACAddr),                                   \
331     .info       = &vmstate_info_buffer,                              \
332     .flags      = VMS_BUFFER,                                        \
333     .offset     = vmstate_offset_macaddr(_state, _field),            \
334 }
335 
net_peer_needs_padding(NetClientState * nc)336 static inline bool net_peer_needs_padding(NetClientState *nc)
337 {
338   return nc->peer && !nc->peer->do_not_pad;
339 }
340 
341 #endif
342