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