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