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_NET_VRING_IDX_RX          0
  23 #define VHOST_NET_VRING_IDX_TX          1
  24 #define VHOST_NET_VRING_NUM             2
  25
  26 #define VIRTQ_DESC_F_NEXT               1
  27 #define VHOST_USER_REPLY_MASK       (0x1 << 2)
  28
  29 #define VHOST_USER_PROTOCOL_F_MQ   0
  30 #define VHOST_USER_PROTOCOL_F_LOG_SHMFD 1
  31 #define VHOST_VRING_F_LOG 0
  32
  33 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
  34 #define VHOST_USER_F_PROTOCOL_FEATURES  30
  35 #if RTE_VERSION >= RTE_VERSION_NUM(16, 4, 0, 0)
  36 #define VHOST_USER_PROTOCOL_FEATURES   ((1ULL << VHOST_USER_PROTOCOL_F_MQ) |    \
  37                                         (1ULL << VHOST_USER_PROTOCOL_F_LOG_SHMFD))
  38 #else
  39 #define VHOST_USER_PROTOCOL_FEATURES   (1ULL << VHOST_USER_PROTOCOL_F_MQ)
  40 #endif
  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 #endif
  48
  49 #define foreach_virtio_net_feature      \
  50  _ (VIRTIO_NET_F_MRG_RXBUF, 15)         \
  51  _ (VIRTIO_F_ANY_LAYOUT, 27)            \
  52  _ (VHOST_F_LOG_ALL, 26)                \
  53  _ (VIRTIO_NET_F_GUEST_ANNOUNCE, 21)    \
  54  _ (VHOST_USER_F_PROTOCOL_FEATURES, 30)
  55
  56
  57 typedef enum {
  58 #define _(f,n) FEAT_##f = (n),
  59   foreach_virtio_net_feature
  60 #undef _
  61 } virtio_net_feature_t;
  62
  63 int vhost_user_create_if(vnet_main_t * vnm, vlib_main_t * vm,
  64     const char * sock_filename, u8 is_server,
  65     u32 * sw_if_index, u64 feature_mask,
  66     u8 renumber, u32 custom_dev_instance, u8 *hwaddr);
  67 int vhost_user_modify_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);
  71 int vhost_user_delete_if(vnet_main_t * vnm, vlib_main_t * vm, u32 sw_if_index);
  72
  73 typedef struct vhost_user_memory_region {
  74   u64 guest_phys_addr;
  75   u64 memory_size;
  76   u64 userspace_addr;
  77   u64 mmap_offset;
  78 } vhost_user_memory_region_t;
  79
  80 typedef struct vhost_user_memory {
  81   u32 nregions;
  82   u32 padding;
  83   vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
  84 } vhost_user_memory_t;
  85
  86 typedef struct {
  87   unsigned int index, num;
  88 } vhost_vring_state_t;
  89
  90 typedef struct {
  91   unsigned int index, flags;
  92   u64 desc_user_addr, used_user_addr, avail_user_addr, log_guest_addr;
  93 } vhost_vring_addr_t;
  94
  95 typedef struct vhost_user_log {
  96   u64 size;
  97   u64 offset;
  98 } vhost_user_log_t;
  99
 100 typedef enum vhost_user_req {
 101   VHOST_USER_NONE = 0,
 102   VHOST_USER_GET_FEATURES = 1,
 103   VHOST_USER_SET_FEATURES = 2,
 104   VHOST_USER_SET_OWNER = 3,
 105   VHOST_USER_RESET_OWNER = 4,
 106   VHOST_USER_SET_MEM_TABLE = 5,
 107   VHOST_USER_SET_LOG_BASE = 6,
 108   VHOST_USER_SET_LOG_FD = 7,
 109   VHOST_USER_SET_VRING_NUM = 8,
 110   VHOST_USER_SET_VRING_ADDR = 9,
 111   VHOST_USER_SET_VRING_BASE = 10,
 112   VHOST_USER_GET_VRING_BASE = 11,
 113   VHOST_USER_SET_VRING_KICK = 12,
 114   VHOST_USER_SET_VRING_CALL = 13,
 115   VHOST_USER_SET_VRING_ERR = 14,
 116   VHOST_USER_GET_PROTOCOL_FEATURES = 15,
 117   VHOST_USER_SET_PROTOCOL_FEATURES = 16,
 118 #if RTE_VERSION >= RTE_VERSION_NUM(2, 2, 0, 0)
 119   VHOST_USER_GET_QUEUE_NUM = 17,
 120 #endif
 121   VHOST_USER_SET_VRING_ENABLE = 18,
 122   VHOST_USER_MAX
 123 } vhost_user_req_t;
 124
 125 // vring_desc I/O buffer descriptor
 126 typedef struct {
 127   uint64_t addr;  // packet data buffer address
 128   uint32_t len;   // packet data buffer size
 129   uint16_t flags; // (see below)
 130   uint16_t next;  // optional index next descriptor in chain
 131 } __attribute ((packed)) vring_desc_t;
 132
 133 typedef struct {
 134   uint16_t flags;
 135   uint16_t idx;
 136   uint16_t ring[VHOST_VRING_MAX_SIZE];
 137 } __attribute ((packed)) vring_avail_t;
 138
 139 typedef struct {
 140   uint16_t flags;
 141   uint16_t idx;
 142   struct /* vring_used_elem */ {
 143     uint32_t id;
 144     uint32_t len;
 145   } ring[VHOST_VRING_MAX_SIZE];
 146 } __attribute ((packed)) vring_used_t;
 147
 148 typedef struct {
 149   u8 flags;
 150   u8 gso_type;
 151   u16 hdr_len;
 152   u16 gso_size;
 153   u16 csum_start;
 154   u16 csum_offset;
 155 } __attribute ((packed)) virtio_net_hdr_t;
 156
 157 typedef struct  {
 158   virtio_net_hdr_t hdr;
 159   u16 num_buffers;
 160 } __attribute ((packed)) virtio_net_hdr_mrg_rxbuf_t;
 161
 162 typedef struct vhost_user_msg {
 163     vhost_user_req_t request;
 164     u32 flags;
 165     u32 size;
 166     union {
 167         u64 u64;
 168         vhost_vring_state_t state;
 169         vhost_vring_addr_t addr;
 170         vhost_user_memory_t memory;
 171         vhost_user_log_t log;
 172     };
 173 } __attribute ((packed)) vhost_user_msg_t;
 174
 175 typedef struct {
 176   u32 qsz;
 177   u16 last_avail_idx;
 178   u16 last_used_idx;
 179   vring_desc_t *desc;
 180   vring_avail_t *avail;
 181   vring_used_t *used;
 182   u64 log_guest_addr;
 183   int callfd;
 184   int kickfd;
 185   int errfd;
 186   u32 enabled;
 187   u32 log_used;
 188   u32 callfd_idx;
 189   u32 n_since_last_int;
 190   f64 int_deadline;
 191 } vhost_user_vring_t;
 192
 193 typedef struct {
 194   CLIB_CACHE_LINE_ALIGN_MARK(cacheline0);
 195   volatile u32 * lockp;
 196   u32 is_up;
 197   u32 admin_up;
 198   u32 unix_fd;
 199   u32 unix_file_index;
 200   u32 client_fd;
 201   char sock_filename[256];
 202   int sock_errno;
 203   u8 sock_is_server;
 204   u32 hw_if_index, sw_if_index;
 205   u8 active;
 206
 207   u32 nregions;
 208   u64 features;
 209   u64 feature_mask;
 210   u64 protocol_features;
 211   u32 num_vrings;
 212   vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS];
 213   void * region_mmap_addr[VHOST_MEMORY_MAX_NREGIONS];
 214   u32 region_mmap_fd[VHOST_MEMORY_MAX_NREGIONS];
 215   vhost_user_vring_t vrings[2];
 216   int virtio_net_hdr_sz;
 217   int is_any_layout;
 218   u32 * d_trace_buffers;
 219
 220   void * log_base_addr;
 221   u64 log_size;
 222 } vhost_user_intf_t;
 223
 224 typedef struct {
 225   u32 ** rx_buffers;
 226   u32 mtu_bytes;
 227   vhost_user_intf_t * vhost_user_interfaces;
 228   u32 * vhost_user_inactive_interfaces_index;
 229   uword * vhost_user_interface_index_by_listener_fd;
 230   uword * vhost_user_interface_index_by_sock_fd;
 231   uword * vhost_user_interface_index_by_sw_if_index;
 232   u32 * show_dev_instance_by_real_dev_instance;
 233   u32 coalesce_frames;
 234   f64 coalesce_time;
 235   int dont_dump_vhost_user_memory;
 236 } vhost_user_main_t;
 237
 238 typedef struct {
 239     u8 if_name[64];
 240     u32 sw_if_index;
 241     u32 virtio_net_hdr_sz;
 242     u64 features;
 243     u8 is_server;
 244     u8 sock_filename[256];
 245     u32 num_regions;
 246     int sock_errno;
 247 } vhost_user_intf_details_t;
 248
 249 int vhost_user_dump_ifs(vnet_main_t * vnm, vlib_main_t * vm,
 250         vhost_user_intf_details_t **out_vuids);
 251
 252 // CLI commands to be used from dpdk
 253 clib_error_t *
 254 vhost_user_connect_command_fn (vlib_main_t * vm,
 255                  unformat_input_t * input,
 256                  vlib_cli_command_t * cmd);
 257 clib_error_t *
 258 vhost_user_delete_command_fn (vlib_main_t * vm,
 259                  unformat_input_t * input,
 260                  vlib_cli_command_t * cmd);
 261 clib_error_t *
 262 show_vhost_user_command_fn (vlib_main_t * vm,
 263                  unformat_input_t * input,
 264                  vlib_cli_command_t * cmd);
 265
 266 #endif