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 <vnet/devices/virtio/virtio_std.h>
  22 #include <vnet/devices/virtio/vhost_std.h>
  23 #include <vnet/gso/gro.h>
  24
  25 #define foreach_virtio_if_flag          \
  26   _(0, ADMIN_UP, "admin-up")            \
  27   _(1, DELETING, "deleting")
  28
  29 typedef enum
  30 {
  31 #define _(a, b, c) VIRTIO_IF_FLAG_##b = (1 << a),
  32   foreach_virtio_if_flag
  33 #undef _
  34 } virtio_if_flag_t;
  35
  36 #define TX_QUEUE(X) ((X*2) + 1)
  37 #define RX_QUEUE(X) (X*2)
  38 #define TX_QUEUE_ACCESS(X) (X/2)
  39 #define RX_QUEUE_ACCESS(X) (X/2)
  40
  41 #define VIRTIO_NUM_RX_DESC 256
  42 #define VIRTIO_NUM_TX_DESC 256
  43
  44 #define foreach_virtio_if_types \
  45   _ (TAP, 0)                    \
  46   _ (TUN, 1)                    \
  47   _ (PCI, 2)
  48
  49 typedef enum
  50 {
  51 #define _(a, b) VIRTIO_IF_TYPE_##a = (1 << b),
  52   foreach_virtio_if_types
  53 #undef _
  54     VIRTIO_IF_N_TYPES = (1 << 3),
  55 } virtio_if_type_t;
  56
  57 #define VIRTIO_RING_FLAG_MASK_INT 1
  58
  59 typedef struct
  60 {
  61   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
  62   clib_spinlock_t lockp;
  63   vring_desc_t *desc;
  64   vring_used_t *used;
  65   vring_avail_t *avail;
  66   u16 desc_in_use;
  67   u16 desc_next;
  68   int kick_fd;
  69   int call_fd;
  70   u8 buffer_pool_index;
  71   u16 size;
  72   u16 queue_id;
  73 #define VRING_TX_OUT_OF_ORDER 1
  74   u16 flags;
  75   u32 *buffers;
  76   u16 last_used_idx;
  77   u16 last_kick_avail_idx;
  78   u32 call_file_index;
  79   gro_flow_table_t *flow_table;
  80 } virtio_vring_t;
  81
  82 typedef union
  83 {
  84   struct
  85   {
  86     u16 domain;
  87     u8 bus;
  88     u8 slot:5;
  89     u8 function:3;
  90   };
  91   u32 as_u32;
  92 } pci_addr_t;
  93
  94 /* forward declaration */
  95 typedef struct _virtio_pci_func virtio_pci_func_t;
  96
  97 typedef struct
  98 {
  99   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 100   u64 features;
 101   u32 flags;
 102   u32 per_interface_next_index;
 103   u16 num_rxqs;
 104   u16 num_txqs;
 105   virtio_vring_t *rxq_vrings;
 106   virtio_vring_t *txq_vrings;
 107   int gso_enabled;
 108   int csum_offload_enabled;
 109   union
 110   {
 111     int *tap_fds;
 112     struct
 113     {
 114       u32 pci_dev_handle;
 115       u32 msix_enabled;
 116     };
 117   };
 118   u16 virtio_net_hdr_sz;
 119   virtio_if_type_t type;
 120
 121   u32 hw_if_index;
 122   u32 sw_if_index;
 123
 124     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 125   int packet_coalesce;
 126   u32 dev_instance;
 127   u32 numa_node;
 128   u64 remote_features;
 129
 130   /* error */
 131   clib_error_t *error;
 132   union
 133   {
 134     struct
 135     {
 136       u32 mac_addr32;
 137       u16 mac_addr16;
 138     };
 139     u8 mac_addr[6];
 140   };
 141   union
 142   {
 143     struct                      /* tun/tap interface */
 144     {
 145       ip6_address_t host_ip6_addr;
 146       int *vhost_fds;
 147       u8 *host_if_name;
 148       u8 *net_ns;
 149       u8 *host_bridge;
 150       u8 host_mac_addr[6];
 151       u32 id;
 152       u32 host_mtu_size;
 153       u32 tap_flags;
 154       int ifindex;
 155       ip4_address_t host_ip4_addr;
 156       u8 host_ip4_prefix_len;
 157       u8 host_ip6_prefix_len;
 158     };
 159     struct                      /* native virtio */
 160     {
 161       void *bar;
 162       virtio_vring_t *cxq_vring;
 163       pci_addr_t pci_addr;
 164       u32 bar_id;
 165       u32 notify_off_multiplier;
 166       u32 is_modern;
 167       u16 common_offset;
 168       u16 notify_offset;
 169       u16 device_offset;
 170       u16 isr_offset;
 171       u16 max_queue_pairs;
 172       u16 msix_table_size;
 173       u8 support_int_mode;      /* support interrupt mode */
 174       u8 status;
 175     };
 176   };
 177   const virtio_pci_func_t *virtio_pci_func;
 178 } virtio_if_t;
 179
 180 typedef struct
 181 {
 182   /* logging */
 183   vlib_log_class_t log_default;
 184
 185   virtio_if_t *interfaces;
 186 } virtio_main_t;
 187
 188 extern virtio_main_t virtio_main;
 189 extern vnet_device_class_t virtio_device_class;
 190 extern vlib_node_registration_t virtio_input_node;
 191
 192 clib_error_t *virtio_vring_init (vlib_main_t * vm, virtio_if_t * vif, u16 idx,
 193                                  u16 sz);
 194 clib_error_t *virtio_vring_free_rx (vlib_main_t * vm, virtio_if_t * vif,
 195                                     u32 idx);
 196 clib_error_t *virtio_vring_free_tx (vlib_main_t * vm, virtio_if_t * vif,
 197                                     u32 idx);
 198 void virtio_vring_set_numa_node (vlib_main_t * vm, virtio_if_t * vif,
 199                                  u32 idx);
 200 extern void virtio_free_used_desc (vlib_main_t * vm, virtio_vring_t * vring);
 201 extern void virtio_free_rx_buffers (vlib_main_t * vm, virtio_vring_t * vring);
 202 extern void virtio_set_net_hdr_size (virtio_if_t * vif);
 203 extern void virtio_show (vlib_main_t * vm, u32 * hw_if_indices, u8 show_descr,
 204                          u32 type);
 205 extern void virtio_set_packet_coalesce (virtio_if_t * vif);
 206 extern void virtio_pci_legacy_notify_queue (vlib_main_t * vm,
 207                                             virtio_if_t * vif, u16 queue_id);
 208 extern void virtio_pci_modern_notify_queue (vlib_main_t * vm,
 209                                             virtio_if_t * vif, u16 queue_id);
 210 format_function_t format_virtio_device_name;
 211 format_function_t format_virtio_log_name;
 212
 213 static_always_inline void
 214 virtio_kick (vlib_main_t * vm, virtio_vring_t * vring, virtio_if_t * vif)
 215 {
 216   if (vif->type == VIRTIO_IF_TYPE_PCI)
 217     {
 218       if (vif->is_modern)
 219         virtio_pci_modern_notify_queue (vm, vif, vring->queue_id);
 220       else
 221         virtio_pci_legacy_notify_queue (vm, vif, vring->queue_id);
 222     }
 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 #define virtio_log_debug(vif, f, ...)                           \
 234 {                                                               \
 235   vlib_log(VLIB_LOG_LEVEL_DEBUG, virtio_main.log_default,       \
 236            "%U: " f, format_virtio_log_name, vif,               \
 237            ##__VA_ARGS__);                                      \
 238 };
 239
 240 #define virtio_log_warning(vif, f, ...)                         \
 241 {                                                               \
 242   vlib_log(VLIB_LOG_LEVEL_WARNING, virtio_main.log_default,     \
 243            "%U: " f, format_virtio_log_name, vif,               \
 244            ##__VA_ARGS__);                                      \
 245 };
 246
 247 #define virtio_log_error(vif, f, ...)                           \
 248 {                                                               \
 249   vlib_log(VLIB_LOG_LEVEL_ERR, virtio_main.log_default,         \
 250            "%U: " f, format_virtio_log_name, vif,               \
 251            ##__VA_ARGS__);                                      \
 252 };
 253
 254 #endif /* _VNET_DEVICES_VIRTIO_VIRTIO_H_ */
 255
 256 /*
 257  * fd.io coding-style-patch-verification: ON
 258  *
 259  * Local Variables:
 260  * eval: (c-set-style "gnu")
 261  * End:
 262  */