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 QTAILQ_HEAD(NetClientStateList, NetClientState) NetClientStateList; 119 120 typedef struct NICState { 121 NetClientState *ncs; 122 NICConf *conf; 123 void *opaque; 124 bool peer_deleted; 125 } NICState; 126 127 struct SocketReadState { 128 /* 0 = getting length, 1 = getting vnet header length, 2 = getting data */ 129 int state; 130 /* This flag decide whether to read the vnet_hdr_len field */ 131 bool vnet_hdr; 132 uint32_t index; 133 uint32_t packet_len; 134 uint32_t vnet_hdr_len; 135 uint8_t buf[NET_BUFSIZE]; 136 SocketReadStateFinalize *finalize; 137 }; 138 139 int net_fill_rstate(SocketReadState *rs, const uint8_t *buf, int size); 140 char *qemu_mac_strdup_printf(const uint8_t *macaddr); 141 NetClientState *qemu_find_netdev(const char *id); 142 int qemu_find_net_clients_except(const char *id, NetClientState **ncs, 143 NetClientDriver type, int max); 144 NetClientState *qemu_new_net_client(NetClientInfo *info, 145 NetClientState *peer, 146 const char *model, 147 const char *name); 148 NetClientState *qemu_new_net_control_client(NetClientInfo *info, 149 NetClientState *peer, 150 const char *model, 151 const char *name); 152 NICState *qemu_new_nic(NetClientInfo *info, 153 NICConf *conf, 154 const char *model, 155 const char *name, 156 void *opaque); 157 void qemu_del_nic(NICState *nic); 158 NetClientState *qemu_get_subqueue(NICState *nic, int queue_index); 159 NetClientState *qemu_get_queue(NICState *nic); 160 NICState *qemu_get_nic(NetClientState *nc); 161 void *qemu_get_nic_opaque(NetClientState *nc); 162 void qemu_del_net_client(NetClientState *nc); 163 typedef void (*qemu_nic_foreach)(NICState *nic, void *opaque); 164 void qemu_foreach_nic(qemu_nic_foreach func, void *opaque); 165 int qemu_can_receive_packet(NetClientState *nc); 166 int qemu_can_send_packet(NetClientState *nc); 167 ssize_t qemu_sendv_packet(NetClientState *nc, const struct iovec *iov, 168 int iovcnt); 169 ssize_t qemu_sendv_packet_async(NetClientState *nc, const struct iovec *iov, 170 int iovcnt, NetPacketSent *sent_cb); 171 ssize_t qemu_send_packet(NetClientState *nc, const uint8_t *buf, int size); 172 ssize_t qemu_receive_packet(NetClientState *nc, const uint8_t *buf, int size); 173 ssize_t qemu_receive_packet_iov(NetClientState *nc, 174 const struct iovec *iov, 175 int iovcnt); 176 ssize_t qemu_send_packet_raw(NetClientState *nc, const uint8_t *buf, int size); 177 ssize_t qemu_send_packet_async(NetClientState *nc, const uint8_t *buf, 178 int size, NetPacketSent *sent_cb); 179 void qemu_purge_queued_packets(NetClientState *nc); 180 void qemu_flush_queued_packets(NetClientState *nc); 181 void qemu_flush_or_purge_queued_packets(NetClientState *nc, bool purge); 182 void qemu_set_info_str(NetClientState *nc, 183 const char *fmt, ...) G_GNUC_PRINTF(2, 3); 184 void qemu_format_nic_info_str(NetClientState *nc, uint8_t macaddr[6]); 185 bool qemu_has_ufo(NetClientState *nc); 186 bool qemu_has_vnet_hdr(NetClientState *nc); 187 bool qemu_has_vnet_hdr_len(NetClientState *nc, int len); 188 void qemu_using_vnet_hdr(NetClientState *nc, bool enable); 189 void qemu_set_offload(NetClientState *nc, int csum, int tso4, int tso6, 190 int ecn, int ufo); 191 void qemu_set_vnet_hdr_len(NetClientState *nc, int len); 192 int qemu_set_vnet_le(NetClientState *nc, bool is_le); 193 int qemu_set_vnet_be(NetClientState *nc, bool is_be); 194 void qemu_macaddr_default_if_unset(MACAddr *macaddr); 195 int qemu_show_nic_models(const char *arg, const char *const *models); 196 void qemu_check_nic_model(NICInfo *nd, const char *model); 197 int qemu_find_nic_model(NICInfo *nd, const char * const *models, 198 const char *default_model); 199 200 void print_net_client(Monitor *mon, NetClientState *nc); 201 void net_socket_rs_init(SocketReadState *rs, 202 SocketReadStateFinalize *finalize, 203 bool vnet_hdr); 204 NetClientState *qemu_get_peer(NetClientState *nc, int queue_index); 205 206 /** 207 * qemu_get_nic_models: 208 * @device_type: Defines which devices should be taken into consideration 209 * (e.g. TYPE_DEVICE for all devices, or TYPE_PCI_DEVICE for PCI) 210 * 211 * Get an array of pointers to names of NIC devices that are available in 212 * the QEMU binary. The array is terminated with a NULL pointer entry. 213 * The caller is responsible for freeing the memory when it is not required 214 * anymore, e.g. with g_ptr_array_free(..., true). 215 * 216 * Returns: Pointer to the array that contains the pointers to the names. 217 */ 218 GPtrArray *qemu_get_nic_models(const char *device_type); 219 220 /* NIC info */ 221 222 #define MAX_NICS 8 223 224 struct NICInfo { 225 MACAddr macaddr; 226 char *model; 227 char *name; 228 char *devaddr; 229 NetClientState *netdev; 230 int used; /* is this slot in nd_table[] being used? */ 231 int instantiated; /* does this NICInfo correspond to an instantiated NIC? */ 232 int nvectors; 233 }; 234 235 extern int nb_nics; 236 extern NICInfo nd_table[MAX_NICS]; 237 extern const char *host_net_devices[]; 238 239 /* from net.c */ 240 extern NetClientStateList net_clients; 241 bool netdev_is_modern(const char *optarg); 242 void netdev_parse_modern(const char *optarg); 243 void net_client_parse(QemuOptsList *opts_list, const char *str); 244 void show_netdevs(void); 245 void net_init_clients(void); 246 void net_check_clients(void); 247 void net_cleanup(void); 248 void hmp_host_net_add(Monitor *mon, const QDict *qdict); 249 void hmp_host_net_remove(Monitor *mon, const QDict *qdict); 250 void netdev_add(QemuOpts *opts, Error **errp); 251 252 int net_hub_id_for_client(NetClientState *nc, int *id); 253 NetClientState *net_hub_port_find(int hub_id); 254 255 #define DEFAULT_NETWORK_SCRIPT CONFIG_SYSCONFDIR "/qemu-ifup" 256 #define DEFAULT_NETWORK_DOWN_SCRIPT CONFIG_SYSCONFDIR "/qemu-ifdown" 257 #define DEFAULT_BRIDGE_HELPER CONFIG_QEMU_HELPERDIR "/qemu-bridge-helper" 258 #define DEFAULT_BRIDGE_INTERFACE "br0" 259 260 void qdev_set_nic_properties(DeviceState *dev, NICInfo *nd); 261 262 #define POLYNOMIAL_BE 0x04c11db6 263 #define POLYNOMIAL_LE 0xedb88320 264 uint32_t net_crc32(const uint8_t *p, int len); 265 uint32_t net_crc32_le(const uint8_t *p, int len); 266 267 #define vmstate_offset_macaddr(_state, _field) \ 268 vmstate_offset_array(_state, _field.a, uint8_t, \ 269 sizeof(typeof_field(_state, _field))) 270 271 #define VMSTATE_MACADDR(_field, _state) { \ 272 .name = (stringify(_field)), \ 273 .size = sizeof(MACAddr), \ 274 .info = &vmstate_info_buffer, \ 275 .flags = VMS_BUFFER, \ 276 .offset = vmstate_offset_macaddr(_state, _field), \ 277 } 278 279 static inline bool net_peer_needs_padding(NetClientState *nc) 280 { 281 return nc->peer && !nc->peer->do_not_pad; 282 } 283 284 #endif 285