FD.io VPP  v20.09-64-g4f7b92f0a
Vector Packet Processing
Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
vhost_user.h File Reference
+ Include dependency graph for vhost_user.h:
+ 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_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_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 VHOST_USER_PROTOCOL_F_MQ   0
 
#define VHOST_USER_PROTOCOL_F_LOG_SHMFD   1
 
#define VHOST_VRING_F_LOG   0
 
#define VHOST_USER_PROTOCOL_FEATURES
 
#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 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  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, u8 enable_packed)
 
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, u8 enable_packed)
 
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]
 
vhost_user_req_t request
 
u32 flags
 
u32 size
 
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:
(VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_CSUM) | \
VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_UFO) | \
VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_TSO4) | \
VIRTIO_FEATURE (VIRTIO_NET_F_GUEST_TSO6))
VIRTIO_FEATURE
#define VIRTIO_FEATURE(X)
Definition: virtio_std.h:69

Definition at line 83 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_HOST_TSO_FEATURE_BITS | \
FEATURE_VIRTIO_NET_F_GUEST_TSO_FEATURE_BITS)
FEATURE_VIRTIO_NET_F_HOST_TSO_FEATURE_BITS
#define FEATURE_VIRTIO_NET_F_HOST_TSO_FEATURE_BITS
Definition: vhost_user.h:77

Definition at line 89 of file vhost_user.h.

◆ FEATURE_VIRTIO_NET_F_HOST_TSO_FEATURE_BITS

#define FEATURE_VIRTIO_NET_F_HOST_TSO_FEATURE_BITS
Value:
(VIRTIO_FEATURE (VIRTIO_NET_F_CSUM) | \
VIRTIO_FEATURE (VIRTIO_NET_F_HOST_UFO) | \
VIRTIO_FEATURE (VIRTIO_NET_F_HOST_TSO4) | \
VIRTIO_FEATURE (VIRTIO_NET_F_HOST_TSO6))
VIRTIO_FEATURE
#define VIRTIO_FEATURE(X)
Definition: virtio_std.h:69

Definition at line 77 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 64 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) ? \
pool_elt_at_index (file_main.file_pool, \
__unixfd_idx)->file_descriptor : -1; })
clib_file_main_t::file_pool
clib_file_t * file_pool
Definition: file.h:88
file_main
clib_file_main_t file_main
Definition: main.c:63
pool_elt_at_index
#define pool_elt_at_index(p, i)
Returns pointer to element at given index.
Definition: pool.h:534

Definition at line 58 of file vhost_user.h.

◆ VHOST_MEMORY_MAX_NREGIONS

#define VHOST_MEMORY_MAX_NREGIONS   8

Definition at line 23 of file vhost_user.h.

◆ VHOST_USER_COPY_ARRAY_N

#define VHOST_USER_COPY_ARRAY_N   (4 * VLIB_FRAME_SIZE)

Definition at line 278 of file vhost_user.h.

◆ VHOST_USER_EVENT_START_TIMER

#define VHOST_USER_EVENT_START_TIMER   1

Definition at line 212 of file vhost_user.h.

◆ VHOST_USER_EVENT_STOP_TIMER

#define VHOST_USER_EVENT_STOP_TIMER   2

Definition at line 213 of file vhost_user.h.

◆ VHOST_USER_MSG_HDR_SZ

#define VHOST_USER_MSG_HDR_SZ   12

Definition at line 24 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:
((1ULL << VHOST_USER_PROTOCOL_F_MQ) | \
(1ULL << VHOST_USER_PROTOCOL_F_LOG_SHMFD))
VHOST_USER_PROTOCOL_F_LOG_SHMFD
#define VHOST_USER_PROTOCOL_F_LOG_SHMFD
Definition: vhost_user.h:32
VHOST_USER_PROTOCOL_F_MQ
#define VHOST_USER_PROTOCOL_F_MQ
Definition: vhost_user.h:31

Definition at line 35 of file vhost_user.h.

◆ VHOST_USER_RX_BUFFERS_N

#define VHOST_USER_RX_BUFFERS_N   (2 * VLIB_FRAME_SIZE + 2)

Definition at line 277 of file vhost_user.h.

◆ VHOST_USER_VRING_NOFD_MASK

#define VHOST_USER_VRING_NOFD_MASK   0x100

Definition at line 29 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 26 of file vhost_user.h.

◆ VHOST_VRING_IDX_TX

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

Definition at line 27 of file vhost_user.h.

◆ VHOST_VRING_MAX_N

#define VHOST_VRING_MAX_N   16

