include/net/net.h

   1 #ifndef QEMU_NET_H
   2 #define QEMU_NET_H
   3
   4 #include "qemu/queue.h"
   5 #include "qemu-common.h"
   6 #include "qapi/qmp/qdict.h"
   7 #include "qemu/option.h"
   8 #include "net/queue.h"
   9 #include "migration/vmstate.h"
  10 #include "qapi-types.h"
  11
  12 #define MAC_FMT "%02X:%02X:%02X:%02X:%02X:%02X"
  13 #define MAC_ARG(x) ((uint8_t *)(x))[0], ((uint8_t *)(x))[1], \
  14                    ((uint8_t *)(x))[2], ((uint8_t *)(x))[3], \
  15                    ((uint8_t *)(x))[4], ((uint8_t *)(x))[5]
  16
  17 #define MAX_QUEUE_NUM 1024
  18
  19 /* Maximum GSO packet size (64k) plus plenty of room for
  20  * the ethernet and virtio_net headers
  21  */
  22 #define NET_BUFSIZE (4096 + 65536)
  23
  24 struct MACAddr {
  25     uint8_t a[6];
  26 };
  27
  28 /* qdev nic properties */
  29
  30 typedef struct NICPeers {
  31     NetClientState *ncs[MAX_QUEUE_NUM];
  32     int32_t queues;
  33 } NICPeers;
  34
  35 typedef struct NICConf {
  36     MACAddr macaddr;
  37     NICPeers peers;
  38     int32_t bootindex;
  39 } NICConf;
  40
  41 #define DEFINE_NIC_PROPERTIES(_state, _conf)                            \
  42     DEFINE_PROP_MACADDR("mac",   _state, _conf.macaddr),                \
  43     DEFINE_PROP_VLAN("vlan",     _state, _conf.peers),                   \
  44     DEFINE_PROP_NETDEV("netdev", _state, _conf.peers)
  45
  46
  47 /* Net clients */
  48
  49 typedef void (NetPoll)(NetClientState *, bool enable);
  50 typedef int (NetCanReceive)(NetClientState *);
  51 typedef ssize_t (NetReceive)(NetClientState *, const uint8_t *, size_t);
  52 typedef ssize_t (NetReceiveIOV)(NetClientState *, const struct iovec *, int);
  53 typedef void (NetCleanup) (NetClientState *);
  54 typedef void (LinkStatusChanged)(NetClientState *);
  55 typedef void (NetClientDestructor)(NetClientState *);
  56 typedef RxFilterInfo *(QueryRxFilter)(NetClientState *);
  57 typedef bool (HasUfo)(NetClientState *);
  58 typedef bool (HasVnetHdr)(NetClientState *);
  59 typedef bool (HasVnetHdrLen)(NetClientState *, int);
  60 typedef void (UsingVnetHdr)(NetClientState *, bool);
  61 typedef void (SetOffload)(NetClientState *, int, int, int, int, int);
  62 typedef void (SetVnetHdrLen)(NetClientState *, int);
  63 typedef int (SetVnetLE)(NetClientState *, bool);
  64 typedef int (SetVnetBE)(NetClientState *, bool);
  65 typedef struct SocketReadState SocketReadState;
  66 typedef void (SocketReadStateFinalize)(SocketReadState *rs);
  67
  68 typedef struct NetClientInfo {
  69     NetClientOptionsKind type;
  70     size_t size;
  71     NetReceive *receive;
  72     NetReceive *receive_raw;
  73     NetReceiveIOV *receive_iov;
  74     NetCanReceive *can_receive;
  75     NetCleanup *cleanup;
  76     LinkStatusChanged *link_status_changed;
  77     QueryRxFilter *query_rx_filter;
  78     NetPoll *poll;
  79     HasUfo *has_ufo;
  80     HasVnetHdr *has_vnet_hdr;
  81     HasVnetHdrLen *has_vnet_hdr_len;
  82     UsingVnetHdr *using_vnet_hdr;
  83     SetOffload *set_offload;
  84     SetVnetHdrLen *set_vnet_hdr_len;
  85     SetVnetLE *set_vnet_le;
  86     SetVnetBE *set_vnet_be;
  87 } NetClientInfo;
  88
  89 struct NetClientState {
  90     NetClientInfo *info;
  91     int link_down;
  92     QTAILQ_ENTRY(NetClientState) next;
  93     NetClientState *peer;
  94     NetQueue *incoming_queue;
  95     char *model;
  96     char *name;
  97     char info_str[256];
  98     unsigned receive_disabled : 1;
  99     NetClientDestructor *destructor;
 100     unsigned int queue_index;
 101     unsigned rxfilter_notify_enabled:1;
 102     int vring_enable;
 103     QTAILQ_HEAD(NetFilterHead, NetFilterState) filters;
 104 };
 105
 106 typedef struct NICState {
 107     NetClientState *ncs;
 108     NICConf *conf;
 109     void *opaque;
 110     bool peer_deleted;
 111 } NICState;
 112
 113 struct SocketReadState {
 114     int state; /* 0 = getting length, 1 = getting data */
 115     uint32_t index;
 116     uint32_t packet_len;
 117     uint8_t buf[NET_BUFSIZE];
 118     SocketReadStateFinalize *finalize;
 119 };
 120
 121 int net_fill_rstate(SocketReadState *rs, const uint8_t *buf, int size);
 122 char *qemu_mac_strdup_printf(const uint8_t *macaddr);
 123 NetClientState *qemu_find_netdev(const char *id);
 124 int qemu_find_net_clients_except(const char *id, NetClientState **ncs,
 125                                  NetClientOptionsKind type, int max);
 126 NetClientState *qemu_new_net_client(NetClientInfo *info,
 127                                     NetClientState *peer,
 128                                     const char *model,
 129                                     const char *name);
 130 NICState *qemu_new_nic(NetClientInfo *info,
 131                        NICConf *conf,
 132                        const char *model,
 133                        const char *name,
 134                        void *opaque);
 135 void qemu_del_nic(NICState *nic);
 136 NetClientState *qemu_get_subqueue(NICState *nic, int queue_index);
 137 NetClientState *qemu_get_queue(NICState *nic);
 138 NICState *qemu_get_nic(NetClientState *nc);
 139 void *qemu_get_nic_opaque(NetClientState *nc);
 140 void qemu_del_net_client(NetClientState *nc);
 141 NetClientState *qemu_find_vlan_client_by_name(Monitor *mon, int vlan_id,
 142                                               const char *client_str);
 143 typedef void (*qemu_nic_foreach)(NICState *nic, void *opaque);
 144 void qemu_foreach_nic(qemu_nic_foreach func, void *opaque);
 145 int qemu_can_send_packet(NetClientState *nc);
 146 ssize_t qemu_sendv_packet(NetClientState *nc, const struct iovec *iov,
 147                           int iovcnt);
 148 ssize_t qemu_sendv_packet_async(NetClientState *nc, const struct iovec *iov,
 149                                 int iovcnt, NetPacketSent *sent_cb);
 150 void qemu_send_packet(NetClientState *nc, const uint8_t *buf, int size);
 151 ssize_t qemu_send_packet_raw(NetClientState *nc, const uint8_t *buf, int size);
 152 ssize_t qemu_send_packet_async(NetClientState *nc, const uint8_t *buf,
 153                                int size, NetPacketSent *sent_cb);
 154 void qemu_purge_queued_packets(NetClientState *nc);
 155 void qemu_flush_queued_packets(NetClientState *nc);
 156 void qemu_format_nic_info_str(NetClientState *nc, uint8_t macaddr[6]);
 157 bool qemu_has_ufo(NetClientState *nc);
 158 bool qemu_has_vnet_hdr(NetClientState *nc);
 159 bool qemu_has_vnet_hdr_len(NetClientState *nc, int len);
 160 void qemu_using_vnet_hdr(NetClientState *nc, bool enable);
 161 void qemu_set_offload(NetClientState *nc, int csum, int tso4, int tso6,
 162                       int ecn, int ufo);
 163 void qemu_set_vnet_hdr_len(NetClientState *nc, int len);
 164 int qemu_set_vnet_le(NetClientState *nc, bool is_le);
 165 int qemu_set_vnet_be(NetClientState *nc, bool is_be);
 166 void qemu_macaddr_default_if_unset(MACAddr *macaddr);
 167 int qemu_show_nic_models(const char *arg, const char *const *models);
 168 void qemu_check_nic_model(NICInfo *nd, const char *model);
 169 int qemu_find_nic_model(NICInfo *nd, const char * const *models,
 170                         const char *default_model);
 171
 172 ssize_t qemu_deliver_packet_iov(NetClientState *sender,
 173                             unsigned flags,
 174                             const struct iovec *iov,
 175                             int iovcnt,
 176                             void *opaque);
 177
 178 void print_net_client(Monitor *mon, NetClientState *nc);
 179 void hmp_info_network(Monitor *mon, const QDict *qdict);
 180 void net_socket_rs_init(SocketReadState *rs,
 181                         SocketReadStateFinalize *finalize);
 182
 183 /* NIC info */
 184
 185 #define MAX_NICS 8
 186
 187 struct NICInfo {
 188     MACAddr macaddr;
 189     char *model;
 190     char *name;
 191     char *devaddr;
 192     NetClientState *netdev;
 193     int used;         /* is this slot in nd_table[] being used? */
 194     int instantiated; /* does this NICInfo correspond to an instantiated NIC? */
 195     int nvectors;
 196 };
 197
 198 extern int nb_nics;
 199 extern NICInfo nd_table[MAX_NICS];
 200 extern const char *host_net_devices[];
 201
 202 /* from net.c */
 203 extern const char *legacy_tftp_prefix;
 204 extern const char *legacy_bootp_filename;
 205
 206 int net_client_init(QemuOpts *opts, int is_netdev, Error **errp);
 207 int net_client_parse(QemuOptsList *opts_list, const char *str);
 208 int net_init_clients(void);
 209 void net_check_clients(void);
 210 void net_cleanup(void);
 211 void hmp_host_net_add(Monitor *mon, const QDict *qdict);
 212 void hmp_host_net_remove(Monitor *mon, const QDict *qdict);
 213 void netdev_add(QemuOpts *opts, Error **errp);
 214 void qmp_netdev_add(QDict *qdict, QObject **ret, Error **errp);
 215
 216 int net_hub_id_for_client(NetClientState *nc, int *id);
 217 NetClientState *net_hub_port_find(int hub_id);
 218
 219 #define DEFAULT_NETWORK_SCRIPT "/etc/qemu-ifup"
 220 #define DEFAULT_NETWORK_DOWN_SCRIPT "/etc/qemu-ifdown"
 221 #define DEFAULT_BRIDGE_HELPER CONFIG_QEMU_HELPERDIR "/qemu-bridge-helper"
 222 #define DEFAULT_BRIDGE_INTERFACE "br0"
 223
 224 void qdev_set_nic_properties(DeviceState *dev, NICInfo *nd);
 225
 226 #define POLYNOMIAL 0x04c11db6
 227 unsigned compute_mcast_idx(const uint8_t *ep);
 228
 229 #define vmstate_offset_macaddr(_state, _field)                       \
 230     vmstate_offset_array(_state, _field.a, uint8_t,                \
 231                          sizeof(typeof_field(_state, _field)))
 232
 233 #define VMSTATE_MACADDR(_field, _state) {                            \
 234     .name       = (stringify(_field)),                               \
 235     .size       = sizeof(MACAddr),                                   \
 236     .info       = &vmstate_info_buffer,                              \
 237     .flags      = VMS_BUFFER,                                        \
 238     .offset     = vmstate_offset_macaddr(_state, _field),            \
 239 }
 240
 241 #endif