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