FD.io VPP  v20.01-45-g7a071e370
Vector Packet Processing
vhost_user.h File Reference
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  vhost_user_memory_region
 
struct  vhost_user_memory
 
struct  vhost_user_log
 
struct  vhost_user_msg
 
struct  vhost_user_vring_t
 
struct  vhost_user_intf_t
 
struct  vhost_copy_t
 
struct  vhost_trace_t
 
struct  vhost_cpu_t
 
struct  vhost_user_main_t
 
struct  vhost_user_intf_details_t
 

Macros

#define VHOST_MEMORY_MAX_NREGIONS   8
 
#define VHOST_USER_MSG_HDR_SZ   12
 
#define VHOST_VRING_MAX_SIZE   32768
 
#define VHOST_VRING_MAX_N   16
 
#define VHOST_VRING_IDX_RX(qid)   (2*qid)
 
#define VHOST_VRING_IDX_TX(qid)   (2*qid + 1)
 
#define VHOST_USER_VRING_NOFD_MASK   0x100
 
#define VIRTQ_DESC_F_NEXT   1
 
#define VIRTQ_DESC_F_INDIRECT   4
 
#define VHOST_USER_REPLY_MASK   (0x1 << 2)
 
#define VHOST_USER_PROTOCOL_F_MQ   0
 
#define VHOST_USER_PROTOCOL_F_LOG_SHMFD   1
 
#define VHOST_VRING_F_LOG   0
 
#define VHOST_USER_F_PROTOCOL_FEATURES   30
 
#define VHOST_USER_PROTOCOL_FEATURES
 
#define VIRTIO_NET_CTRL_MQ   4
 
#define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET   0
 
#define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN   1
 
#define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX   0x8000
 
#define VRING_USED_F_NO_NOTIFY   1
 
#define VRING_AVAIL_F_NO_INTERRUPT   1
 
#define vu_log_debug(dev, f, ...)
 
#define vu_log_warn(dev, f, ...)
 
#define vu_log_err(dev, f, ...)
 
#define UNIX_GET_FD(unixfd_idx)
 
#define foreach_virtio_trace_flags
 
#define foreach_virtio_net_feature
 
#define FEATURE_VIRTIO_NET_F_HOST_TSO_FEATURE_BITS
 
#define FEATURE_VIRTIO_NET_F_GUEST_TSO_FEATURE_BITS
 
#define FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS
 
#define VHOST_USER_EVENT_START_TIMER   1
 
#define VHOST_USER_EVENT_STOP_TIMER   2
 
#define VHOST_USER_RX_BUFFERS_N   (2 * VLIB_FRAME_SIZE + 2)
 
#define VHOST_USER_COPY_ARRAY_N   (4 * VLIB_FRAME_SIZE)
 

Typedefs

typedef enum vhost_user_req vhost_user_req_t
 

Enumerations

enum  virtio_trace_flag_t { foreach_virtio_trace_flags }
 
enum  virtio_net_feature_t { foreach_virtio_net_feature }
 
enum  vhost_user_req {
  VHOST_USER_NONE = 0, VHOST_USER_GET_FEATURES = 1, VHOST_USER_SET_FEATURES = 2, VHOST_USER_SET_OWNER = 3,
  VHOST_USER_RESET_OWNER = 4, VHOST_USER_SET_MEM_TABLE = 5, VHOST_USER_SET_LOG_BASE = 6, VHOST_USER_SET_LOG_FD = 7,
  VHOST_USER_SET_VRING_NUM = 8, VHOST_USER_SET_VRING_ADDR = 9, VHOST_USER_SET_VRING_BASE = 10, VHOST_USER_GET_VRING_BASE = 11,
  VHOST_USER_SET_VRING_KICK = 12, VHOST_USER_SET_VRING_CALL = 13, VHOST_USER_SET_VRING_ERR = 14, VHOST_USER_GET_PROTOCOL_FEATURES = 15,
  VHOST_USER_SET_PROTOCOL_FEATURES = 16, VHOST_USER_GET_QUEUE_NUM = 17, VHOST_USER_SET_VRING_ENABLE = 18, VHOST_USER_MAX
}
 

Functions

