src/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 #define VHOST_USER_PROTOCOL_FEATURES   ((1ULL << VHOST_USER_PROTOCOL_F_MQ) |    \
  36                                         (1ULL << VHOST_USER_PROTOCOL_F_LOG_SHMFD))
  37
  38 /* If multiqueue is provided by host, then we suppport it. */
  39 #define VIRTIO_NET_CTRL_MQ   4
  40 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET        0
  41 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN        1
  42 #define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX        0x8000
  43
  44 #define VRING_USED_F_NO_NOTIFY  1
  45 #define VRING_AVAIL_F_NO_INTERRUPT 1
  46
  47 #define foreach_virtio_net_feature      \
  48  _ (VIRTIO_NET_F_MRG_RXBUF, 15)         \
  49  _ (VIRTIO_NET_F_CTRL_VQ, 17)           \
  50  _ (VIRTIO_NET_F_GUEST_ANNOUNCE, 21)    \
  51  _ (VIRTIO_NET_F_MQ, 22)                \
  52  _ (VHOST_F_LOG_ALL, 26)                \
  53  _ (VIRTIO_F_ANY_LAYOUT, 27)            \
  54  _ (VIRTIO_F_INDIRECT_DESC, 28)         \
  55  _ (VHOST_USER_F_PROTOCOL_FEATURES, 30) \
  56  _ (VIRTIO_F_VERSION_1, 32)
  57
  58
  59 typedef enum
  60 {
  61 #define _(f,n) FEAT_##f = (n),
  62   foreach_virtio_net_feature
  63 #undef _
  64 } virtio_net_feature_t;
  65
  66 int vhost_user_create_if (vnet_main_t * vnm, vlib_main_t * vm,
  67                           const char *sock_filename, u8 is_server,
  68                           u32 * sw_if_index, u64 feature_mask,
  69                           u8 renumber, u32 custom_dev_instance, u8 * hwaddr,
  70                           u8 operation_mode);
  71 int vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
  72                           const char *sock_filename, u8 is_server,
  73                           u32 sw_if_index, u64 feature_mask,
  74                           u8 renumber, u32 custom_dev_instance,
  75                           u8 operation_mode);
  76 int vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm,
  77                           u32 sw_if_index);
  78
  79 /* *INDENT-OFF* */
  80 typedef struct vhost_user_memory_region
  81 {
  82   u64 guest_phys_addr;
  83   u64 memory_size;
  84   u64 userspace_addr;
  85   u64 mmap_offset;
  86 } __attribute ((packed)) vhost_user_memory_region_t;
  87
  88 typedef struct vhost_user_memory
  89 {
  90   u32 nregions;
  91   u32 padding;
  92   vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
  93 } __attribute ((packed)) vhost_user_memory_t;
  94
  95 typedef struct
  96 {
  97   u32 index, num;
  98 } __attribute ((packed)) vhost_vring_state_t;
  99
 100 typedef struct
 101 {
 102   u32 index, flags;
 103   u64 desc_user_addr, used_user_addr, avail_user_addr, log_guest_addr;
 104 } __attribute ((packed)) vhost_vring_addr_t;
 105
 106 typedef struct vhost_user_log
 107 {
 108   u64 size;
 109   u64 offset;
 110 } __attribute ((packed)) vhost_user_log_t;
 111
 112 typedef enum vhost_user_req
 113 {
 114   VHOST_USER_NONE = 0,
 115   VHOST_USER_GET_FEATURES = 1,
 116   VHOST_USER_SET_FEATURES = 2,
 117   VHOST_USER_SET_OWNER = 3,
 118   VHOST_USER_RESET_OWNER = 4,
 119   VHOST_USER_SET_MEM_TABLE = 5,
 120   VHOST_USER_SET_LOG_BASE = 6,
 121   VHOST_USER_SET_LOG_FD = 7,
 122   VHOST_USER_SET_VRING_NUM = 8,
 123   VHOST_USER_SET_VRING_ADDR = 9,
 124   VHOST_USER_SET_VRING_BASE = 10,
 125   VHOST_USER_GET_VRING_BASE = 11,
 126   VHOST_USER_SET_VRING_KICK = 12,
 127   VHOST_USER_SET_VRING_CALL = 13,
 128   VHOST_USER_SET_VRING_ERR = 14,
 129   VHOST_USER_GET_PROTOCOL_FEATURES = 15,
 130   VHOST_USER_SET_PROTOCOL_FEATURES = 16,
 131   VHOST_USER_GET_QUEUE_NUM = 17,
 132   VHOST_USER_SET_VRING_ENABLE = 18,
 133   VHOST_USER_MAX
 134 } vhost_user_req_t;
 135
 136 // vring_desc I/O buffer descriptor
 137 typedef struct
 138 {
 139   uint64_t addr;  // packet data buffer address
 140   uint32_t len;   // packet data buffer size
 141   uint16_t flags; // (see below)
 142   uint16_t next;  // optional index next descriptor in chain
 143 } __attribute ((packed)) vring_desc_t;
 144
 145 typedef struct
 146 {
 147   uint16_t flags;
 148   volatile uint16_t idx;
 149   uint16_t ring[VHOST_VRING_MAX_SIZE];
 150 } __attribute ((packed)) vring_avail_t;
 151
 152 typedef struct
 153 {
 154   uint16_t flags;
 155   uint16_t idx;
 156   struct /* vring_used_elem */
 157     {
 158       uint32_t id;
 159       uint32_t len;
 160     } ring[VHOST_VRING_MAX_SIZE];
 161 } __attribute ((packed)) vring_used_t;
 162
 163 typedef struct
 164 {
 165   u8 flags;
 166   u8 gso_type;
 167   u16 hdr_len;
 168   u16 gso_size;
 169   u16 csum_start;
 170   u16 csum_offset;
 171 } __attribute ((packed)) virtio_net_hdr_t;
 172
 173 typedef struct  {
 174   virtio_net_hdr_t hdr;
 175   u16 num_buffers;
 176 } __attribute ((packed)) virtio_net_hdr_mrg_rxbuf_t;
 177
 178 typedef struct vhost_user_msg {
 179   vhost_user_req_t request;
 180   u32 flags;
 181   u32 size;
 182   union
 183     {
 184       u64 u64;
 185       vhost_vring_state_t state;
 186       vhost_vring_addr_t addr;
 187       vhost_user_memory_t memory;
 188       vhost_user_log_t log;
 189     };
 190 } __attribute ((packed)) vhost_user_msg_t;
 191 /* *INDENT-ON* */
 192
 193 typedef struct
 194 {
 195   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 196   u16 qsz;
 197   u16 last_avail_idx;
 198   u16 last_used_idx;
 199   u16 n_since_last_int;
 200   vring_desc_t *desc;
 201   vring_avail_t *avail;
 202   vring_used_t *used;
 203   f64 int_deadline;
 204   u8 started;
 205   u8 enabled;
 206   u8 log_used;
 207   //Put non-runtime in a different cache line
 208     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 209   int errfd;
 210   u32 callfd_idx;
 211   u32 kickfd_idx;
 212   u64 log_guest_addr;
 213 } vhost_user_vring_t;
 214
 215 #define VHOST_USER_POLLING_MODE   0
 216 #define VHOST_USER_INTERRUPT_MODE 1
 217 #define VHOST_USER_ADAPTIVE_MODE  2
 218
 219 typedef struct
 220 {
 221   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 222   u32 is_up;
 223   u32 admin_up;
 224   u32 unix_server_index;
 225   u32 unix_file_index;
 226   char sock_filename[256];
 227   int sock_errno;
 228   u32 hw_if_index, sw_if_index;
 229
 230   //Feature negotiation
 231   u64 features;
 232   u64 feature_mask;
 233   u64 protocol_features;
 234
 235   //Memory region information
 236   u32 nregions;
 237   vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
 238   void *region_mmap_addr[VHOST_MEMORY_MAX_NREGIONS];
 239   u64 region_guest_addr_lo[VHOST_MEMORY_MAX_NREGIONS];
 240   u64 region_guest_addr_hi[VHOST_MEMORY_MAX_NREGIONS];
 241   u32 region_mmap_fd[VHOST_MEMORY_MAX_NREGIONS];
 242
 243   //Virtual rings
 244   vhost_user_vring_t vrings[VHOST_VRING_MAX_N];
 245   volatile u32 *vring_locks[VHOST_VRING_MAX_N];
 246
 247   int virtio_net_hdr_sz;
 248   int is_any_layout;
 249
 250   void *log_base_addr;
 251   u64 log_size;
 252
 253   /* Whether to use spinlock or per_cpu_tx_qid assignment */
 254   u8 use_tx_spinlock;
 255   u16 *per_cpu_tx_qid;
 256
 257   /* Vector of workers for this interface */
 258   u32 *workers;
 259
 260   u8 operation_mode;
 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   uword dst;
 272   uword src;
 273   u32 len;
 274 } vhost_copy_t;
 275
 276 typedef struct
 277 {
 278   u16 qid; /** The interface queue index (Not the virtio vring idx) */
 279   u16 device_index; /** The device index */
 280   u32 virtio_ring_flags; /** Runtime queue flags  **/
 281   u16 first_desc_len; /** Length of the first data descriptor **/
 282   virtio_net_hdr_mrg_rxbuf_t hdr; /** Virtio header **/
 283 } vhost_trace_t;
 284
 285
 286 #define VHOST_USER_RX_BUFFERS_N (2 * VLIB_FRAME_SIZE + 2)
 287 #define VHOST_USER_COPY_ARRAY_N (4 * VLIB_FRAME_SIZE)
 288
 289 typedef struct
 290 {
 291   vhost_iface_and_queue_t *rx_queues;
 292   u32 rx_buffers_len;
 293   u32 rx_buffers[VHOST_USER_RX_BUFFERS_N];
 294
 295   virtio_net_hdr_mrg_rxbuf_t tx_headers[VLIB_FRAME_SIZE];
 296   vhost_copy_t copy[VHOST_USER_COPY_ARRAY_N];
 297
 298   /* This is here so it doesn't end-up
 299    * using stack or registers. */
 300   vhost_trace_t *current_trace;
 301 } vhost_cpu_t;
 302
 303 typedef struct
 304 {
 305   u32 mtu_bytes;
 306   vhost_user_intf_t *vhost_user_interfaces;
 307   u32 *show_dev_instance_by_real_dev_instance;
 308   u32 coalesce_frames;
 309   f64 coalesce_time;
 310   int dont_dump_vhost_user_memory;
 311
 312   /** first cpu index */
 313   u32 input_cpu_first_index;
 314
 315   /** total cpu count */
 316   u32 input_cpu_count;
 317
 318   /** Per-CPU data for vhost-user */
 319   vhost_cpu_t *cpus;
 320
 321   /** Pseudo random iterator */
 322   u32 random;
 323 } vhost_user_main_t;
 324
 325 typedef struct
 326 {
 327   u8 if_name[64];
 328   u32 sw_if_index;
 329   u32 virtio_net_hdr_sz;
 330   u64 features;
 331   u8 is_server;
 332   u8 sock_filename[256];
 333   u32 num_regions;
 334   int sock_errno;
 335   u8 operation_mode;
 336 } vhost_user_intf_details_t;
 337
 338 int vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
 339                          vhost_user_intf_details_t ** out_vuids);
 340
 341 #endif
 342
 343 /*
 344  * fd.io coding-style-patch-verification: ON
 345  *
 346  * Local Variables:
 347  * eval: (c-set-style "gnu")
 348  * End:
 349  */