vnet/vnet/devices/virtio/vhost-user.h

   1 /*
   2  * Copyright (c) 2015 Cisco and/or its affiliates.
   3  * Licensed under the Apache License, Version 2.0 (the "License");
   4  * you may not use this file except in compliance with the License.
   5  * You may obtain a copy of the License at:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   9  * Unless required by applicable law or agreed to in writing, software
  10  * distributed under the License is distributed on an "AS IS" BASIS,
  11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12  * See the License for the specific language governing permissions and
  13  * limitations under the License.
  14  */
  15 #ifndef __VIRTIO_VHOST_USER_H__
  16 #define __VIRTIO_VHOST_USER_H__
  17 /* vhost-user data structures */
  18
  19 #define VHOST_MEMORY_MAX_NREGIONS       8
  20 #define VHOST_USER_MSG_HDR_SZ           12
  21 #define VHOST_VRING_MAX_SIZE            32768
  22 #define VHOST_VRING_MAX_N               16      //8TX + 8RX
  23 #define VHOST_VRING_IDX_RX(qid)         (2*qid)
  24 #define VHOST_VRING_IDX_TX(qid)         (2*qid + 1)
  25
  26 #define VIRTQ_DESC_F_NEXT               1
  27 #define VIRTQ_DESC_F_INDIRECT           4
  28 #define VHOST_USER_REPLY_MASK       (0x1 << 2)
  29
  30 #define VHOST_USER_PROTOCOL_F_MQ   0
  31 #define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1
  32 #define VHOST_VRING_F_LOG 0
  33
  34 #define VHOST_USER_F_PROTOCOL_FEATURES  30
  35 #if DPDK == 0
  36 #define RTE_VERSION_NUM(a,b,c,d) 1
  37 #define RTE_VERSION 0
  38 #endif
  39 #define VHOST_USER_PROTOCOL_FEATURES   ((1ULL << VHOST_USER_PROTOCOL_F_MQ) |    \
  40                                         (1ULL << VHOST_USER_PROTOCOL_F_LOG_SHMFD))
  41
  42 /* If multiqueue is provided by host, then we suppport it. */
  43 #define VIRTIO_NET_CTRL_MQ   4
  44 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET        0
  45 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN        1
  46 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX        0x8000
  47
  48 #define VRING_USED_F_NO_NOTIFY  1
  49
  50 #define foreach_virtio_net_feature      \
  51  _ (VIRTIO_NET_F_MRG_RXBUF, 15)         \
  52  _ (VIRTIO_NET_F_CTRL_VQ, 17)           \
  53  _ (VIRTIO_NET_F_GUEST_ANNOUNCE, 21)    \
  54  _ (VIRTIO_NET_F_MQ, 22)                \
  55  _ (VHOST_F_LOG_ALL, 26)                \
  56  _ (VIRTIO_F_ANY_LAYOUT, 27)            \
  57  _ (VIRTIO_F_INDIRECT_DESC, 28)         \
  58  _ (VHOST_USER_F_PROTOCOL_FEATURES, 30) \
  59  _ (VIRTIO_F_VERSION_1, 32)
  60
  61
  62 typedef enum
  63 {
  64 #define _(f,n) FEAT_##f = (n),
  65   foreach_virtio_net_feature
  66 #undef _
  67 } virtio_net_feature_t;
  68
  69 int vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
  70                           const char *sock_filename, u8 is_server,
  71                           u32 * sw_if_index, u64 feature_mask,
  72                           u8 renumber, u32 custom_dev_instance, u8 * hwaddr);
  73 int vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
  74                           const char *sock_filename, u8 is_server,
  75                           u32 sw_if_index, u64 feature_mask,
  76                           u8 renumber, u32 custom_dev_instance);
  77 int vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm,
  78                           u32 sw_if_index);
  79
  80 /* *INDENT-OFF* */
  81 typedef struct vhost_user_memory_region
  82 {
  83   u64 guest_phys_addr;
  84   u64 memory_size;
  85   u64 userspace_addr;
  86   u64 mmap_offset;
  87 } __attribute ((packed)) vhost_user_memory_region_t;
  88
  89 typedef struct vhost_user_memory
  90 {
  91   u32 nregions;
  92   u32 padding;
  93   vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
  94 } __attribute ((packed)) vhost_user_memory_t;
  95
  96 typedef struct
  97 {
  98   u32 index, num;
  99 } __attribute ((packed)) vhost_vring_state_t;
 100
 101 typedef struct
 102 {
 103   u32 index, flags;
 104   u64 desc_user_addr, used_user_addr, avail_user_addr, log_guest_addr;
 105 } __attribute ((packed)) vhost_vring_addr_t;
 106
 107 typedef struct vhost_user_log
 108 {
 109   u64 size;
 110   u64 offset;
 111 } __attribute ((packed)) vhost_user_log_t;
 112
 113 typedef enum vhost_user_req
 114 {
 115   VHOST_USER_NONE = 0,
 116   VHOST_USER_GET_FEATURES = 1,
 117   VHOST_USER_SET_FEATURES = 2,
 118   VHOST_USER_SET_OWNER = 3,
 119   VHOST_USER_RESET_OWNER = 4,
 120   VHOST_USER_SET_MEM_TABLE = 5,
 121   VHOST_USER_SET_LOG_BASE = 6,
 122   VHOST_USER_SET_LOG_FD = 7,
 123   VHOST_USER_SET_VRING_NUM = 8,
 124   VHOST_USER_SET_VRING_ADDR = 9,
 125   VHOST_USER_SET_VRING_BASE = 10,
 126   VHOST_USER_GET_VRING_BASE = 11,
 127   VHOST_USER_SET_VRING_KICK = 12,
 128   VHOST_USER_SET_VRING_CALL = 13,
 129   VHOST_USER_SET_VRING_ERR = 14,
 130   VHOST_USER_GET_PROTOCOL_FEATURES = 15,
 131   VHOST_USER_SET_PROTOCOL_FEATURES = 16,
 132   VHOST_USER_GET_QUEUE_NUM = 17,
 133   VHOST_USER_SET_VRING_ENABLE = 18,
 134   VHOST_USER_MAX
 135 } vhost_user_req_t;
 136
 137 // vring_desc I/O buffer descriptor
 138 typedef struct
 139 {
 140   uint64_t addr;  // packet data buffer address
 141   uint32_t len;   // packet data buffer size
 142   uint16_t flags; // (see below)
 143   uint16_t next;  // optional index next descriptor in chain
 144 } __attribute ((packed)) vring_desc_t;
 145
 146 typedef struct
 147 {
 148   uint16_t flags;
 149   volatile uint16_t idx;
 150   uint16_t ring[VHOST_VRING_MAX_SIZE];
 151 } __attribute ((packed)) vring_avail_t;
 152
 153 typedef struct
 154 {
 155   uint16_t flags;
 156   uint16_t idx;
 157   struct /* vring_used_elem */
 158     {
 159       uint32_t id;
 160       uint32_t len;
 161     } ring[VHOST_VRING_MAX_SIZE];
 162 } __attribute ((packed)) vring_used_t;
 163
 164 typedef struct
 165 {
 166   u8 flags;
 167   u8 gso_type;
 168   u16 hdr_len;
 169   u16 gso_size;
 170   u16 csum_start;
 171   u16 csum_offset;
 172 } __attribute ((packed)) virtio_net_hdr_t;
 173
 174 typedef struct  {
 175   virtio_net_hdr_t hdr;
 176   u16 num_buffers;
 177 } __attribute ((packed)) virtio_net_hdr_mrg_rxbuf_t;
 178
 179 typedef struct vhost_user_msg {
 180   vhost_user_req_t request;
 181   u32 flags;
 182   u32 size;
 183   union
 184     {
 185       u64 u64;
 186       vhost_vring_state_t state;
 187       vhost_vring_addr_t addr;
 188       vhost_user_memory_t memory;
 189       vhost_user_log_t log;
 190     };
 191 } __attribute ((packed)) vhost_user_msg_t;
 192 /* *INDENT-ON* */
 193
 194 typedef struct
 195 {
 196   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 197   u16 qsz;
 198   u16 last_avail_idx;
 199   u16 last_used_idx;
 200   u16 n_since_last_int;
 201   vring_desc_t *desc;
 202   vring_avail_t *avail;
 203   vring_used_t *used;
 204   f64 int_deadline;
 205   u8 started;
 206   u8 enabled;
 207   u8 log_used;
 208   //Put non-runtime in a different cache line
 209     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 210   int callfd;
 211   int kickfd;
 212   int errfd;
 213   u32 callfd_idx;
 214   u32 kickfd_idx;
 215   u64 log_guest_addr;
 216 } vhost_user_vring_t;
 217
 218 typedef struct
 219 {
 220   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 221   u32 is_up;
 222   u32 admin_up;
 223   u32 unix_fd;
 224   u32 unix_file_index;
 225   u32 client_fd;
 226   char sock_filename[256];
 227   int sock_errno;
 228   u8 sock_is_server;
 229   u32 hw_if_index, sw_if_index;
 230   u8 active;
 231
 232   //Feature negotiation
 233   u64 features;
 234   u64 feature_mask;
 235   u64 protocol_features;
 236
 237   //Memory region information
 238   u32 nregions;
 239   vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
 240   void *region_mmap_addr[VHOST_MEMORY_MAX_NREGIONS];
 241   u64 region_guest_addr_lo[VHOST_MEMORY_MAX_NREGIONS];
 242   u64 region_guest_addr_hi[VHOST_MEMORY_MAX_NREGIONS];
 243   u32 region_mmap_fd[VHOST_MEMORY_MAX_NREGIONS];
 244
 245   //Virtual rings
 246   vhost_user_vring_t vrings[VHOST_VRING_MAX_N];
 247   volatile u32 *vring_locks[VHOST_VRING_MAX_N];
 248
 249   int virtio_net_hdr_sz;
 250   int is_any_layout;
 251
 252   void *log_base_addr;
 253   u64 log_size;
 254
 255   /* Whether to use spinlock or per_cpu_tx_qid assignment */
 256   u8 use_tx_spinlock;
 257   u16 *per_cpu_tx_qid;
 258
 259   /* Vector of workers for this interface */
 260   u32 *workers;
 261 } vhost_user_intf_t;
 262
 263 typedef struct
 264 {
 265   u16 vhost_iface_index;
 266   u16 qid;
 267 } vhost_iface_and_queue_t;
 268
 269 typedef struct
 270 {
 271   vhost_iface_and_queue_t *rx_queues;
 272 } vhost_cpu_t;
 273
 274 typedef struct
 275 {
 276   u32 **rx_buffers;
 277   u32 mtu_bytes;
 278   vhost_user_intf_t *vhost_user_interfaces;
 279   u32 *vhost_user_inactive_interfaces_index;
 280   uword *vhost_user_interface_index_by_listener_fd;
 281   uword *vhost_user_interface_index_by_sock_fd;
 282   uword *vhost_user_interface_index_by_sw_if_index;
 283   u32 *show_dev_instance_by_real_dev_instance;
 284   u32 coalesce_frames;
 285   f64 coalesce_time;
 286   int dont_dump_vhost_user_memory;
 287
 288   /* first cpu index */
 289   u32 input_cpu_first_index;
 290
 291   /* total cpu count */
 292   u32 input_cpu_count;
 293
 294   /** Per-CPU data for vhost-user */
 295   vhost_cpu_t *cpus;
 296 } vhost_user_main_t;
 297
 298 typedef struct
 299 {
 300   u8 if_name[64];
 301   u32 sw_if_index;
 302   u32 virtio_net_hdr_sz;
 303   u64 features;
 304   u8 is_server;
 305   u8 sock_filename[256];
 306   u32 num_regions;
 307   int sock_errno;
 308 } vhost_user_intf_details_t;
 309
 310 int vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
 311                          vhost_user_intf_details_t ** out_vuids);
 312
 313 // CLI commands to be used from dpdk
 314 clib_error_t *vhost_user_connect_command_fn (vlib_main_t * vm,
 315                                              unformat_input_t * input,
 316                                              vlib_cli_command_t * cmd);
 317 clib_error_t *vhost_user_delete_command_fn (vlib_main_t * vm,
 318                                             unformat_input_t * input,
 319                                             vlib_cli_command_t * cmd);
 320 clib_error_t *show_vhost_user_command_fn (vlib_main_t * vm,
 321                                           unformat_input_t * input,
 322                                           vlib_cli_command_t * cmd);
 323
 324 #endif
 325
 326 /*
 327  * fd.io coding-style-patch-verification: ON
 328  *
 329  * Local Variables:
 330  * eval: (c-set-style "gnu")
 331  * End:
 332  */