int vhost_user_create_if (vnet_main_t *vnm, vlib_main_t *vm, const char *sock_filename, u8 is_server, u32 *sw_if_index, u64 feature_mask, u8 renumber, u32 custom_dev_instance, u8 *hwaddr, u8 enable_gso)
 
int vhost_user_modify_if (vnet_main_t *vnm, vlib_main_t *vm, const char *sock_filename, u8 is_server, u32 sw_if_index, u64 feature_mask, u8 renumber, u32 custom_dev_instance, u8 enable_gso)
 
int vhost_user_delete_if (vnet_main_t *vnm, vlib_main_t *vm, u32 sw_if_index)
 
int vhost_user_dump_ifs (vnet_main_t *vnm, vlib_main_t *vm, vhost_user_intf_details_t **out_vuids)
 

Variables

u64 guest_phys_addr
 
u64 memory_size
 
u64 userspace_addr
 
u64 mmap_offset
 
u32 nregions
 
u32 padding
 
vhost_user_memory_region_t regions [VHOST_MEMORY_MAX_NREGIONS]
 
u64 size
 
u64 offset
 
vhost_user_req_t request
 
u32 flags
 
union {
   u64   u64
 
   vhost_vring_state_t   state
 
   vhost_vring_addr_t   addr
 
   vhost_user_memory_t   memory
 
   vhost_user_log_t   log
 
}; 
 
vlib_node_registration_t vhost_user_send_interrupt_node
 (constructor) VLIB_REGISTER_NODE (vhost_user_send_interrupt_node) More...
 
vnet_device_class_t vhost_user_device_class
 
vlib_node_registration_t vhost_user_input_node
 (constructor) VLIB_REGISTER_NODE (vhost_user_input_node) More...
 
vhost_user_main_t vhost_user_main
 

Macro Definition Documentation

◆ FEATURE_VIRTIO_NET_F_GUEST_TSO_FEATURE_BITS

#define FEATURE_VIRTIO_NET_F_GUEST_TSO_FEATURE_BITS
Value:
((1ULL << FEAT_VIRTIO_NET_F_GUEST_CSUM) | \
(1ULL << FEAT_VIRTIO_NET_F_GUEST_UFO) | \
(1ULL << FEAT_VIRTIO_NET_F_GUEST_TSO4) | \
(1ULL << FEAT_VIRTIO_NET_F_GUEST_TSO6))

Definition at line 119 of file vhost_user.h.

◆ FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS

#define FEATURE_VIRTIO_NET_F_HOST_GUEST_TSO_FEATURE_BITS
Value:
FEATURE_VIRTIO_NET_F_GUEST_TSO_FEATURE_BITS)
#define FEATURE_VIRTIO_NET_F_HOST_TSO_FEATURE_BITS
Definition: vhost_user.h:113

Definition at line 125 of file vhost_user.h.

◆ FEATURE_VIRTIO_NET_F_HOST_TSO_FEATURE_BITS

#define FEATURE_VIRTIO_NET_F_HOST_TSO_FEATURE_BITS
Value:
((1ULL << FEAT_VIRTIO_NET_F_CSUM) | \
(1ULL << FEAT_VIRTIO_NET_F_HOST_UFO) | \
(1ULL << FEAT_VIRTIO_NET_F_HOST_TSO4) | \
(1ULL << FEAT_VIRTIO_NET_F_HOST_TSO6))

Definition at line 113 of file vhost_user.h.

◆ foreach_virtio_net_feature

#define foreach_virtio_net_feature
Value:
_ (VIRTIO_NET_F_CSUM, 0) \
_ (VIRTIO_NET_F_GUEST_CSUM, 1) \
_ (VIRTIO_NET_F_GUEST_TSO4, 7) \
_ (VIRTIO_NET_F_GUEST_TSO6, 8) \
_ (VIRTIO_NET_F_GUEST_UFO, 10) \
_ (VIRTIO_NET_F_HOST_TSO4, 11) \
_ (VIRTIO_NET_F_HOST_TSO6, 12) \
_ (VIRTIO_NET_F_HOST_UFO, 14) \
_ (VIRTIO_NET_F_MRG_RXBUF, 15) \
_ (VIRTIO_NET_F_CTRL_VQ, 17) \
_ (VIRTIO_NET_F_GUEST_ANNOUNCE, 21) \
_ (VIRTIO_NET_F_MQ, 22) \
_ (VHOST_F_LOG_ALL, 26) \
_ (VIRTIO_F_ANY_LAYOUT, 27) \
_ (VIRTIO_F_INDIRECT_DESC, 28) \
_ (VIRTIO_F_VERSION_1, 32)
#define VHOST_USER_F_PROTOCOL_FEATURES
Definition: vhost_user.h:35

