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 bool (GetVnetHashSupportedTypes)(NetClientState *, uint32_t *); 64 typedef int (SetVnetLE)(NetClientState *, bool); 65 typedef int (SetVnetBE)(NetClientState *, bool); 66 typedef struct SocketReadState SocketReadState; 67 typedef void (SocketReadStateFinalize)(SocketReadState *rs); 68 typedef void (NetAnnounce)(NetClientState *); 69 typedef bool (SetSteeringEBPF)(NetClientState *, int); 70 typedef bool (NetCheckPeerType)(NetClientState *, ObjectClass *, Error **); 71 typedef struct vhost_net *(GetVHostNet)(NetClientState *nc); 72 73 typedef struct NetClientInfo { 74 NetClientDriver type; 75 size_t size; 76 NetReceive *receive; 77 NetReceiveIOV *receive_iov; 78 NetCanReceive *can_receive; 79 NetStart *start; 80 NetLoad *load; 81 NetStop *stop; 82 NetCleanup *cleanup; 83 LinkStatusChanged *link_status_changed; 84 QueryRxFilter *query_rx_filter; 85 NetPoll *poll; 86 HasUfo *has_ufo; 87 HasUso *has_uso; 88 HasVnetHdr *has_vnet_hdr; 89 HasVnetHdrLen *has_vnet_hdr_len; 90 SetOffload *set_offload; 91 SetVnetHdrLen *set_vnet_hdr_len; 92 SetVnetLE *set_vnet_le; 93 SetVnetBE *set_vnet_be; 94 GetVnetHashSupportedTypes *get_vnet_hash_supported_types; 95 NetAnnounce *announce; 96 SetSteeringEBPF *set_steering_ebpf; 97 NetCheckPeerType *check_peer_type; 98 GetVHostNet *get_vhost_net; 99 } NetClientInfo; 100 101 struct NetClientState { 102 NetClientInfo *info; 103 int link_down; 104 QTAILQ_ENTRY(NetClientState) next; 105 NetClientState *peer; 106 NetQueue *incoming_queue; 107 char *model; 108 char *name; 109 char info_str[256]; 110 unsigned receive_disabled : 1; 111 NetClientDestructor *destructor; 112 unsigned int queue_index; 113 unsigned rxfilter_notify_enabled:1; 114 int vring_enable; 115 int vnet_hdr_len; 116 bool is_netdev; 117 bool do_not_pad; /* do not pad to the minimum ethernet frame length */ 118 bool is_datapath; 119 QTAILQ_HEAD(, NetFilterState) filters; 120 }; 121 122 typedef QTAILQ_HEAD(NetClientStateList, NetClientState) NetClientStateList; 123 124 typedef struct NICState { 125 NetClientState *ncs; 126 NICConf *conf; 127 MemReentrancyGuard *reentrancy_guard; 128 void *opaque; 129 bool peer_deleted; 130 } NICState; 131 132 struct SocketReadState { 133 /* 0 = getting length, 1 = getting vnet header length, 2 = getting data */ 134 int state; 135 /* This flag decide whether to read the vnet_hdr_len field */ 136 bool vnet_hdr; 137 uint32_t index; 138 uint32_t packet_len; 139 uint32_t vnet_hdr_len; 140 uint8_t buf[NET_BUFSIZE]; 141 SocketReadStateFinalize *finalize; 142 }; 143 144 int net_fill_rstate(SocketReadState *rs, const uint8_t *buf, int size); 145 char *qemu_mac_strdup_printf(const uint8_t *macaddr); 146 NetClientState *qemu_find_netdev(const char *id); 147 int qemu_find_net_clients_except(const char *id, NetClientState **ncs, 148 NetClientDriver type, int max); 149 NetClientState *qemu_new_net_client(NetClientInfo *info, 150 NetClientState *peer, 151 const char *model, 152 const char *name); 153 NetClientState *qemu_new_net_control_client(NetClientInfo *info, 154 NetClientState *peer, 155 const char *model, 156 const char *name); 157 NICState *qemu_new_nic(NetClientInfo *info, 158 NICConf *conf, 159 const char *model, 160 const char *name, 161 MemReentrancyGuard *reentrancy_guard, 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_send_packet_raw(NetClientState *nc, const uint8_t *buf, int size); 180 ssize_t qemu_send_packet_async(NetClientState *nc, const uint8_t *buf, 181 int size, NetPacketSent *sent_cb); 182 void qemu_purge_queued_packets(NetClientState *nc); 183 void qemu_flush_queued_packets(NetClientState *nc); 184 void qemu_flush_or_purge_queued_packets(NetClientState *nc, bool purge); 185 void qemu_set_info_str(NetClientState *nc, 186 const char *fmt, ...) G_GNUC_PRINTF(2, 3); 187 void qemu_format_nic_info_str(NetClientState *nc, uint8_t macaddr[6]); 188 bool qemu_has_ufo(NetClientState *nc); 189 bool qemu_has_uso(NetClientState *nc); 190 bool qemu_has_vnet_hdr(NetClientState *nc); 191 bool qemu_has_vnet_hdr_len(NetClientState *nc, int len); 192 void qemu_set_offload(NetClientState *nc, int csum, int tso4, int tso6, 193 int ecn, int ufo, int uso4, int uso6); 194 int qemu_get_vnet_hdr_len(NetClientState *nc); 195 void qemu_set_vnet_hdr_len(NetClientState *nc, int len); 196 bool qemu_get_vnet_hash_supported_types(NetClientState *nc, uint32_t *types); 197 int qemu_set_vnet_le(NetClientState *nc, bool is_le); 198 int qemu_set_vnet_be(NetClientState *nc, bool is_be); 199 void qemu_macaddr_default_if_unset(MACAddr *macaddr); 200 /** 201 * qemu_find_nic_info: Obtain NIC configuration information 202 * @typename: Name of device object type 203 * @match_default: Match NIC configurations with no model specified 204 * @alias: Additional model string to match (for user convenience and 205 * backward compatibility). 206 * 207 * Search for a NIC configuration matching the NIC model constraints. 208 */ 209 NICInfo *qemu_find_nic_info(const char *typename, bool match_default, 210 const char *alias); 211 /** 212 * qemu_configure_nic_device: Apply NIC configuration to a given device 213 * @dev: Network device to be configured 214 * @match_default: Match NIC configurations with no model specified 215 * @alias: Additional model string to match 216 * 217 * Search for a NIC configuration for the provided device, using the 218 * additionally specified matching constraints. If found, apply the 219 * configuration using qdev_set_nic_properties() and return %true. 220 * 221 * This is used by platform code which creates the device anyway, 222 * regardless of whether there is a configuration for it. This tends 223 * to be platforms which ignore `--nodefaults` and create net devices 224 * anyway, for example because the Ethernet device on that board is 225 * always physically present. 226 */ 227 bool qemu_configure_nic_device(DeviceState *dev, bool match_default, 228 const char *alias); 229 230 /** 231 * qemu_create_nic_device: Create a NIC device if a configuration exists for it 232 * @typename: Object typename of network device 233 * @match_default: Match NIC configurations with no model specified 234 * @alias: Additional model string to match 235 * 236 * Search for a NIC configuration for the provided device type. If found, 237 * create an object of the corresponding type and return it. 238 */ 239 DeviceState *qemu_create_nic_device(const char *typename, bool match_default, 240 const char *alias); 241 242 /* 243 * qemu_create_nic_bus_devices: Create configured NIC devices for a given bus 244 * @bus: Bus on which to create devices 245 * @parent_type: Object type for devices to be created (e.g. TYPE_PCI_DEVICE) 246 * @default_model: Object type name for default NIC model (or %NULL) 247 * @alias: Additional model string to replace, for user convenience 248 * @alias_target: Actual object type name to be used in place of @alias 249 * 250 * Instantiate dynamic NICs on a given bus, typically a PCI bus. This scans 251 * for available NIC configurations which either specify a model which is 252 * a child type of @parent_type, or which do not specify a model when 253 * @default_model is non-NULL. Each device is instantiated on the given @bus. 254 * 255 * A single substitution is supported, e.g. "xen" → "xen-net-device" for the 256 * Xen bus, or "virtio" → "virtio-net-pci" for PCI. This allows the user to 257 * specify a more understandable "model=" parameter on the command line, not 258 * only the real object typename. 259 */ 260 void qemu_create_nic_bus_devices(BusState *bus, const char *parent_type, 261 const char *default_model, 262 const char *alias, const char *alias_target); 263 void print_net_client(Monitor *mon, NetClientState *nc); 264 void net_socket_rs_init(SocketReadState *rs, 265 SocketReadStateFinalize *finalize, 266 bool vnet_hdr); 267 NetClientState *qemu_get_peer(NetClientState *nc, int queue_index); 268 269 /** 270 * qemu_get_nic_models: 271 * @device_type: Defines which devices should be taken into consideration 272 * (e.g. TYPE_DEVICE for all devices, or TYPE_PCI_DEVICE for PCI) 273 * 274 * Get an array of pointers to names of NIC devices that are available in 275 * the QEMU binary. The array is terminated with a NULL pointer entry. 276 * The caller is responsible for freeing the memory when it is not required 277 * anymore, e.g. with g_ptr_array_free(..., true). 278 * 279 * Returns: Pointer to the array that contains the pointers to the names. 280 */ 281 GPtrArray *qemu_get_nic_models(const char *device_type); 282 283 /* NIC info */ 284 285 #define MAX_NICS 8 286 287 struct NICInfo { 288 MACAddr macaddr; 289 char *model; 290 char *name; 291 char *devaddr; 292 NetClientState *netdev; 293 int used; /* is this slot in nd_table[] being used? */ 294 int instantiated; /* does this NICInfo correspond to an instantiated NIC? */ 295 int nvectors; 296 }; 297 298 /* from net.c */ 299 extern NetClientStateList net_clients; 300 bool netdev_is_modern(const char *optstr); 301 void netdev_parse_modern(const char *optstr); 302 void net_client_parse(QemuOptsList *opts_list, const char *optstr); 303 void show_netdevs(void); 304 void net_init_clients(void); 305 void net_check_clients(void); 306 void net_client_set_link(NetClientState **ncs, int queues, bool up); 307 void net_cleanup(void); 308 void hmp_host_net_add(Monitor *mon, const QDict *qdict); 309 void hmp_host_net_remove(Monitor *mon, const QDict *qdict); 310 void netdev_add(QemuOpts *opts, Error **errp); 311 312 int net_hub_id_for_client(NetClientState *nc, int *id); 313 314 #define DEFAULT_NETWORK_SCRIPT CONFIG_SYSCONFDIR "/qemu-ifup" 315 #define DEFAULT_NETWORK_DOWN_SCRIPT CONFIG_SYSCONFDIR "/qemu-ifdown" 316 #define DEFAULT_BRIDGE_HELPER CONFIG_QEMU_HELPERDIR "/qemu-bridge-helper" 317 #define DEFAULT_BRIDGE_INTERFACE "br0" 318 319 void qdev_set_nic_properties(DeviceState *dev, NICInfo *nd); 320 321 #define POLYNOMIAL_BE 0x04c11db6 322 #define POLYNOMIAL_LE 0xedb88320 323 uint32_t net_crc32(const uint8_t *p, int len); 324 uint32_t net_crc32_le(const uint8_t *p, int len); 325 326 #define vmstate_offset_macaddr(_state, _field) \ 327 vmstate_offset_array(_state, _field.a, uint8_t, \ 328 sizeof(typeof_field(_state, _field))) 329 330 #define VMSTATE_MACADDR(_field, _state) { \ 331 .name = (stringify(_field)), \ 332 .size = sizeof(MACAddr), \ 333 .info = &vmstate_info_buffer, \ 334 .flags = VMS_BUFFER, \ 335 .offset = vmstate_offset_macaddr(_state, _field), \ 336 } 337 338 static inline bool net_peer_needs_padding(NetClientState *nc) 339 { 340 return nc->peer && !nc->peer->do_not_pad; 341 } 342 343 #endif 344