src/vnet/devices/virtio/virtio.h

   1 /*
   2  *------------------------------------------------------------------
   3  * Copyright (c) 2017 Cisco and/or its affiliates.
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  *------------------------------------------------------------------
  16  */
  17
  18 #ifndef _VNET_DEVICES_VIRTIO_VIRTIO_H_
  19 #define _VNET_DEVICES_VIRTIO_VIRTIO_H_
  20
  21 #include <linux/virtio_config.h>
  22 #include <linux/virtio_net.h>
  23 #include <linux/virtio_pci.h>
  24 #include <linux/virtio_ring.h>
  25
  26 #define foreach_virtio_net_features      \
  27   _ (VIRTIO_NET_F_CSUM, 0)      /* Host handles pkts w/ partial csum */ \
  28   _ (VIRTIO_NET_F_GUEST_CSUM, 1) /* Guest handles pkts w/ partial csum */ \
  29   _ (VIRTIO_NET_F_CTRL_GUEST_OFFLOADS, 2) /* Dynamic offload configuration. */ \
  30   _ (VIRTIO_NET_F_MTU, 3)       /* Initial MTU advice. */ \
  31   _ (VIRTIO_NET_F_MAC, 5)       /* Host has given MAC address. */ \
  32   _ (VIRTIO_NET_F_GSO, 6)       /* Host handles pkts w/ any GSO. */ \
  33   _ (VIRTIO_NET_F_GUEST_TSO4, 7)        /* Guest can handle TSOv4 in. */ \
  34   _ (VIRTIO_NET_F_GUEST_TSO6, 8)        /* Guest can handle TSOv6 in. */ \
  35   _ (VIRTIO_NET_F_GUEST_ECN, 9) /* Guest can handle TSO[6] w/ ECN in. */ \
  36   _ (VIRTIO_NET_F_GUEST_UFO, 10)        /* Guest can handle UFO in. */ \
  37   _ (VIRTIO_NET_F_HOST_TSO4, 11)        /* Host can handle TSOv4 in. */ \
  38   _ (VIRTIO_NET_F_HOST_TSO6, 12)        /* Host can handle TSOv6 in. */ \
  39   _ (VIRTIO_NET_F_HOST_ECN, 13) /* Host can handle TSO[6] w/ ECN in. */ \
  40   _ (VIRTIO_NET_F_HOST_UFO, 14) /* Host can handle UFO in. */ \
  41   _ (VIRTIO_NET_F_MRG_RXBUF, 15)        /* Host can merge receive buffers. */ \
  42   _ (VIRTIO_NET_F_STATUS, 16)   /* virtio_net_config.status available */ \
  43   _ (VIRTIO_NET_F_CTRL_VQ, 17)  /* Control channel available */ \
  44   _ (VIRTIO_NET_F_CTRL_RX, 18)  /* Control channel RX mode support */ \
  45   _ (VIRTIO_NET_F_CTRL_VLAN, 19)        /* Control channel VLAN filtering */ \
  46   _ (VIRTIO_NET_F_CTRL_RX_EXTRA, 20)    /* Extra RX mode control support */ \
  47   _ (VIRTIO_NET_F_GUEST_ANNOUNCE, 21)   /* Guest can announce device on the network */ \
  48   _ (VIRTIO_NET_F_MQ, 22)               /* Device supports Receive Flow Steering */ \
  49   _ (VIRTIO_NET_F_CTRL_MAC_ADDR, 23)    /* Set MAC address */ \
  50   _ (VIRTIO_F_NOTIFY_ON_EMPTY, 24) \
  51   _ (VHOST_F_LOG_ALL, 26)      /* Log all write descriptors */ \
  52   _ (VIRTIO_F_ANY_LAYOUT, 27)  /* Can the device handle any descripor layout */ \
  53   _ (VIRTIO_RING_F_INDIRECT_DESC, 28)   /* Support indirect buffer descriptors */ \
  54   _ (VIRTIO_RING_F_EVENT_IDX, 29)       /* The Guest publishes the used index for which it expects an interrupt \
  55  * at the end of the avail ring. Host should ignore the avail->flags field. */ \
  56 /* The Host publishes the avail index for which it expects a kick \
  57  * at the end of the used ring. Guest should ignore the used->flags field. */ \
  58   _ (VHOST_USER_F_PROTOCOL_FEATURES, 30) \
  59   _ (VIRTIO_F_VERSION_1, 32)
  60
  61
  62 #define foreach_virtio_if_flag          \
  63   _(0, ADMIN_UP, "admin-up")            \
  64   _(1, DELETING, "deleting")
  65
  66 typedef enum
  67 {
  68 #define _(a, b, c) VIRTIO_IF_FLAG_##b = (1 << a),
  69   foreach_virtio_if_flag
  70 #undef _
  71 } virtio_if_flag_t;
  72
  73 #define VIRTIO_NUM_RX_DESC 256
  74 #define VIRTIO_NUM_TX_DESC 256
  75
  76 #define VIRTIO_FEATURE(X) (1ULL << X)
  77
  78 typedef enum
  79 {
  80   VIRTIO_IF_TYPE_TAP,
  81   VIRTIO_IF_TYPE_PCI,
  82   VIRTIO_IF_N_TYPES,
  83 } virtio_if_type_t;
  84
  85
  86 typedef struct
  87 {
  88   u8 mac[6];
  89   u16 status;
  90   u16 max_virtqueue_pairs;
  91   u16 mtu;
  92 } virtio_net_config_t;
  93
  94 #define VIRTIO_RING_FLAG_MASK_INT 1
  95
  96 typedef struct
  97 {
  98   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  99   struct vring_desc *desc;
 100   struct vring_used *used;
 101   struct vring_avail *avail;
 102   u16 desc_in_use;
 103   u16 desc_next;
 104   int kick_fd;
 105   int call_fd;
 106   u16 size;
 107   u16 queue_id;
 108   u16 flags;
 109   u32 call_file_index;
 110   u32 *buffers;
 111   u32 *indirect_buffers;
 112   u16 last_used_idx;
 113   u16 last_kick_avail_idx;
 114 } virtio_vring_t;
 115
 116 typedef union
 117 {
 118   struct
 119   {
 120     u16 domain;
 121     u8 bus;
 122     u8 slot:5;
 123     u8 function:3;
 124   };
 125   u32 as_u32;
 126 } pci_addr_t;
 127
 128 typedef struct
 129 {
 130   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 131   u32 flags;
 132   clib_spinlock_t lockp;
 133
 134   u32 dev_instance;
 135   u32 hw_if_index;
 136   u32 sw_if_index;
 137   u16 virtio_net_hdr_sz;
 138   virtio_if_type_t type;
 139   union
 140   {
 141     u32 id;
 142     pci_addr_t pci_addr;
 143   };
 144   u32 per_interface_next_index;
 145   int fd;
 146   union
 147   {
 148     int tap_fd;
 149     u32 pci_dev_handle;
 150   };
 151   virtio_vring_t *vrings;
 152
 153   u64 features, remote_features;
 154
 155   /* error */
 156   clib_error_t *error;
 157   u16 max_queue_pairs;
 158   u16 tx_ring_sz;
 159   u16 rx_ring_sz;
 160   u8 status;
 161   u8 mac_addr[6];
 162   u64 bar[2];
 163   u8 *host_if_name;
 164   u8 *net_ns;
 165   u8 *host_bridge;
 166   u8 host_mac_addr[6];
 167   ip4_address_t host_ip4_addr;
 168   u8 host_ip4_prefix_len;
 169   ip6_address_t host_ip6_addr;
 170   u8 host_ip6_prefix_len;
 171
 172   int ifindex;
 173 } virtio_if_t;
 174
 175 typedef struct
 176 {
 177   virtio_if_t *interfaces;
 178 } virtio_main_t;
 179
 180 extern virtio_main_t virtio_main;
 181 extern vnet_device_class_t virtio_device_class;
 182 extern vlib_node_registration_t virtio_input_node;
 183
 184 clib_error_t *virtio_vring_init (vlib_main_t * vm, virtio_if_t * vif, u16 idx,
 185                                  u16 sz);
 186 clib_error_t *virtio_vring_free (vlib_main_t * vm, virtio_if_t * vif,
 187                                  u32 idx);
 188 extern void virtio_free_used_desc (vlib_main_t * vm, virtio_vring_t * vring);
 189 extern void virtio_free_rx_buffers (vlib_main_t * vm, virtio_vring_t * vring);
 190 extern void virtio_set_net_hdr_size (virtio_if_t * vif);
 191 extern void virtio_show (vlib_main_t * vm, u32 * hw_if_indices, u8 show_descr,
 192                          u32 type);
 193 extern void virtio_pci_legacy_notify_queue (vlib_main_t * vm,
 194                                             virtio_if_t * vif, u16 queue_id);
 195 format_function_t format_virtio_device_name;
 196
 197 static_always_inline void
 198 virtio_kick (vlib_main_t * vm, virtio_vring_t * vring, virtio_if_t * vif)
 199 {
 200   if (vif->type == VIRTIO_IF_TYPE_PCI)
 201     virtio_pci_legacy_notify_queue (vm, vif, vring->queue_id);
 202   else
 203     {
 204       u64 x = 1;
 205       int __clib_unused r;
 206
 207       r = write (vring->kick_fd, &x, sizeof (x));
 208       vring->last_kick_avail_idx = vring->avail->idx;
 209     }
 210 }
 211
 212 #endif /* _VNET_DEVICES_VIRTIO_VIRTIO_H_ */
 213
 214 /*
 215  * fd.io coding-style-patch-verification: ON
 216  *
 217  * Local Variables:
 218  * eval: (c-set-style "gnu")
 219  * End:
 220  */