Definition at line 87 of file vhost_user.h.

◆ foreach_virtio_trace_flags

#define foreach_virtio_trace_flags
Value:
_ (SIMPLE_CHAINED, 0, "Simple descriptor chaining") \
_ (SINGLE_DESC, 1, "Single descriptor packet") \
_ (INDIRECT, 2, "Indirect descriptor") \
_ (MAP_ERROR, 4, "Memory mapping error")

Definition at line 74 of file vhost_user.h.

◆ UNIX_GET_FD

#define UNIX_GET_FD (   unixfd_idx)
Value:
({ \
typeof(unixfd_idx) __unixfd_idx = (unixfd_idx); \
(__unixfd_idx != ~0) ? \
__unixfd_idx)->file_descriptor : -1; })
clib_file_t * file_pool
Definition: file.h:88
clib_file_main_t file_main
Definition: main.c:63
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:519

Definition at line 68 of file vhost_user.h.

◆ VHOST_MEMORY_MAX_NREGIONS

#define VHOST_MEMORY_MAX_NREGIONS   8

Definition at line 19 of file vhost_user.h.

◆ VHOST_USER_COPY_ARRAY_N

#define VHOST_USER_COPY_ARRAY_N   (4 * VLIB_FRAME_SIZE)

Definition at line 355 of file vhost_user.h.

◆ VHOST_USER_EVENT_START_TIMER

#define VHOST_USER_EVENT_START_TIMER   1

Definition at line 292 of file vhost_user.h.

◆ VHOST_USER_EVENT_STOP_TIMER

#define VHOST_USER_EVENT_STOP_TIMER   2

Definition at line 293 of file vhost_user.h.

◆ VHOST_USER_F_PROTOCOL_FEATURES

#define VHOST_USER_F_PROTOCOL_FEATURES   30

Definition at line 35 of file vhost_user.h.

◆ VHOST_USER_MSG_HDR_SZ

#define VHOST_USER_MSG_HDR_SZ   12

Definition at line 20 of file vhost_user.h.

◆ VHOST_USER_PROTOCOL_F_LOG_SHMFD

#define VHOST_USER_PROTOCOL_F_LOG_SHMFD   1

Definition at line 32 of file vhost_user.h.

◆ VHOST_USER_PROTOCOL_F_MQ

#define VHOST_USER_PROTOCOL_F_MQ   0

Definition at line 31 of file vhost_user.h.

◆ VHOST_USER_PROTOCOL_FEATURES

#define VHOST_USER_PROTOCOL_FEATURES
Value:
#define VHOST_USER_PROTOCOL_F_LOG_SHMFD
Definition: vhost_user.h:32
#define VHOST_USER_PROTOCOL_F_MQ
Definition: vhost_user.h:31

Definition at line 36 of file vhost_user.h.

◆ VHOST_USER_REPLY_MASK

#define VHOST_USER_REPLY_MASK   (0x1 << 2)

Definition at line 29 of file vhost_user.h.

◆ VHOST_USER_RX_BUFFERS_N

#define VHOST_USER_RX_BUFFERS_N   (2 * VLIB_FRAME_SIZE + 2)

Definition at line 354 of file vhost_user.h.

◆ VHOST_USER_VRING_NOFD_MASK

#define VHOST_USER_VRING_NOFD_MASK   0x100

Definition at line 26 of file vhost_user.h.

◆ VHOST_VRING_F_LOG

#define VHOST_VRING_F_LOG   0

Definition at line 33 of file vhost_user.h.

◆ VHOST_VRING_IDX_RX

#define VHOST_VRING_IDX_RX (   qid)    (2*qid)

Definition at line 23 of file vhost_user.h.

◆ VHOST_VRING_IDX_TX

#define VHOST_VRING_IDX_TX (   qid)    (2*qid + 1)

