qemu/include/net/net.h
<<
>>
Prefs
   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
  24struct MACAddr {
  25    uint8_t a[6];
  26};
  27
  28/* qdev nic properties */
  29
  30typedef struct NICPeers {
  31    NetClientState *ncs[MAX_QUEUE_NUM];
  32    int32_t queues;
  33} NICPeers;
  34
  35typedef 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
  49typedef void (NetPoll)(NetClientState *, bool enable);
  50typedef int (NetCanReceive)(NetClientState *);
  51typedef ssize_t (NetReceive)(NetClientState *, const uint8_t *, size_t);
  52typedef ssize_t (NetReceiveIOV)(NetClientState *, const struct iovec *, int);
  53typedef void (NetCleanup) (NetClientState *);
  54typedef void (LinkStatusChanged)(NetClientState *);
  55typedef void (NetClientDestructor)(NetClientState *);
  56typedef RxFilterInfo *(QueryRxFilter)(NetClientState *);
  57typedef bool (HasUfo)(NetClientState *);
  58typedef bool (HasVnetHdr)(NetClientState *);
  59typedef bool (HasVnetHdrLen)(NetClientState *, int);
  60typedef void (UsingVnetHdr)(NetClientState *, bool);
  61typedef void (SetOffload)(NetClientState *, int, int, int, int, int);
  62typedef void (SetVnetHdrLen)(NetClientState *, int);
  63typedef int (SetVnetLE)(NetClientState *, bool);
  64typedef int (SetVnetBE)(NetClientState *, bool);
  65typedef struct SocketReadState SocketReadState;
  66typedef void (SocketReadStateFinalize)(SocketReadState *rs);
  67
  68typedef struct NetClientInfo {
  69    NetClientDriver 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
  89struct 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    int vnet_hdr_len;
 104    QTAILQ_HEAD(NetFilterHead, NetFilterState) filters;
 105};
 106
 107typedef struct NICState {
 108    NetClientState *ncs;
 109    NICConf *conf;
 110    void *opaque;
 111    bool peer_deleted;
 112} NICState;
 113
 114struct 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
 126int net_fill_rstate(SocketReadState *rs, const uint8_t *buf, int size);
 127char *qemu_mac_strdup_printf(const uint8_t *macaddr);
 128NetClientState *qemu_find_netdev(const char *id);
 129int qemu_find_net_clients_except(const char *id, NetClientState **ncs,
 130                                 NetClientDriver type, int max);
 131NetClientState *qemu_new_net_client(NetClientInfo *info,
 132                                    NetClientState *peer,
 133                                    const char *model,
 134                                    const char *name);
 135NICState *qemu_new_nic(NetClientInfo *info,
 136                       NICConf *conf,
 137                       const char *model,
 138                       const char *name,
 139                       void *opaque);
 140void qemu_del_nic(NICState *nic);
 141NetClientState *qemu_get_subqueue(NICState *nic, int queue_index);
 142NetClientState *qemu_get_queue(NICState *nic);
 143NICState *qemu_get_nic(NetClientState *nc);
 144void *qemu_get_nic_opaque(NetClientState *nc);
 145void qemu_del_net_client(NetClientState *nc);
 146typedef void (*qemu_nic_foreach)(NICState *nic, void *opaque);
 147void qemu_foreach_nic(qemu_nic_foreach func, void *opaque);
 148int qemu_can_send_packet(NetClientState *nc);
 149ssize_t qemu_sendv_packet(NetClientState *nc, const struct iovec *iov,
 150                          int iovcnt);
 151ssize_t qemu_sendv_packet_async(NetClientState *nc, const struct iovec *iov,
 152                                int iovcnt, NetPacketSent *sent_cb);
 153void qemu_send_packet(NetClientState *nc, const uint8_t *buf, int size);
 154ssize_t qemu_send_packet_raw(NetClientState *nc, const uint8_t *buf, int size);
 155ssize_t qemu_send_packet_async(NetClientState *nc, const uint8_t *buf,
 156                               int size, NetPacketSent *sent_cb);
 157void qemu_purge_queued_packets(NetClientState *nc);
 158void qemu_flush_queued_packets(NetClientState *nc);
 159void qemu_format_nic_info_str(NetClientState *nc, uint8_t macaddr[6]);
 160bool qemu_has_ufo(NetClientState *nc);
 161bool qemu_has_vnet_hdr(NetClientState *nc);
 162bool qemu_has_vnet_hdr_len(NetClientState *nc, int len);
 163void qemu_using_vnet_hdr(NetClientState *nc, bool enable);
 164void qemu_set_offload(NetClientState *nc, int csum, int tso4, int tso6,
 165                      int ecn, int ufo);
 166void qemu_set_vnet_hdr_len(NetClientState *nc, int len);
 167int qemu_set_vnet_le(NetClientState *nc, bool is_le);
 168int qemu_set_vnet_be(NetClientState *nc, bool is_be);
 169void qemu_macaddr_default_if_unset(MACAddr *macaddr);
 170int qemu_show_nic_models(const char *arg, const char *const *models);
 171void qemu_check_nic_model(NICInfo *nd, const char *model);
 172int qemu_find_nic_model(NICInfo *nd, const char * const *models,
 173                        const char *default_model);
 174
 175ssize_t qemu_deliver_packet_iov(NetClientState *sender,
 176                            unsigned flags,
 177                            const struct iovec *iov,
 178                            int iovcnt,
 179                            void *opaque);
 180
 181void print_net_client(Monitor *mon, NetClientState *nc);
 182void hmp_info_network(Monitor *mon, const QDict *qdict);
 183void net_socket_rs_init(SocketReadState *rs,
 184                        SocketReadStateFinalize *finalize,
 185                        bool vnet_hdr);
 186
 187/* NIC info */
 188
 189#define MAX_NICS 8
 190
 191struct NICInfo {
 192    MACAddr macaddr;
 193    char *model;
 194    char *name;
 195    char *devaddr;
 196    NetClientState *netdev;
 197    int used;         /* is this slot in nd_table[] being used? */
 198    int instantiated; /* does this NICInfo correspond to an instantiated NIC? */
 199    int nvectors;
 200};
 201
 202extern int nb_nics;
 203extern NICInfo nd_table[MAX_NICS];
 204extern const char *host_net_devices[];
 205
 206/* from net.c */
 207extern const char *legacy_tftp_prefix;
 208extern const char *legacy_bootp_filename;
 209
 210int net_client_init(QemuOpts *opts, bool is_netdev, Error **errp);
 211int net_client_parse(QemuOptsList *opts_list, const char *str);
 212int net_init_clients(void);
 213void net_check_clients(void);
 214void net_cleanup(void);
 215void hmp_host_net_add(Monitor *mon, const QDict *qdict);
 216void hmp_host_net_remove(Monitor *mon, const QDict *qdict);
 217void netdev_add(QemuOpts *opts, Error **errp);
 218void qmp_netdev_add(QDict *qdict, QObject **ret, Error **errp);
 219
 220int net_hub_id_for_client(NetClientState *nc, int *id);
 221NetClientState *net_hub_port_find(int hub_id);
 222
 223#define DEFAULT_NETWORK_SCRIPT "/etc/qemu-ifup"
 224#define DEFAULT_NETWORK_DOWN_SCRIPT "/etc/qemu-ifdown"
 225#define DEFAULT_BRIDGE_HELPER CONFIG_QEMU_HELPERDIR "/qemu-bridge-helper"
 226#define DEFAULT_BRIDGE_INTERFACE "br0"
 227
 228void qdev_set_nic_properties(DeviceState *dev, NICInfo *nd);
 229
 230#define POLYNOMIAL 0x04c11db6
 231unsigned compute_mcast_idx(const uint8_t *ep);
 232
 233#define vmstate_offset_macaddr(_state, _field)                       \
 234    vmstate_offset_array(_state, _field.a, uint8_t,                \
 235                         sizeof(typeof_field(_state, _field)))
 236
 237#define VMSTATE_MACADDR(_field, _state) {                            \
 238    .name       = (stringify(_field)),                               \
 239    .size       = sizeof(MACAddr),                                   \
 240    .info       = &vmstate_info_buffer,                              \
 241    .flags      = VMS_BUFFER,                                        \
 242    .offset     = vmstate_offset_macaddr(_state, _field),            \
 243}
 244
 245#endif
 246