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