Definition at line 24 of file vhost_user.h.

◆ VHOST_VRING_MAX_N

#define VHOST_VRING_MAX_N   16

Definition at line 22 of file vhost_user.h.

◆ VHOST_VRING_MAX_SIZE

#define VHOST_VRING_MAX_SIZE   32768

Definition at line 21 of file vhost_user.h.

◆ VIRTIO_NET_CTRL_MQ

#define VIRTIO_NET_CTRL_MQ   4

Definition at line 40 of file vhost_user.h.

◆ VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX

#define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MAX   0x8000

Definition at line 43 of file vhost_user.h.

◆ VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN

#define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_MIN   1

Definition at line 42 of file vhost_user.h.

◆ VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET

#define VIRTIO_NET_CTRL_MQ_VQ_PAIRS_SET   0

Definition at line 41 of file vhost_user.h.

◆ VIRTQ_DESC_F_INDIRECT

#define VIRTQ_DESC_F_INDIRECT   4

Definition at line 28 of file vhost_user.h.

◆ VIRTQ_DESC_F_NEXT

#define VIRTQ_DESC_F_NEXT   1

Definition at line 27 of file vhost_user.h.

◆ VRING_AVAIL_F_NO_INTERRUPT

#define VRING_AVAIL_F_NO_INTERRUPT   1

Definition at line 46 of file vhost_user.h.

◆ VRING_USED_F_NO_NOTIFY

#define VRING_USED_F_NO_NOTIFY   1

Definition at line 45 of file vhost_user.h.

◆ vu_log_debug

#define vu_log_debug (   dev,
  f,
  ... 
)
Value:
{ \
vlib_log(VLIB_LOG_LEVEL_DEBUG, vhost_user_main.log_default, "%U: " f, \
dev->hw_if_index, ##__VA_ARGS__); \
};
format_function_t format_vnet_hw_if_index_name
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
vlib_log_class_t log_default
Definition: vhost_user.h:390
vhost_user_main_t vhost_user_main
Definition: vhost_user.c:56

Definition at line 48 of file vhost_user.h.

◆ vu_log_err

#define vu_log_err (   dev,
  f,
  ... 
)
Value:
{ \
vlib_log(VLIB_LOG_LEVEL_ERR, vhost_user_main.log_default, "%U: " f, \
dev->hw_if_index, ##__VA_ARGS__); \
};
format_function_t format_vnet_hw_if_index_name
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
vlib_log_class_t log_default
Definition: vhost_user.h:390
vhost_user_main_t vhost_user_main
Definition: vhost_user.c:56

Definition at line 61 of file vhost_user.h.

◆ vu_log_warn

#define vu_log_warn (   dev,
  f,
  ... 
)
Value:
{ \
vlib_log(VLIB_LOG_LEVEL_WARNING, vhost_user_main.log_default, "%U: " f, \
dev->hw_if_index, ##__VA_ARGS__); \
};
format_function_t format_vnet_hw_if_index_name
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
vlib_log_class_t log_default
Definition: vhost_user.h:390
vhost_user_main_t vhost_user_main
Definition: vhost_user.c:56

Definition at line 55 of file vhost_user.h.

Typedef Documentation

◆ vhost_user_req_t

Enumeration Type Documentation

◆ vhost_user_req

Enumerator
VHOST_USER_NONE 
VHOST_USER_GET_FEATURES 
VHOST_USER_SET_FEATURES 
VHOST_USER_SET_OWNER 
VHOST_USER_RESET_OWNER 
VHOST_USER_SET_MEM_TABLE 
VHOST_USER_SET_LOG_BASE 
VHOST_USER_SET_LOG_FD 
VHOST_USER_SET_VRING_NUM 
VHOST_USER_SET_VRING_ADDR 
VHOST_USER_SET_VRING_BASE 
VHOST_USER_GET_VRING_BASE 
VHOST_USER_SET_VRING_KICK 
VHOST_USER_SET_VRING_CALL 
VHOST_USER_SET_VRING_ERR 
VHOST_USER_GET_PROTOCOL_FEATURES 
VHOST_USER_SET_PROTOCOL_FEATURES 
VHOST_USER_GET_QUEUE_NUM 
VHOST_USER_SET_VRING_ENABLE 
VHOST_USER_MAX 

Definition at line 175 of file vhost_user.h.

◆ virtio_net_feature_t

Enumerator
foreach_virtio_net_feature 

Definition at line 106 of file vhost_user.h.

◆ virtio_trace_flag_t

Enumerator
foreach_virtio_trace_flags 

Definition at line 80 of file vhost_user.h.

Function Documentation

◆ vhost_user_create_if()

int vhost_user_create_if ( vnet_main_t vnm,
vlib_main_t vm,
const char *  sock_filename,
u8  is_server,
u32 sw_if_index,
u64  feature_mask,
u8  renumber,
u32  custom_dev_instance,
u8 hwaddr,
u8  enable_gso 
)

Definition at line 1516 of file vhost_user.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ vhost_user_delete_if()

int vhost_user_delete_if ( vnet_main_t vnm,
vlib_main_t vm,
u32  sw_if_index 
)

Definition at line 1282 of file vhost_user.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ vhost_user_dump_ifs()

int vhost_user_dump_ifs ( vnet_main_t vnm,
vlib_main_t vm,
vhost_user_intf_details_t **  out_vuids 
)

Definition at line 1752 of file vhost_user.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ vhost_user_modify_if()

int vhost_user_modify_if ( vnet_main_t vnm,
vlib_main_t vm,
const char *  sock_filename,
u8  is_server,
u32  sw_if_index,
u64  feature_mask,
u8  renumber,
u32  custom_dev_instance,
u8  enable_gso 
)

Definition at line 1580 of file vhost_user.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Variable Documentation

◆ @195

union { ... }

◆ addr

vhost_vring_addr_t addr

Definition at line 147 of file vhost_user.h.

◆ flags

vl_api_gbp_ext_itf_flags_t flags

Definition at line 141 of file vhost_user.h.

◆ guest_phys_addr

u64 guest_phys_addr

Definition at line 140 of file vhost_user.h.

◆ log

vhost_user_log_t log

Definition at line 149 of file vhost_user.h.

◆ memory

vhost_user_memory_t memory

Definition at line 148 of file vhost_user.h.

◆ memory_size

u64 memory_size

Definition at line 141 of file vhost_user.h.

◆ mmap_offset

u64 mmap_offset

Definition at line 143 of file vhost_user.h.

◆ nregions

u32 nregions

Definition at line 140 of file vhost_user.h.

◆ offset

Definition at line 141 of file vhost_user.h.

◆ padding

u32 padding

Definition at line 141 of file vhost_user.h.

◆ regions

vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS]

