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