Definition at line 25 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, \
format_vnet_hw_if_index_name, vnet_get_main(), \
dev->hw_if_index, ##__VA_ARGS__); \
};
format_vnet_hw_if_index_name
format_function_t format_vnet_hw_if_index_name
Definition: interface_funcs.h:442
vnet_get_main
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
vhost_user_main_t::log_default
vlib_log_class_t log_default
Definition: vhost_user.h:316
vhost_user_main
vhost_user_main_t vhost_user_main
Definition: vhost_user.c:56

Definition at line 38 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, \
format_vnet_hw_if_index_name, vnet_get_main(), \
dev->hw_if_index, ##__VA_ARGS__); \
};
format_vnet_hw_if_index_name
format_function_t format_vnet_hw_if_index_name
Definition: interface_funcs.h:442
vnet_get_main
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
vhost_user_main_t::log_default
vlib_log_class_t log_default
Definition: vhost_user.h:316
vhost_user_main
vhost_user_main_t vhost_user_main
Definition: vhost_user.c:56

Definition at line 51 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, \
format_vnet_hw_if_index_name, vnet_get_main(), \
dev->hw_if_index, ##__VA_ARGS__); \
};
format_vnet_hw_if_index_name
format_function_t format_vnet_hw_if_index_name
Definition: interface_funcs.h:442
vnet_get_main
vnet_main_t * vnet_get_main(void)
Definition: misc.c:46
vhost_user_main_t::log_default
vlib_log_class_t log_default
Definition: vhost_user.h:316
vhost_user_main
vhost_user_main_t vhost_user_main
Definition: vhost_user.c:56

Definition at line 45 of file vhost_user.h.

Typedef Documentation

◆ vhost_user_req_t

typedef enum vhost_user_req vhost_user_req_t

Enumeration Type Documentation

◆ vhost_user_req

enum 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 122 of file vhost_user.h.

◆ virtio_trace_flag_t

enum virtio_trace_flag_t
Enumerator
foreach_virtio_trace_flags 

Definition at line 70 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,
u8  enable_packed 
)

Definition at line 1571 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 1335 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 1812 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,
u8  enable_packed 
)

Definition at line 1635 of file vhost_user.c.

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

Variable Documentation

◆ @241

union { ... }

◆ addr

vhost_vring_addr_t addr

Definition at line 111 of file vhost_user.h.

◆ flags

u32 flags

Definition at line 105 of file vhost_user.h.

◆ guest_phys_addr

u64 guest_phys_addr

Definition at line 104 of file vhost_user.h.

◆ log

vhost_user_log_t log

Definition at line 113 of file vhost_user.h.

◆ memory

vhost_user_memory_t memory

Definition at line 112 of file vhost_user.h.

◆ memory_size

u64 memory_size

Definition at line 105 of file vhost_user.h.

◆ mmap_offset

u64 mmap_offset

Definition at line 107 of file vhost_user.h.

◆ nregions

u32 nregions

Definition at line 104 of file vhost_user.h.

◆ padding

u32 padding

Definition at line 105 of file vhost_user.h.

◆ regions

vhost_user_memory_region_t regions[VHOST_MEMORY_MAX_NREGIONS]

Definition at line 106 of file vhost_user.h.

◆ request

vhost_user_req_t request

Definition at line 104 of file vhost_user.h.

◆ size

u32 size

Definition at line 106 of file vhost_user.h.

◆ state

vhost_vring_state_t state

Definition at line 110 of file vhost_user.h.

◆ u64

u64 u64

Definition at line 109 of file vhost_user.h.

◆ userspace_addr

u64 userspace_addr

Definition at line 106 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:
= {
.type = VLIB_NODE_TYPE_INPUT,
.name = "vhost-user-input",
.sibling_of = "device-input",
.flags = VLIB_NODE_FLAG_TRACE_SUPPORTED,
.state = VLIB_NODE_STATE_DISABLED,
.format_buffer = format_ethernet_header_with_length,
.format_trace = format_vhost_trace,
.n_errors = VHOST_USER_INPUT_FUNC_N_ERROR,
.error_strings = vhost_user_input_func_error_strings,
}
VLIB_NODE_FLAG_TRACE_SUPPORTED
#define VLIB_NODE_FLAG_TRACE_SUPPORTED
Definition: node.h:305
format_vhost_trace
static_always_inline u8 * format_vhost_trace(u8 *s, va_list *va)
Definition: vhost_user_inline.h:210
format_ethernet_header_with_length
u8 * format_ethernet_header_with_length(u8 *s, va_list *args)
Definition: format.c:97
vhost_user_input_func_error_strings
static __clib_unused char * vhost_user_input_func_error_strings[]
Definition: vhost_user_input.c:87
VHOST_USER_INPUT_FUNC_N_ERROR
Definition: vhost_user_input.c:84

(constructor) VLIB_REGISTER_NODE (vhost_user_input_node)

Definition at line 1454 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.