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