Definition at line 142 of file vhost_user.h.

◆ request

Definition at line 140 of file vhost_user.h.

◆ size

u32 size

Definition at line 140 of file vhost_user.h.

◆ state

vhost_vring_state_t state

Definition at line 146 of file vhost_user.h.

◆ u64

Definition at line 145 of file vhost_user.h.

◆ userspace_addr

u64 userspace_addr

Definition at line 142 of file vhost_user.h.

◆ vhost_user_device_class

vnet_device_class_t vhost_user_device_class

◆ vhost_user_input_node

vlib_node_registration_t vhost_user_input_node
Initial value:
= {
.name = "vhost-user-input",
.sibling_of = "device-input",
.state = VLIB_NODE_STATE_DISABLED,
.format_trace = format_vhost_trace,
}
#define VLIB_NODE_FLAG_TRACE_SUPPORTED
Definition: node.h:306
static_always_inline u8 * format_vhost_trace(u8 *s, va_list *va)
u8 * format_ethernet_header_with_length(u8 *s, va_list *args)
Definition: format.c:97
static __clib_unused char * vhost_user_input_func_error_strings[]

(constructor) VLIB_REGISTER_NODE (vhost_user_input_node)

Definition at line 784 of file vhost_user_input.c.

◆ vhost_user_main

vhost_user_main_t vhost_user_main

Definition at line 56 of file vhost_user.c.

◆ vhost_user_send_interrupt_node

vlib_node_registration_t vhost_user_send_interrupt_node

(constructor) VLIB_REGISTER_NODE (vhost_user_send_interrupt_node)

Definition at line 53 of file vhost_user.c.