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   union
  68   {
  69     struct
  70     {
  71       vring_desc_t *desc;
  72       vring_used_t *used;
  73       vring_avail_t *avail;
  74     };
  75     struct
  76     {
  77       vring_packed_desc_t *packed_desc;
  78       vring_desc_event_t *driver_event;
  79       vring_desc_event_t *device_event;
  80     };
  81   };
  82   u32 *buffers;
  83   u16 size;
  84   u16 queue_id;
  85   u32 queue_index;
  86   u16 desc_in_use;
  87   u16 desc_next;
  88   u16 last_used_idx;
  89   u16 last_kick_avail_idx;
  90   union
  91   {
  92     struct
  93     {
  94       int kick_fd;
  95       int call_fd;
  96       u32 call_file_index;
  97     };
  98     struct
  99     {
 100       u16 avail_wrap_counter;
 101       u16 used_wrap_counter;
 102       u16 queue_notify_offset;
 103     };
 104   };
 105 #define VRING_TX_OUT_OF_ORDER 1
 106   u16 flags;
 107   u8 buffer_pool_index;
 108   vnet_hw_if_rx_mode mode;
 109   virtio_vring_buffering_t *buffering;
 110   gro_flow_table_t *flow_table;
 111 } virtio_vring_t;
 112
 113 typedef union
 114 {
 115   struct
 116   {
 117     u16 domain;
 118     u8 bus;
 119     u8 slot:5;
 120     u8 function:3;
 121   };
 122   u32 as_u32;
 123 } pci_addr_t;
 124
 125 /* forward declaration */
 126 typedef struct _virtio_pci_func virtio_pci_func_t;
 127
 128 typedef struct
 129 {
 130   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 131   u64 features;
 132   u32 flags;
 133   u32 per_interface_next_index;
 134   u16 num_rxqs;
 135   u16 num_txqs;
 136   virtio_vring_t *rxq_vrings;
 137   virtio_vring_t *txq_vrings;
 138   int gso_enabled;
 139   int csum_offload_enabled;
 140   union
 141   {
 142     int *tap_fds;
 143     struct
 144     {
 145       u32 pci_dev_handle;
 146       u32 msix_enabled;
 147     };
 148   };
 149   u16 virtio_net_hdr_sz;
 150   virtio_if_type_t type;
 151
 152   u32 hw_if_index;
 153   u32 sw_if_index;
 154
 155     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 156   int packet_coalesce;
 157   int packet_buffering;
 158   u32 dev_instance;
 159   u32 numa_node;
 160   u64 remote_features;
 161
 162   /* error */
 163   clib_error_t *error;
 164   union
 165   {
 166     struct
 167     {
 168       u32 mac_addr32;
 169       u16 mac_addr16;
 170     };
 171     u8 mac_addr[6];
 172   };
 173   union
 174   {
 175     struct                      /* tun/tap interface */
 176     {
 177       ip6_address_t host_ip6_addr;
 178       int *vhost_fds;
 179       u8 *host_if_name;
 180       u8 *net_ns;
 181       u8 *host_bridge;
 182       u8 host_mac_addr[6];
 183       u32 id;
 184       u32 host_mtu_size;
 185       u32 tap_flags;
 186       int ifindex;
 187       ip4_address_t host_ip4_addr;
 188       u8 host_ip4_prefix_len;
 189       u8 host_ip6_prefix_len;
 190       u8 host_carrier_up;       /* host tun/tap driver link carrier state */
 191     };
 192     struct                      /* native virtio */
 193     {
 194       void *bar;
 195       virtio_vring_t *cxq_vring;
 196       pci_addr_t pci_addr;
 197       u32 bar_id;
 198       u32 notify_off_multiplier;
 199       u32 is_modern;
 200       u16 common_offset;
 201       u16 notify_offset;
 202       u16 device_offset;
 203       u16 isr_offset;
 204       u16 max_queue_pairs;
 205       u16 msix_table_size;
 206       u8 support_int_mode;      /* support interrupt mode */
 207       u8 status;
 208     };
 209   };
 210   const virtio_pci_func_t *virtio_pci_func;
 211   int is_packed;
 212 } virtio_if_t;
 213
 214 typedef struct
 215 {
 216   u32 interrupt_queues_count;
 217   /* logging */
 218   vlib_log_class_t log_default;
 219
 220   virtio_if_t *interfaces;
 221   u16 msg_id_base;
 222 } virtio_main_t;
 223
 224 extern virtio_main_t virtio_main;
 225 extern vnet_device_class_t virtio_device_class;
 226 extern vlib_node_registration_t virtio_input_node;
 227 extern vlib_node_registration_t virtio_send_interrupt_node;
 228
 229 clib_error_t *virtio_vring_init (vlib_main_t * vm, virtio_if_t * vif, u16 idx,
 230                                  u16 sz);
 231 clib_error_t *virtio_vring_free_rx (vlib_main_t * vm, virtio_if_t * vif,
 232                                     u32 idx);
 233 clib_error_t *virtio_vring_free_tx (vlib_main_t * vm, virtio_if_t * vif,
 234                                     u32 idx);
 235 void virtio_vring_set_rx_queues (vlib_main_t *vm, virtio_if_t *vif);
 236 extern void virtio_free_buffers (vlib_main_t * vm, virtio_vring_t * vring);
 237 extern void virtio_set_net_hdr_size (virtio_if_t * vif);
 238 extern void virtio_show (vlib_main_t *vm, u32 *hw_if_indices, u8 show_descr,
 239                          virtio_if_type_t type);
 240 extern void virtio_set_packet_coalesce (virtio_if_t * vif);
 241 clib_error_t *virtio_set_packet_buffering (virtio_if_t * vif, u16 size);
 242 extern void virtio_pci_legacy_notify_queue (vlib_main_t * vm,
 243                                             virtio_if_t * vif, u16 queue_id,
 244                                             u16 queue_notify_offset);
 245 extern void virtio_pci_modern_notify_queue (vlib_main_t * vm,
 246                                             virtio_if_t * vif, u16 queue_id,
 247                                             u16 queue_notify_offset);
 248 format_function_t format_virtio_device_name;
 249 format_function_t format_virtio_log_name;
 250
 251 static_always_inline void
 252 virtio_kick (vlib_main_t * vm, virtio_vring_t * vring, virtio_if_t * vif)
 253 {
 254   if (vif->type == VIRTIO_IF_TYPE_PCI)
 255     {
 256       if (vif->is_modern)
 257         virtio_pci_modern_notify_queue (vm, vif, vring->queue_id,
 258                                         vring->queue_notify_offset);
 259       else
 260         virtio_pci_legacy_notify_queue (vm, vif, vring->queue_id,
 261                                         vring->queue_notify_offset);
 262     }
 263   else
 264     {
 265       u64 x = 1;
 266       int __clib_unused r;
 267
 268       r = write (vring->kick_fd, &x, sizeof (x));
 269       vring->last_kick_avail_idx = vring->avail->idx;
 270     }
 271 }
 272
 273 #define virtio_log_debug(vif, f, ...)                           \
 274 {                                                               \
 275   vlib_log(VLIB_LOG_LEVEL_DEBUG, virtio_main.log_default,       \
 276            "%U: " f, format_virtio_log_name, vif,               \
 277            ##__VA_ARGS__);                                      \
 278 };
 279
 280 #define virtio_log_warning(vif, f, ...)                         \
 281 {                                                               \
 282   vlib_log(VLIB_LOG_LEVEL_WARNING, virtio_main.log_default,     \
 283            "%U: " f, format_virtio_log_name, vif,               \
 284            ##__VA_ARGS__);                                      \
 285 };
 286
 287 #define virtio_log_error(vif, f, ...)                           \
 288 {                                                               \
 289   vlib_log(VLIB_LOG_LEVEL_ERR, virtio_main.log_default,         \
 290            "%U: " f, format_virtio_log_name, vif,               \
 291            ##__VA_ARGS__);                                      \
 292 };
 293
 294 #endif /* _VNET_DEVICES_VIRTIO_VIRTIO_H_ */
 295
 296 /*
 297  * fd.io coding-style-patch-verification: ON
 298  *
 299  * Local Variables:
 300  * eval: (c-set-style "gnu")
 301  * End:
 302  */