include/hw/virtio/virtio-net.h

   1 /*
   2  * Virtio Network Device
   3  *
   4  * Copyright IBM, Corp. 2007
   5  *
   6  * Authors:
   7  *  Anthony Liguori   <aliguori@us.ibm.com>
   8  *
   9  * This work is licensed under the terms of the GNU GPL, version 2.  See
  10  * the COPYING file in the top-level directory.
  11  *
  12  */
  13
  14 #ifndef _QEMU_VIRTIO_NET_H
  15 #define _QEMU_VIRTIO_NET_H
  16
  17 #include "hw/virtio/virtio.h"
  18 #include "hw/pci/pci.h"
  19
  20 #define TYPE_VIRTIO_NET "virtio-net-device"
  21 #define VIRTIO_NET(obj) \
  22         OBJECT_CHECK(VirtIONet, (obj), TYPE_VIRTIO_NET)
  23
  24 #define ETH_ALEN    6
  25
  26 /* from Linux's virtio_net.h */
  27
  28 /* The ID for virtio_net */
  29 #define VIRTIO_ID_NET   1
  30
  31 /* The feature bitmap for virtio net */
  32 #define VIRTIO_NET_F_CSUM       0       /* Host handles pkts w/ partial csum */
  33 #define VIRTIO_NET_F_GUEST_CSUM 1       /* Guest handles pkts w/ partial csum */
  34 #define VIRTIO_NET_F_CTRL_GUEST_OFFLOADS 2 /* Control channel offload
  35                                          * configuration support */
  36 #define VIRTIO_NET_F_MAC        5       /* Host has given MAC address. */
  37 #define VIRTIO_NET_F_GSO        6       /* Host handles pkts w/ any GSO type */
  38 #define VIRTIO_NET_F_GUEST_TSO4 7       /* Guest can handle TSOv4 in. */
  39 #define VIRTIO_NET_F_GUEST_TSO6 8       /* Guest can handle TSOv6 in. */
  40 #define VIRTIO_NET_F_GUEST_ECN  9       /* Guest can handle TSO[6] w/ ECN in. */
  41 #define VIRTIO_NET_F_GUEST_UFO  10      /* Guest can handle UFO in. */
  42 #define VIRTIO_NET_F_HOST_TSO4  11      /* Host can handle TSOv4 in. */
  43 #define VIRTIO_NET_F_HOST_TSO6  12      /* Host can handle TSOv6 in. */
  44 #define VIRTIO_NET_F_HOST_ECN   13      /* Host can handle TSO[6] w/ ECN in. */
  45 #define VIRTIO_NET_F_HOST_UFO   14      /* Host can handle UFO in. */
  46 #define VIRTIO_NET_F_MRG_RXBUF  15      /* Host can merge receive buffers. */
  47 #define VIRTIO_NET_F_STATUS     16      /* virtio_net_config.status available */
  48 #define VIRTIO_NET_F_CTRL_VQ    17      /* Control channel available */
  49 #define VIRTIO_NET_F_CTRL_RX    18      /* Control channel RX mode support */
  50 #define VIRTIO_NET_F_CTRL_VLAN  19      /* Control channel VLAN filtering */
  51 #define VIRTIO_NET_F_CTRL_RX_EXTRA 20   /* Extra RX mode control support */
  52 #define VIRTIO_NET_F_GUEST_ANNOUNCE 21  /* Guest can announce itself */
  53 #define VIRTIO_NET_F_MQ         22      /* Device supports Receive Flow
  54                                          * Steering */
  55
  56 #define VIRTIO_NET_F_CTRL_MAC_ADDR   23 /* Set MAC address */
  57
  58 #define VIRTIO_NET_S_LINK_UP    1       /* Link is up */
  59 #define VIRTIO_NET_S_ANNOUNCE   2       /* Announcement is needed */
  60
  61 #define TX_TIMER_INTERVAL 150000 /* 150 us */
  62
  63 /* Limit the number of packets that can be sent via a single flush
  64  * of the TX queue.  This gives us a guaranteed exit condition and
  65  * ensures fairness in the io path.  256 conveniently matches the
  66  * length of the TX queue and shows a good balance of performance
  67  * and latency. */
  68 #define TX_BURST 256
  69
  70 typedef struct virtio_net_conf
  71 {
  72     uint32_t txtimer;
  73     int32_t txburst;
  74     char *tx;
  75 } virtio_net_conf;
  76
  77 /* Maximum packet size we can receive from tap device: header + 64k */
  78 #define VIRTIO_NET_MAX_BUFSIZE (sizeof(struct virtio_net_hdr) + (64 << 10))
  79
  80 struct virtio_net_config
  81 {
  82     /* The config defining mac address ($ETH_ALEN bytes) */
  83     uint8_t mac[ETH_ALEN];
  84     /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
  85     uint16_t status;
  86     /* Max virtqueue pairs supported by the device */
  87     uint16_t max_virtqueue_pairs;
  88 } QEMU_PACKED;
  89
  90 /*
  91  * Control virtqueue data structures
  92  *
  93  * The control virtqueue expects a header in the first sg entry
  94  * and an ack/status response in the last entry.  Data for the
  95  * command goes in between.
  96  */
  97 struct virtio_net_ctrl_hdr {
  98     uint8_t class;
  99     uint8_t cmd;
 100 };
 101
 102 typedef uint8_t virtio_net_ctrl_ack;
 103
 104 #define VIRTIO_NET_OK     0
 105 #define VIRTIO_NET_ERR    1
 106
 107 /*
 108  * Control the RX mode, ie. promisucous, allmulti, etc...
 109  * All commands require an "out" sg entry containing a 1 byte
 110  * state value, zero = disable, non-zero = enable.  Commands
 111  * 0 and 1 are supported with the VIRTIO_NET_F_CTRL_RX feature.
 112  * Commands 2-5 are added with VIRTIO_NET_F_CTRL_RX_EXTRA.
 113  */
 114 #define VIRTIO_NET_CTRL_RX    0
 115  #define VIRTIO_NET_CTRL_RX_PROMISC      0
 116  #define VIRTIO_NET_CTRL_RX_ALLMULTI     1
 117  #define VIRTIO_NET_CTRL_RX_ALLUNI       2
 118  #define VIRTIO_NET_CTRL_RX_NOMULTI      3
 119  #define VIRTIO_NET_CTRL_RX_NOUNI        4
 120  #define VIRTIO_NET_CTRL_RX_NOBCAST      5
 121
 122 /*
 123  * Control the MAC
 124  *
 125  * The MAC filter table is managed by the hypervisor, the guest should
 126  * assume the size is infinite.  Filtering should be considered
 127  * non-perfect, ie. based on hypervisor resources, the guest may
 128  * received packets from sources not specified in the filter list.
 129  *
 130  * In addition to the class/cmd header, the TABLE_SET command requires
 131  * two out scatterlists.  Each contains a 4 byte count of entries followed
 132  * by a concatenated byte stream of the ETH_ALEN MAC addresses.  The
 133  * first sg list contains unicast addresses, the second is for multicast.
 134  * This functionality is present if the VIRTIO_NET_F_CTRL_RX feature
 135  * is available.
 136  *
 137  * The ADDR_SET command requests one out scatterlist, it contains a
 138  * 6 bytes MAC address. This functionality is present if the
 139  * VIRTIO_NET_F_CTRL_MAC_ADDR feature is available.
 140  */
 141 struct virtio_net_ctrl_mac {
 142     uint32_t entries;
 143     uint8_t macs[][ETH_ALEN];
 144 };
 145
 146 typedef struct VirtIONetQueue {
 147     VirtQueue *rx_vq;
 148     VirtQueue *tx_vq;
 149     QEMUTimer *tx_timer;
 150     QEMUBH *tx_bh;
 151     int tx_waiting;
 152     struct {
 153         VirtQueueElement elem;
 154         ssize_t len;
 155     } async_tx;
 156     struct VirtIONet *n;
 157 } VirtIONetQueue;
 158
 159 typedef struct VirtIONet {
 160     VirtIODevice parent_obj;
 161     uint8_t mac[ETH_ALEN];
 162     uint16_t status;
 163     VirtIONetQueue *vqs;
 164     VirtQueue *ctrl_vq;
 165     NICState *nic;
 166     uint32_t tx_timeout;
 167     int32_t tx_burst;
 168     uint32_t has_vnet_hdr;
 169     size_t host_hdr_len;
 170     size_t guest_hdr_len;
 171     uint8_t has_ufo;
 172     int mergeable_rx_bufs;
 173     uint8_t promisc;
 174     uint8_t allmulti;
 175     uint8_t alluni;
 176     uint8_t nomulti;
 177     uint8_t nouni;
 178     uint8_t nobcast;
 179     uint8_t vhost_started;
 180     struct {
 181         uint32_t in_use;
 182         uint32_t first_multi;
 183         uint8_t multi_overflow;
 184         uint8_t uni_overflow;
 185         uint8_t *macs;
 186     } mac_table;
 187     uint32_t *vlans;
 188     virtio_net_conf net_conf;
 189     NICConf nic_conf;
 190     DeviceState *qdev;
 191     int multiqueue;
 192     uint16_t max_queues;
 193     uint16_t curr_queues;
 194     size_t config_size;
 195     char *netclient_name;
 196     char *netclient_type;
 197     uint64_t curr_guest_offloads;
 198     QEMUTimer *announce_timer;
 199     int announce_counter;
 200 } VirtIONet;
 201
 202 #define VIRTIO_NET_CTRL_MAC    1
 203  #define VIRTIO_NET_CTRL_MAC_TABLE_SET        0
 204  #define VIRTIO_NET_CTRL_MAC_ADDR_SET         1
 205
 206 /*
 207  * Control VLAN filtering
 208  *
 209  * The VLAN filter table is controlled via a simple ADD/DEL interface.
 210  * VLAN IDs not added may be filterd by the hypervisor.  Del is the
 211  * opposite of add.  Both commands expect an out entry containing a 2
 212  * byte VLAN ID.  VLAN filterting is available with the
 213  * VIRTIO_NET_F_CTRL_VLAN feature bit.
 214  */
 215 #define VIRTIO_NET_CTRL_VLAN       2
 216  #define VIRTIO_NET_CTRL_VLAN_ADD             0
 217  #define VIRTIO_NET_CTRL_VLAN_DEL             1
 218
 219 /*
 220  * Control link announce acknowledgement
 221  *
 222  * VIRTIO_NET_S_ANNOUNCE bit in the status field requests link announcement from
 223  * guest driver. The driver is notified by config space change interrupt.  The
 224  * command VIRTIO_NET_CTRL_ANNOUNCE_ACK is used to indicate that the driver has
 225  * received the notification. It makes the device clear the bit
 226  * VIRTIO_NET_S_ANNOUNCE in the status field.
 227  */
 228 #define VIRTIO_NET_CTRL_ANNOUNCE       3
 229  #define VIRTIO_NET_CTRL_ANNOUNCE_ACK         0
 230
 231 /*
 232  * Control Multiqueue
 233  *
 234  * The command VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET
 235  * enables multiqueue, specifying the number of the transmit and
 236  * receive queues that will be used. After the command is consumed and acked by
 237  * the device, the device will not steer new packets on receive virtqueues
 238  * other than specified nor read from transmit virtqueues other than specified.
 239  * Accordingly, driver should not transmit new packets  on virtqueues other than
 240  * specified.
 241  */
 242 struct virtio_net_ctrl_mq {
 243     uint16_t virtqueue_pairs;
 244 };
 245
 246 #define VIRTIO_NET_CTRL_MQ   4
 247  #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET        0
 248  #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN        1
 249  #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX        0x8000
 250
 251 /*
 252  * Control network offloads
 253  *
 254  * Dynamic offloads are available with the
 255  * VIRTIO_NET_F_CTRL_GUEST_OFFLOADS feature bit.
 256  */
 257 #define VIRTIO_NET_CTRL_GUEST_OFFLOADS   5
 258  #define VIRTIO_NET_CTRL_GUEST_OFFLOADS_SET        0
 259
 260 #define DEFINE_VIRTIO_NET_FEATURES(_state, _field) \
 261         DEFINE_PROP_BIT("any_layout", _state, _field, VIRTIO_F_ANY_LAYOUT, true), \
 262         DEFINE_PROP_BIT("csum", _state, _field, VIRTIO_NET_F_CSUM, true), \
 263         DEFINE_PROP_BIT("guest_csum", _state, _field, VIRTIO_NET_F_GUEST_CSUM, true), \
 264         DEFINE_PROP_BIT("gso", _state, _field, VIRTIO_NET_F_GSO, true), \
 265         DEFINE_PROP_BIT("guest_tso4", _state, _field, VIRTIO_NET_F_GUEST_TSO4, true), \
 266         DEFINE_PROP_BIT("guest_tso6", _state, _field, VIRTIO_NET_F_GUEST_TSO6, true), \
 267         DEFINE_PROP_BIT("guest_ecn", _state, _field, VIRTIO_NET_F_GUEST_ECN, true), \
 268         DEFINE_PROP_BIT("guest_ufo", _state, _field, VIRTIO_NET_F_GUEST_UFO, true), \
 269         DEFINE_PROP_BIT("guest_announce", _state, _field, VIRTIO_NET_F_GUEST_ANNOUNCE, true), \
 270         DEFINE_PROP_BIT("host_tso4", _state, _field, VIRTIO_NET_F_HOST_TSO4, true), \
 271         DEFINE_PROP_BIT("host_tso6", _state, _field, VIRTIO_NET_F_HOST_TSO6, true), \
 272         DEFINE_PROP_BIT("host_ecn", _state, _field, VIRTIO_NET_F_HOST_ECN, true), \
 273         DEFINE_PROP_BIT("host_ufo", _state, _field, VIRTIO_NET_F_HOST_UFO, true), \
 274         DEFINE_PROP_BIT("mrg_rxbuf", _state, _field, VIRTIO_NET_F_MRG_RXBUF, true), \
 275         DEFINE_PROP_BIT("status", _state, _field, VIRTIO_NET_F_STATUS, true), \
 276         DEFINE_PROP_BIT("ctrl_vq", _state, _field, VIRTIO_NET_F_CTRL_VQ, true), \
 277         DEFINE_PROP_BIT("ctrl_rx", _state, _field, VIRTIO_NET_F_CTRL_RX, true), \
 278         DEFINE_PROP_BIT("ctrl_vlan", _state, _field, VIRTIO_NET_F_CTRL_VLAN, true), \
 279         DEFINE_PROP_BIT("ctrl_rx_extra", _state, _field, VIRTIO_NET_F_CTRL_RX_EXTRA, true), \
 280         DEFINE_PROP_BIT("ctrl_mac_addr", _state, _field, VIRTIO_NET_F_CTRL_MAC_ADDR, true), \
 281         DEFINE_PROP_BIT("ctrl_guest_offloads", _state, _field, VIRTIO_NET_F_CTRL_GUEST_OFFLOADS, true), \
 282         DEFINE_PROP_BIT("mq", _state, _field, VIRTIO_NET_F_MQ, false)
 283
 284 #define DEFINE_VIRTIO_NET_PROPERTIES(_state, _field)                           \
 285     DEFINE_PROP_UINT32("x-txtimer", _state, _field.txtimer, TX_TIMER_INTERVAL),\
 286     DEFINE_PROP_INT32("x-txburst", _state, _field.txburst, TX_BURST),          \
 287     DEFINE_PROP_STRING("tx", _state, _field.tx)
 288
 289 void virtio_net_set_config_size(VirtIONet *n, uint32_t host_features);
 290 void virtio_net_set_netclient_name(VirtIONet *n, const char *name,
 291                                    const char *type);
 292
 293 #endif