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