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