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