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 struct MACAddr {
  13     uint8_t a[6];
  14 };
  15
  16 /* qdev nic properties */
  17
  18 typedef struct NICConf {
  19     MACAddr macaddr;
  20     NetClientState *peer;
  21     int32_t bootindex;
  22 } NICConf;
  23
  24 #define DEFINE_NIC_PROPERTIES(_state, _conf)                            \
  25     DEFINE_PROP_MACADDR("mac",   _state, _conf.macaddr),                \
  26     DEFINE_PROP_VLAN("vlan",     _state, _conf.peer),                   \
  27     DEFINE_PROP_NETDEV("netdev", _state, _conf.peer),                   \
  28     DEFINE_PROP_INT32("bootindex", _state, _conf.bootindex, -1)
  29
  30 /* Net clients */
  31
  32 typedef void (NetPoll)(NetClientState *, bool enable);
  33 typedef int (NetCanReceive)(NetClientState *);
  34 typedef ssize_t (NetReceive)(NetClientState *, const uint8_t *, size_t);
  35 typedef ssize_t (NetReceiveIOV)(NetClientState *, const struct iovec *, int);
  36 typedef void (NetCleanup) (NetClientState *);
  37 typedef void (LinkStatusChanged)(NetClientState *);
  38 typedef void (NetClientDestructor)(NetClientState *);
  39
  40 typedef struct NetClientInfo {
  41     NetClientOptionsKind type;
  42     size_t size;
  43     NetReceive *receive;
  44     NetReceive *receive_raw;
  45     NetReceiveIOV *receive_iov;
  46     NetCanReceive *can_receive;
  47     NetCleanup *cleanup;
  48     LinkStatusChanged *link_status_changed;
  49     NetPoll *poll;
  50 } NetClientInfo;
  51
  52 struct NetClientState {
  53     NetClientInfo *info;
  54     int link_down;
  55     QTAILQ_ENTRY(NetClientState) next;
  56     NetClientState *peer;
  57     NetQueue *send_queue;
  58     char *model;
  59     char *name;
  60     char info_str[256];
  61     unsigned receive_disabled : 1;
  62     NetClientDestructor *destructor;
  63 };
  64
  65 typedef struct NICState {
  66     NetClientState nc;
  67     NICConf *conf;
  68     void *opaque;
  69     bool peer_deleted;
  70 } NICState;
  71
  72 NetClientState *qemu_find_netdev(const char *id);
  73 int qemu_find_net_clients_except(const char *id, NetClientState **ncs,
  74                                  NetClientOptionsKind type, int max);
  75 NetClientState *qemu_new_net_client(NetClientInfo *info,
  76                                     NetClientState *peer,
  77                                     const char *model,
  78                                     const char *name);
  79 NICState *qemu_new_nic(NetClientInfo *info,
  80                        NICConf *conf,
  81                        const char *model,
  82                        const char *name,
  83                        void *opaque);
  84 void qemu_del_nic(NICState *nic);
  85 NetClientState *qemu_get_queue(NICState *nic);
  86 NICState *qemu_get_nic(NetClientState *nc);
  87 void *qemu_get_nic_opaque(NetClientState *nc);
  88 void qemu_del_net_client(NetClientState *nc);
  89 NetClientState *qemu_find_vlan_client_by_name(Monitor *mon, int vlan_id,
  90                                               const char *client_str);
  91 typedef void (*qemu_nic_foreach)(NICState *nic, void *opaque);
  92 void qemu_foreach_nic(qemu_nic_foreach func, void *opaque);
  93 int qemu_can_send_packet(NetClientState *nc);
  94 ssize_t qemu_sendv_packet(NetClientState *nc, const struct iovec *iov,
  95                           int iovcnt);
  96 ssize_t qemu_sendv_packet_async(NetClientState *nc, const struct iovec *iov,
  97                                 int iovcnt, NetPacketSent *sent_cb);
  98 void qemu_send_packet(NetClientState *nc, const uint8_t *buf, int size);
  99 ssize_t qemu_send_packet_raw(NetClientState *nc, const uint8_t *buf, int size);
 100 ssize_t qemu_send_packet_async(NetClientState *nc, const uint8_t *buf,
 101                                int size, NetPacketSent *sent_cb);
 102 void qemu_purge_queued_packets(NetClientState *nc);
 103 void qemu_flush_queued_packets(NetClientState *nc);
 104 void qemu_format_nic_info_str(NetClientState *nc, uint8_t macaddr[6]);
 105 void qemu_macaddr_default_if_unset(MACAddr *macaddr);
 106 int qemu_show_nic_models(const char *arg, const char *const *models);
 107 void qemu_check_nic_model(NICInfo *nd, const char *model);
 108 int qemu_find_nic_model(NICInfo *nd, const char * const *models,
 109                         const char *default_model);
 110
 111 ssize_t qemu_deliver_packet(NetClientState *sender,
 112                             unsigned flags,
 113                             const uint8_t *data,
 114                             size_t size,
 115                             void *opaque);
 116 ssize_t qemu_deliver_packet_iov(NetClientState *sender,
 117                             unsigned flags,
 118                             const struct iovec *iov,
 119                             int iovcnt,
 120                             void *opaque);
 121
 122 void print_net_client(Monitor *mon, NetClientState *nc);
 123 void do_info_network(Monitor *mon, const QDict *qdict);
 124
 125 /* NIC info */
 126
 127 #define MAX_NICS 8
 128
 129 struct NICInfo {
 130     MACAddr macaddr;
 131     char *model;
 132     char *name;
 133     char *devaddr;
 134     NetClientState *netdev;
 135     int used;         /* is this slot in nd_table[] being used? */
 136     int instantiated; /* does this NICInfo correspond to an instantiated NIC? */
 137     int nvectors;
 138 };
 139
 140 extern int nb_nics;
 141 extern NICInfo nd_table[MAX_NICS];
 142 extern int default_net;
 143
 144 /* from net.c */
 145 extern const char *legacy_tftp_prefix;
 146 extern const char *legacy_bootp_filename;
 147
 148 int net_client_init(QemuOpts *opts, int is_netdev, Error **errp);
 149 int net_client_parse(QemuOptsList *opts_list, const char *str);
 150 int net_init_clients(void);
 151 void net_check_clients(void);
 152 void net_cleanup(void);
 153 void net_host_device_add(Monitor *mon, const QDict *qdict);
 154 void net_host_device_remove(Monitor *mon, const QDict *qdict);
 155 void netdev_add(QemuOpts *opts, Error **errp);
 156 int qmp_netdev_add(Monitor *mon, const QDict *qdict, QObject **ret);
 157
 158 int net_hub_id_for_client(NetClientState *nc, int *id);
 159 NetClientState *net_hub_port_find(int hub_id);
 160
 161 #define DEFAULT_NETWORK_SCRIPT "/etc/qemu-ifup"
 162 #define DEFAULT_NETWORK_DOWN_SCRIPT "/etc/qemu-ifdown"
 163 #define DEFAULT_BRIDGE_HELPER CONFIG_QEMU_HELPERDIR "/qemu-bridge-helper"
 164 #define DEFAULT_BRIDGE_INTERFACE "br0"
 165
 166 void qdev_set_nic_properties(DeviceState *dev, NICInfo *nd);
 167
 168 #define POLYNOMIAL 0x04c11db6
 169 unsigned compute_mcast_idx(const uint8_t *ep);
 170
 171 #define vmstate_offset_macaddr(_state, _field)                       \
 172     vmstate_offset_array(_state, _field.a, uint8_t,                \
 173                          sizeof(typeof_field(_state, _field)))
 174
 175 #define VMSTATE_MACADDR(_field, _state) {                            \
 176     .name       = (stringify(_field)),                               \
 177     .size       = sizeof(MACAddr),                                   \
 178     .info       = &vmstate_info_buffer,                              \
 179     .flags      = VMS_BUFFER,                                        \
 180     .offset     = vmstate_offset_macaddr(_state, _field),            \
 181 }
 182
 183 #endif