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