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