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 int vhost_user_modify_if (vnet_main_t * vnm, vlib_main_t * vm,
  71                           const char *sock_filename, u8 is_server,
  72                           u32 sw_if_index, u64 feature_mask,
  73                           u8 renumber, u32 custom_dev_instance);
  74 int vhost_user_delete_if (vnet_main_t * vnm, vlib_main_t * vm,
  75                           u32 sw_if_index);
  76
  77 /* *INDENT-OFF* */
  78 typedef struct vhost_user_memory_region
  79 {
  80   u64 guest_phys_addr;
  81   u64 memory_size;
  82   u64 userspace_addr;
  83   u64 mmap_offset;
  84 } __attribute ((packed)) vhost_user_memory_region_t;
  85
  86 typedef struct vhost_user_memory
  87 {
  88   u32 nregions;
  89   u32 padding;
  90   vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
  91 } __attribute ((packed)) vhost_user_memory_t;
  92
  93 typedef struct
  94 {
  95   u32 index, num;
  96 } __attribute ((packed)) vhost_vring_state_t;
  97
  98 typedef struct
  99 {
 100   u32 index, flags;
 101   u64 desc_user_addr, used_user_addr, avail_user_addr, log_guest_addr;
 102 } __attribute ((packed)) vhost_vring_addr_t;
 103
 104 typedef struct vhost_user_log
 105 {
 106   u64 size;
 107   u64 offset;
 108 } __attribute ((packed)) vhost_user_log_t;
 109
 110 typedef enum vhost_user_req
 111 {
 112   VHOST_USER_NONE = 0,
 113   VHOST_USER_GET_FEATURES = 1,
 114   VHOST_USER_SET_FEATURES = 2,
 115   VHOST_USER_SET_OWNER = 3,
 116   VHOST_USER_RESET_OWNER = 4,
 117   VHOST_USER_SET_MEM_TABLE = 5,
 118   VHOST_USER_SET_LOG_BASE = 6,
 119   VHOST_USER_SET_LOG_FD = 7,
 120   VHOST_USER_SET_VRING_NUM = 8,
 121   VHOST_USER_SET_VRING_ADDR = 9,
 122   VHOST_USER_SET_VRING_BASE = 10,
 123   VHOST_USER_GET_VRING_BASE = 11,
 124   VHOST_USER_SET_VRING_KICK = 12,
 125   VHOST_USER_SET_VRING_CALL = 13,
 126   VHOST_USER_SET_VRING_ERR = 14,
 127   VHOST_USER_GET_PROTOCOL_FEATURES = 15,
 128   VHOST_USER_SET_PROTOCOL_FEATURES = 16,
 129   VHOST_USER_GET_QUEUE_NUM = 17,
 130   VHOST_USER_SET_VRING_ENABLE = 18,
 131   VHOST_USER_MAX
 132 } vhost_user_req_t;
 133
 134 // vring_desc I/O buffer descriptor
 135 typedef struct
 136 {
 137   uint64_t addr;  // packet data buffer address
 138   uint32_t len;   // packet data buffer size
 139   uint16_t flags; // (see below)
 140   uint16_t next;  // optional index next descriptor in chain
 141 } __attribute ((packed)) vring_desc_t;
 142
 143 typedef struct
 144 {
 145   uint16_t flags;
 146   volatile uint16_t idx;
 147   uint16_t ring[VHOST_VRING_MAX_SIZE];
 148 } __attribute ((packed)) vring_avail_t;
 149
 150 typedef struct
 151 {
 152   uint16_t flags;
 153   uint16_t idx;
 154   struct /* vring_used_elem */
 155     {
 156       uint32_t id;
 157       uint32_t len;
 158     } ring[VHOST_VRING_MAX_SIZE];
 159 } __attribute ((packed)) vring_used_t;
 160
 161 typedef struct
 162 {
 163   u8 flags;
 164   u8 gso_type;
 165   u16 hdr_len;
 166   u16 gso_size;
 167   u16 csum_start;
 168   u16 csum_offset;
 169 } __attribute ((packed)) virtio_net_hdr_t;
 170
 171 typedef struct  {
 172   virtio_net_hdr_t hdr;
 173   u16 num_buffers;
 174 } __attribute ((packed)) virtio_net_hdr_mrg_rxbuf_t;
 175
 176 typedef struct vhost_user_msg {
 177   vhost_user_req_t request;
 178   u32 flags;
 179   u32 size;
 180   union
 181     {
 182       u64 u64;
 183       vhost_vring_state_t state;
 184       vhost_vring_addr_t addr;
 185       vhost_user_memory_t memory;
 186       vhost_user_log_t log;
 187     };
 188 } __attribute ((packed)) vhost_user_msg_t;
 189 /* *INDENT-ON* */
 190
 191 typedef struct
 192 {
 193   CLIB_CACHE_LINE_ALIGN_MARK (cacheline0);
 194   u16 qsz_mask;
 195   u16 last_avail_idx;
 196   u16 last_used_idx;
 197   u16 n_since_last_int;
 198   vring_desc_t *desc;
 199   vring_avail_t *avail;
 200   vring_used_t *used;
 201   f64 int_deadline;
 202   u8 started;
 203   u8 enabled;
 204   u8 log_used;
 205   //Put non-runtime in a different cache line
 206     CLIB_CACHE_LINE_ALIGN_MARK (cacheline1);
 207   int errfd;
 208   u32 callfd_idx;
 209   u32 kickfd_idx;
 210   u64 log_guest_addr;
 211
 212   /* The rx queue policy (interrupt/adaptive/polling) for this queue */
 213   u32 mode;
 214 } vhost_user_vring_t;
 215
 216 #define VHOST_USER_EVENT_START_TIMER 1
 217 #define VHOST_USER_EVENT_STOP_TIMER  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   uword if_index;
 229   u32 hw_if_index, sw_if_index;
 230
 231   //Feature negotiation
 232   u64 features;
 233   u64 feature_mask;
 234   u64 protocol_features;
 235
 236   //Memory region information
 237   u32 nregions;
 238   vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
 239   void *region_mmap_addr[VHOST_MEMORY_MAX_NREGIONS];
 240   u64 region_guest_addr_lo[VHOST_MEMORY_MAX_NREGIONS];
 241   u64 region_guest_addr_hi[VHOST_MEMORY_MAX_NREGIONS];
 242   u32 region_mmap_fd[VHOST_MEMORY_MAX_NREGIONS];
 243
 244   //Virtual rings
 245   vhost_user_vring_t vrings[VHOST_VRING_MAX_N];
 246   volatile u32 *vring_locks[VHOST_VRING_MAX_N];
 247
 248   int virtio_net_hdr_sz;
 249   int is_any_layout;
 250
 251   void *log_base_addr;
 252   u64 log_size;
 253
 254   /* Whether to use spinlock or per_cpu_tx_qid assignment */
 255   u8 use_tx_spinlock;
 256   u16 *per_cpu_tx_qid;
 257
 258   /* Vector of active rx queues for this interface */
 259   u16 *rx_queues;
 260 } vhost_user_intf_t;
 261
 262 typedef struct
 263 {
 264   uword dst;
 265   uword src;
 266   u32 len;
 267 } vhost_copy_t;
 268
 269 typedef struct
 270 {
 271   u16 qid; /** The interface queue index (Not the virtio vring idx) */
 272   u16 device_index; /** The device index */
 273   u32 virtio_ring_flags; /** Runtime queue flags  **/
 274   u16 first_desc_len; /** Length of the first data descriptor **/
 275   virtio_net_hdr_mrg_rxbuf_t hdr; /** Virtio header **/
 276 } vhost_trace_t;
 277
 278
 279 #define VHOST_USER_RX_BUFFERS_N (2 * VLIB_FRAME_SIZE + 2)
 280 #define VHOST_USER_COPY_ARRAY_N (4 * VLIB_FRAME_SIZE)
 281
 282 typedef struct
 283 {
 284   u32 rx_buffers_len;
 285   u32 rx_buffers[VHOST_USER_RX_BUFFERS_N];
 286
 287   virtio_net_hdr_mrg_rxbuf_t tx_headers[VLIB_FRAME_SIZE];
 288   vhost_copy_t copy[VHOST_USER_COPY_ARRAY_N];
 289
 290   /* This is here so it doesn't end-up
 291    * using stack or registers. */
 292   vhost_trace_t *current_trace;
 293 } vhost_cpu_t;
 294
 295 typedef struct
 296 {
 297   mhash_t if_index_by_sock_name;
 298   u32 mtu_bytes;
 299   vhost_user_intf_t *vhost_user_interfaces;
 300   u32 *show_dev_instance_by_real_dev_instance;
 301   u32 coalesce_frames;
 302   f64 coalesce_time;
 303   int dont_dump_vhost_user_memory;
 304
 305   /** Per-CPU data for vhost-user */
 306   vhost_cpu_t *cpus;
 307
 308   /** Pseudo random iterator */
 309   u32 random;
 310
 311   /* The number of rx interface/queue pairs in interrupt mode */
 312   u32 ifq_count;
 313
 314   /* debug on or off */
 315   u8 debug;
 316 } vhost_user_main_t;
 317
 318 typedef struct
 319 {
 320   u8 if_name[64];
 321   u32 sw_if_index;
 322   u32 virtio_net_hdr_sz;
 323   u64 features;
 324   u8 is_server;
 325   u8 sock_filename[256];
 326   u32 num_regions;
 327   int sock_errno;
 328 } vhost_user_intf_details_t;
 329
 330 int vhost_user_dump_ifs (vnet_main_t * vnm, vlib_main_t * vm,
 331                          vhost_user_intf_details_t ** out_vuids);
 332
 333 #endif
 334
 335 /*
 336  * fd.io coding-style-patch-verification: ON
 337  *
 338  * Local Variables:
 339  * eval: (c-set-style "gnu")
 340  * End:
 341  */