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 descriptor 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 #define foreach_virtio_if_flag          \
  62   _(0, ADMIN_UP, "admin-up")            \
  63   _(1, DELETING, "deleting")
  64
  65 typedef enum
  66 {
  67 #define _(a, b, c) VIRTIO_IF_FLAG_##b = (1 << a),
  68   foreach_virtio_if_flag
  69 #undef _
  70 } virtio_if_flag_t;
  71
  72 #define VIRTIO_NUM_RX_DESC 256
  73 #define VIRTIO_NUM_TX_DESC 256
  74
  75 #define VIRTIO_FEATURE(X) (1ULL << X)
  76
  77 #define TX_QUEUE(X) ((X*2) + 1)
  78 #define RX_QUEUE(X) (X*2)
  79 #define TX_QUEUE_ACCESS(X) (X/2)
  80 #define RX_QUEUE_ACCESS(X) (X/2)
  81
  82 #define foreach_virtio_if_types \
  83   _ (TAP, 0)                    \
  84   _ (TUN, 1)                    \
  85   _ (PCI, 2)
  86
  87 typedef enum
  88 {
  89 #define _(a, b) VIRTIO_IF_TYPE_##a = (1 << b),
  90   foreach_virtio_if_types
  91 #undef _
  92     VIRTIO_IF_N_TYPES = (1 << 3),
  93 } virtio_if_type_t;
  94
  95
  96 typedef struct
  97 {
  98   u8 mac[6];
  99   u16 status;
 100   u16 max_virtqueue_pairs;
 101   u16 mtu;
 102 } virtio_net_config_t;
 103
 104 #define VIRTIO_RING_FLAG_MASK_INT 1
 105
 106 typedef struct
 107 {
 108   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 109   struct vring_desc *desc;
 110   struct vring_used *used;
 111   struct vring_avail *avail;
 112   clib_spinlock_t lockp;
 113   u16 desc_in_use;
 114   u16 desc_next;
 115   int kick_fd;
 116   int call_fd;
 117   u8 buffer_pool_index;
 118   u16 size;
 119   u16 queue_id;
 120 #define VRING_TX_OUT_OF_ORDER 1
 121   u16 flags;
 122   u32 call_file_index;
 123   u32 *buffers;
 124   u16 last_used_idx;
 125   u16 last_kick_avail_idx;
 126 } virtio_vring_t;
 127
 128 typedef union
 129 {
 130   struct
 131   {
 132     u16 domain;
 133     u8 bus;
 134     u8 slot:5;
 135     u8 function:3;
 136   };
 137   u32 as_u32;
 138 } pci_addr_t;
 139
 140 typedef struct
 141 {
 142   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 143   u32 flags;
 144
 145   u32 dev_instance;
 146   u32 hw_if_index;
 147   u32 sw_if_index;
 148   u32 numa_node;
 149   u16 virtio_net_hdr_sz;
 150   virtio_if_type_t type;
 151   union
 152   {
 153     u32 id;
 154     pci_addr_t pci_addr;
 155   };
 156   u32 per_interface_next_index;
 157   int *vhost_fds;
 158   int *tap_fds;
 159   u32 msix_enabled;
 160   u32 pci_dev_handle;
 161   virtio_vring_t *rxq_vrings;
 162   virtio_vring_t *txq_vrings;
 163   u64 features, remote_features;
 164
 165   /* error */
 166   clib_error_t *error;
 167   u8 support_int_mode;          /* support interrupt mode */
 168   u16 max_queue_pairs;
 169   u16 num_rxqs;
 170   u16 num_txqs;
 171   u8 status;
 172   u8 mac_addr[6];
 173   u8 *host_if_name;
 174   u8 *net_ns;
 175   u8 *host_bridge;
 176   u8 host_mac_addr[6];
 177   ip4_address_t host_ip4_addr;
 178   u8 host_ip4_prefix_len;
 179   ip6_address_t host_ip6_addr;
 180   u8 host_ip6_prefix_len;
 181   u32 host_mtu_size;
 182   int gso_enabled;
 183   int csum_offload_enabled;
 184   int ifindex;
 185   virtio_vring_t *cxq_vring;
 186 } virtio_if_t;
 187
 188 typedef struct
 189 {
 190   /* logging */
 191   vlib_log_class_t log_default;
 192
 193   virtio_if_t *interfaces;
 194 } virtio_main_t;
 195
 196 extern virtio_main_t virtio_main;
 197 extern vnet_device_class_t virtio_device_class;
 198 extern vlib_node_registration_t virtio_input_node;
 199
 200 clib_error_t *virtio_vring_init (vlib_main_t * vm, virtio_if_t * vif, u16 idx,
 201                                  u16 sz);
 202 clib_error_t *virtio_vring_free_rx (vlib_main_t * vm, virtio_if_t * vif,
 203                                     u32 idx);
 204 clib_error_t *virtio_vring_free_tx (vlib_main_t * vm, virtio_if_t * vif,
 205                                     u32 idx);
 206 void virtio_vring_set_numa_node (vlib_main_t * vm, virtio_if_t * vif,
 207                                  u32 idx);
 208 extern void virtio_free_used_desc (vlib_main_t * vm, virtio_vring_t * vring);
 209 extern void virtio_free_rx_buffers (vlib_main_t * vm, virtio_vring_t * vring);
 210 extern void virtio_set_net_hdr_size (virtio_if_t * vif);
 211 extern void virtio_show (vlib_main_t * vm, u32 * hw_if_indices, u8 show_descr,
 212                          u32 type);
 213 extern void virtio_pci_legacy_notify_queue (vlib_main_t * vm,
 214                                             virtio_if_t * vif, u16 queue_id);
 215 format_function_t format_virtio_device_name;
 216 format_function_t format_virtio_log_name;
 217
 218 static_always_inline void
 219 virtio_kick (vlib_main_t * vm, virtio_vring_t * vring, virtio_if_t * vif)
 220 {
 221   if (vif->type == VIRTIO_IF_TYPE_PCI)
 222     virtio_pci_legacy_notify_queue (vm, vif, vring->queue_id);
 223   else
 224     {
 225       u64 x = 1;
 226       int __clib_unused r;
 227
 228       r = write (vring->kick_fd, &x, sizeof (x));
 229       vring->last_kick_avail_idx = vring->avail->idx;
 230     }
 231 }
 232
 233
 234 #define virtio_log_debug(vif, f, ...)                           \
 235 {                                                               \
 236   vlib_log(VLIB_LOG_LEVEL_DEBUG, virtio_main.log_default,       \
 237            "%U: " f, format_virtio_log_name, vif,               \
 238            ##__VA_ARGS__);                                      \
 239 };
 240
 241 #define virtio_log_warning(vif, f, ...)                         \
 242 {                                                               \
 243   vlib_log(VLIB_LOG_LEVEL_WARNING, virtio_main.log_default,     \
 244            "%U: " f, format_virtio_log_name, vif,               \
 245            ##__VA_ARGS__);                                      \
 246 };
 247
 248 #define virtio_log_error(vif, f, ...)                           \
 249 {                                                               \
 250   vlib_log(VLIB_LOG_LEVEL_ERR, virtio_main.log_default,         \
 251            "%U: " f, format_virtio_log_name, vif,               \
 252            ##__VA_ARGS__);                                      \
 253 };
 254
 255 #endif /* _VNET_DEVICES_VIRTIO_VIRTIO_H_ */
 256
 257 /*
 258  * fd.io coding-style-patch-verification: ON
 259  *
 260  * Local Variables:
 261  * eval: (c-set-style "gnu")
 262  * End:
 263  */