xref: /openbmc/qemu/include/net/net.h (revision df22fbb7)
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 (HasVnetHdr)(NetClientState *);
58 typedef bool (HasVnetHdrLen)(NetClientState *, int);
59 typedef void (UsingVnetHdr)(NetClientState *, bool);
60 typedef void (SetOffload)(NetClientState *, int, int, int, int, int);
61 typedef void (SetVnetHdrLen)(NetClientState *, int);
62 typedef int (SetVnetLE)(NetClientState *, bool);
63 typedef int (SetVnetBE)(NetClientState *, bool);
64 typedef struct SocketReadState SocketReadState;
65 typedef void (SocketReadStateFinalize)(SocketReadState *rs);
66 typedef void (NetAnnounce)(NetClientState *);
67 typedef bool (SetSteeringEBPF)(NetClientState *, int);
68 typedef bool (NetCheckPeerType)(NetClientState *, ObjectClass *, Error **);
69 
70 typedef 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 
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 struct NICState {
119     NetClientState *ncs;
120     NICConf *conf;
121     void *opaque;
122     bool peer_deleted;
123 } NICState;
124 
125 struct SocketReadState {
126     /* 0 = getting length, 1 = getting vnet header length, 2 = getting data */
127     int state;
128     /* This flag decide whether to read the vnet_hdr_len field */
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 
137 int net_fill_rstate(SocketReadState *rs, const uint8_t *buf, int size);
138 char *qemu_mac_strdup_printf(const uint8_t *macaddr);
139 NetClientState *qemu_find_netdev(const char *id);
140 int qemu_find_net_clients_except(const char *id, NetClientState **ncs,
141                                  NetClientDriver type, int max);
142 NetClientState *qemu_new_net_client(NetClientInfo *info,
143                                     NetClientState *peer,
144                                     const char *model,
145                                     const char *name);
146 NetClientState *qemu_new_net_control_client(NetClientInfo *info,
147                                         NetClientState *peer,
148                                         const char *model,
149                                         const char *name);
150 NICState *qemu_new_nic(NetClientInfo *info,
151                        NICConf *conf,
152                        const char *model,
153                        const char *name,
154                        void *opaque);
155 void qemu_del_nic(NICState *nic);
156 NetClientState *qemu_get_subqueue(NICState *nic, int queue_index);
157 NetClientState *qemu_get_queue(NICState *nic);
158 NICState *qemu_get_nic(NetClientState *nc);
159 void *qemu_get_nic_opaque(NetClientState *nc);
160 void qemu_del_net_client(NetClientState *nc);
161 typedef void (*qemu_nic_foreach)(NICState *nic, void *opaque);
162 void qemu_foreach_nic(qemu_nic_foreach func, void *opaque);
163 int qemu_can_receive_packet(NetClientState *nc);
164 int qemu_can_send_packet(NetClientState *nc);
165 ssize_t qemu_sendv_packet(NetClientState *nc, const struct iovec *iov,
166                           int iovcnt);
167 ssize_t qemu_sendv_packet_async(NetClientState *nc, const struct iovec *iov,
168                                 int iovcnt, NetPacketSent *sent_cb);
169 ssize_t qemu_send_packet(NetClientState *nc, const uint8_t *buf, int size);
170 ssize_t qemu_receive_packet(NetClientState *nc, const uint8_t *buf, int size);
171 ssize_t qemu_receive_packet_iov(NetClientState *nc,
172                                 const struct iovec *iov,
173                                 int iovcnt);
174 ssize_t qemu_send_packet_raw(NetClientState *nc, const uint8_t *buf, int size);
175 ssize_t qemu_send_packet_async(NetClientState *nc, const uint8_t *buf,
176                                int size, NetPacketSent *sent_cb);
177 void qemu_purge_queued_packets(NetClientState *nc);
178 void qemu_flush_queued_packets(NetClientState *nc);
179 void qemu_flush_or_purge_queued_packets(NetClientState *nc, bool purge);
180 void qemu_format_nic_info_str(NetClientState *nc, uint8_t macaddr[6]);
181 bool qemu_has_ufo(NetClientState *nc);
182 bool qemu_has_vnet_hdr(NetClientState *nc);
183 bool qemu_has_vnet_hdr_len(NetClientState *nc, int len);
184 void qemu_using_vnet_hdr(NetClientState *nc, bool enable);
185 void qemu_set_offload(NetClientState *nc, int csum, int tso4, int tso6,
186                       int ecn, int ufo);
187 void qemu_set_vnet_hdr_len(NetClientState *nc, int len);
188 int qemu_set_vnet_le(NetClientState *nc, bool is_le);
189 int qemu_set_vnet_be(NetClientState *nc, bool is_be);
190 void qemu_macaddr_default_if_unset(MACAddr *macaddr);
191 int qemu_show_nic_models(const char *arg, const char *const *models);
192 void qemu_check_nic_model(NICInfo *nd, const char *model);
193 int qemu_find_nic_model(NICInfo *nd, const char * const *models,
194                         const char *default_model);
195 
196 void print_net_client(Monitor *mon, NetClientState *nc);
197 void hmp_info_network(Monitor *mon, const QDict *qdict);
198 void net_socket_rs_init(SocketReadState *rs,
199                         SocketReadStateFinalize *finalize,
200                         bool vnet_hdr);
201 NetClientState *qemu_get_peer(NetClientState *nc, int queue_index);
202 
203 /* NIC info */
204 
205 #define MAX_NICS 8
206 
207 struct NICInfo {
208     MACAddr macaddr;
209     char *model;
210     char *name;
211     char *devaddr;
212     NetClientState *netdev;
213     int used;         /* is this slot in nd_table[] being used? */
214     int instantiated; /* does this NICInfo correspond to an instantiated NIC? */
215     int nvectors;
216 };
217 
218 extern int nb_nics;
219 extern NICInfo nd_table[MAX_NICS];
220 extern const char *host_net_devices[];
221 
222 /* from net.c */
223 int net_client_parse(QemuOptsList *opts_list, const char *str);
224 void show_netdevs(void);
225 int net_init_clients(Error **errp);
226 void net_check_clients(void);
227 void net_cleanup(void);
228 void hmp_host_net_add(Monitor *mon, const QDict *qdict);
229 void hmp_host_net_remove(Monitor *mon, const QDict *qdict);
230 void netdev_add(QemuOpts *opts, Error **errp);
231 
232 int net_hub_id_for_client(NetClientState *nc, int *id);
233 NetClientState *net_hub_port_find(int hub_id);
234 
235 #define DEFAULT_NETWORK_SCRIPT CONFIG_SYSCONFDIR "/qemu-ifup"
236 #define DEFAULT_NETWORK_DOWN_SCRIPT CONFIG_SYSCONFDIR "/qemu-ifdown"
237 #define DEFAULT_BRIDGE_HELPER CONFIG_QEMU_HELPERDIR "/qemu-bridge-helper"
238 #define DEFAULT_BRIDGE_INTERFACE "br0"
239 
240 void qdev_set_nic_properties(DeviceState *dev, NICInfo *nd);
241 
242 #define POLYNOMIAL_BE 0x04c11db6
243 #define POLYNOMIAL_LE 0xedb88320
244 uint32_t net_crc32(const uint8_t *p, int len);
245 uint32_t net_crc32_le(const uint8_t *p, int len);
246 
247 #define vmstate_offset_macaddr(_state, _field)                       \
248     vmstate_offset_array(_state, _field.a, uint8_t,                \
249                          sizeof(typeof_field(_state, _field)))
250 
251 #define VMSTATE_MACADDR(_field, _state) {                            \
252     .name       = (stringify(_field)),                               \
253     .size       = sizeof(MACAddr),                                   \
254     .info       = &vmstate_info_buffer,                              \
255     .flags      = VMS_BUFFER,                                        \
256     .offset     = vmstate_offset_macaddr(_state, _field),            \
257 }
258 
259 static inline bool net_peer_needs_padding(NetClientState *nc)
260 {
261   return nc->peer && !nc->peer->do_not_pad;
262 }
263 
264 #endif
265