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