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 bool (GetUsingVnetHdr)(NetClientState *); 61 typedef void (UsingVnetHdr)(NetClientState *, bool); 62 typedef void (SetOffload)(NetClientState *, int, int, int, int, int, int, int); 63 typedef int (GetVnetHdrLen)(NetClientState *); 64 typedef void (SetVnetHdrLen)(NetClientState *, int); 65 typedef int (SetVnetLE)(NetClientState *, bool); 66 typedef int (SetVnetBE)(NetClientState *, bool); 67 typedef struct SocketReadState SocketReadState; 68 typedef void (SocketReadStateFinalize)(SocketReadState *rs); 69 typedef void (NetAnnounce)(NetClientState *); 70 typedef bool (SetSteeringEBPF)(NetClientState *, int); 71 typedef bool (NetCheckPeerType)(NetClientState *, ObjectClass *, Error **); 72 73 typedef struct NetClientInfo { 74 NetClientDriver type; 75 size_t size; 76 NetReceive *receive; 77 NetReceive *receive_raw; 78 NetReceiveIOV *receive_iov; 79 NetCanReceive *can_receive; 80 NetStart *start; 81 NetLoad *load; 82 NetStop *stop; 83 NetCleanup *cleanup; 84 LinkStatusChanged *link_status_changed; 85 QueryRxFilter *query_rx_filter; 86 NetPoll *poll; 87 HasUfo *has_ufo; 88 HasUso *has_uso; 89 HasVnetHdr *has_vnet_hdr; 90 HasVnetHdrLen *has_vnet_hdr_len; 91 GetUsingVnetHdr *get_using_vnet_hdr; 92 UsingVnetHdr *using_vnet_hdr; 93 SetOffload *set_offload; 94 GetVnetHdrLen *get_vnet_hdr_len; 95 SetVnetHdrLen *set_vnet_hdr_len; 96 SetVnetLE *set_vnet_le; 97 SetVnetBE *set_vnet_be; 98 NetAnnounce *announce; 99 SetSteeringEBPF *set_steering_ebpf; 100 NetCheckPeerType *check_peer_type; 101 } NetClientInfo; 102 103 struct NetClientState { 104 NetClientInfo *info; 105 int link_down; 106 QTAILQ_ENTRY(NetClientState) next; 107 NetClientState *peer; 108 NetQueue *incoming_queue; 109 char *model; 110 char *name; 111 char info_str[256]; 112 unsigned receive_disabled : 1; 113 NetClientDestructor *destructor; 114 unsigned int queue_index; 115 unsigned rxfilter_notify_enabled:1; 116 int vring_enable; 117 int vnet_hdr_len; 118 bool is_netdev; 119 bool do_not_pad; /* do not pad to the minimum ethernet frame length */ 120 bool is_datapath; 121 QTAILQ_HEAD(, NetFilterState) filters; 122 }; 123 124 typedef QTAILQ_HEAD(NetClientStateList, NetClientState) NetClientStateList; 125 126 typedef struct NICState { 127 NetClientState *ncs; 128 NICConf *conf; 129 void *opaque; 130 bool peer_deleted; 131 } NICState; 132 133 struct SocketReadState { 134 /* 0 = getting length, 1 = getting vnet header length, 2 = getting data */ 135 int state; 136 /* This flag decide whether to read the vnet_hdr_len field */ 137 bool vnet_hdr; 138 uint32_t index; 139 uint32_t packet_len; 140 uint32_t vnet_hdr_len; 141 uint8_t buf[NET_BUFSIZE]; 142 SocketReadStateFinalize *finalize; 143 }; 144 145 int net_fill_rstate(SocketReadState *rs, const uint8_t *buf, int size); 146 char *qemu_mac_strdup_printf(const uint8_t *macaddr); 147 NetClientState *qemu_find_netdev(const char *id); 148 int qemu_find_net_clients_except(const char *id, NetClientState **ncs, 149 NetClientDriver type, int max); 150 NetClientState *qemu_new_net_client(NetClientInfo *info, 151 NetClientState *peer, 152 const char *model, 153 const char *name); 154 NetClientState *qemu_new_net_control_client(NetClientInfo *info, 155 NetClientState *peer, 156 const char *model, 157 const char *name); 158 NICState *qemu_new_nic(NetClientInfo *info, 159 NICConf *conf, 160 const char *model, 161 const char *name, 162 void *opaque); 163 void qemu_del_nic(NICState *nic); 164 NetClientState *qemu_get_subqueue(NICState *nic, int queue_index); 165 NetClientState *qemu_get_queue(NICState *nic); 166 NICState *qemu_get_nic(NetClientState *nc); 167 void *qemu_get_nic_opaque(NetClientState *nc); 168 void qemu_del_net_client(NetClientState *nc); 169 typedef void (*qemu_nic_foreach)(NICState *nic, void *opaque); 170 void qemu_foreach_nic(qemu_nic_foreach func, void *opaque); 171 int qemu_can_receive_packet(NetClientState *nc); 172 int qemu_can_send_packet(NetClientState *nc); 173 ssize_t qemu_sendv_packet(NetClientState *nc, const struct iovec *iov, 174 int iovcnt); 175 ssize_t qemu_sendv_packet_async(NetClientState *nc, const struct iovec *iov, 176 int iovcnt, NetPacketSent *sent_cb); 177 ssize_t qemu_send_packet(NetClientState *nc, const uint8_t *buf, int size); 178 ssize_t qemu_receive_packet(NetClientState *nc, const uint8_t *buf, int size); 179 ssize_t qemu_receive_packet_iov(NetClientState *nc, 180 const struct iovec *iov, 181 int iovcnt); 182 ssize_t qemu_send_packet_raw(NetClientState *nc, const uint8_t *buf, int size); 183 ssize_t qemu_send_packet_async(NetClientState *nc, const uint8_t *buf, 184 int size, NetPacketSent *sent_cb); 185 void qemu_purge_queued_packets(NetClientState *nc); 186 void qemu_flush_queued_packets(NetClientState *nc); 187 void qemu_flush_or_purge_queued_packets(NetClientState *nc, bool purge); 188 void qemu_set_info_str(NetClientState *nc, 189 const char *fmt, ...) G_GNUC_PRINTF(2, 3); 190 void qemu_format_nic_info_str(NetClientState *nc, uint8_t macaddr[6]); 191 bool qemu_has_ufo(NetClientState *nc); 192 bool qemu_has_uso(NetClientState *nc); 193 bool qemu_has_vnet_hdr(NetClientState *nc); 194 bool qemu_has_vnet_hdr_len(NetClientState *nc, int len); 195 bool qemu_get_using_vnet_hdr(NetClientState *nc); 196 void qemu_using_vnet_hdr(NetClientState *nc, bool enable); 197 void qemu_set_offload(NetClientState *nc, int csum, int tso4, int tso6, 198 int ecn, int ufo, int uso4, int uso6); 199 int qemu_get_vnet_hdr_len(NetClientState *nc); 200 void qemu_set_vnet_hdr_len(NetClientState *nc, int len); 201 int qemu_set_vnet_le(NetClientState *nc, bool is_le); 202 int qemu_set_vnet_be(NetClientState *nc, bool is_be); 203 void qemu_macaddr_default_if_unset(MACAddr *macaddr); 204 int qemu_show_nic_models(const char *arg, const char *const *models); 205 void qemu_check_nic_model(NICInfo *nd, const char *model); 206 int qemu_find_nic_model(NICInfo *nd, const char * const *models, 207 const char *default_model); 208 209 void print_net_client(Monitor *mon, NetClientState *nc); 210 void net_socket_rs_init(SocketReadState *rs, 211 SocketReadStateFinalize *finalize, 212 bool vnet_hdr); 213 NetClientState *qemu_get_peer(NetClientState *nc, int queue_index); 214 215 /** 216 * qemu_get_nic_models: 217 * @device_type: Defines which devices should be taken into consideration 218 * (e.g. TYPE_DEVICE for all devices, or TYPE_PCI_DEVICE for PCI) 219 * 220 * Get an array of pointers to names of NIC devices that are available in 221 * the QEMU binary. The array is terminated with a NULL pointer entry. 222 * The caller is responsible for freeing the memory when it is not required 223 * anymore, e.g. with g_ptr_array_free(..., true). 224 * 225 * Returns: Pointer to the array that contains the pointers to the names. 226 */ 227 GPtrArray *qemu_get_nic_models(const char *device_type); 228 229 /* NIC info */ 230 231 #define MAX_NICS 8 232 233 struct NICInfo { 234 MACAddr macaddr; 235 char *model; 236 char *name; 237 char *devaddr; 238 NetClientState *netdev; 239 int used; /* is this slot in nd_table[] being used? */ 240 int instantiated; /* does this NICInfo correspond to an instantiated NIC? */ 241 int nvectors; 242 }; 243 244 extern int nb_nics; 245 extern NICInfo nd_table[MAX_NICS]; 246 extern const char *host_net_devices[]; 247 248 /* from net.c */ 249 extern NetClientStateList net_clients; 250 bool netdev_is_modern(const char *optarg); 251 void netdev_parse_modern(const char *optarg); 252 void net_client_parse(QemuOptsList *opts_list, const char *str); 253 void show_netdevs(void); 254 void net_init_clients(void); 255 void net_check_clients(void); 256 void net_cleanup(void); 257 void hmp_host_net_add(Monitor *mon, const QDict *qdict); 258 void hmp_host_net_remove(Monitor *mon, const QDict *qdict); 259 void netdev_add(QemuOpts *opts, Error **errp); 260 261 int net_hub_id_for_client(NetClientState *nc, int *id); 262 NetClientState *net_hub_port_find(int hub_id); 263 264 #define DEFAULT_NETWORK_SCRIPT CONFIG_SYSCONFDIR "/qemu-ifup" 265 #define DEFAULT_NETWORK_DOWN_SCRIPT CONFIG_SYSCONFDIR "/qemu-ifdown" 266 #define DEFAULT_BRIDGE_HELPER CONFIG_QEMU_HELPERDIR "/qemu-bridge-helper" 267 #define DEFAULT_BRIDGE_INTERFACE "br0" 268 269 void qdev_set_nic_properties(DeviceState *dev, NICInfo *nd); 270 271 #define POLYNOMIAL_BE 0x04c11db6 272 #define POLYNOMIAL_LE 0xedb88320 273 uint32_t net_crc32(const uint8_t *p, int len); 274 uint32_t net_crc32_le(const uint8_t *p, int len); 275 276 #define vmstate_offset_macaddr(_state, _field) \ 277 vmstate_offset_array(_state, _field.a, uint8_t, \ 278 sizeof(typeof_field(_state, _field))) 279 280 #define VMSTATE_MACADDR(_field, _state) { \ 281 .name = (stringify(_field)), \ 282 .size = sizeof(MACAddr), \ 283 .info = &vmstate_info_buffer, \ 284 .flags = VMS_BUFFER, \ 285 .offset = vmstate_offset_macaddr(_state, _field), \ 286 } 287 288 static inline bool net_peer_needs_padding(NetClientState *nc) 289 { 290 return nc->peer && !nc->peer->do_not_pad; 291 } 292 293 #endif 294