FD.io VPP  v16.12-rc0-308-g931be3a
Vector Packet Processing
vhost-user.c File Reference
+ Include dependency graph for vhost-user.c:

Go to the source code of this file.

Data Structures

struct  vhost_user_input_trace_t
 

Macros

#define VHOST_USER_DEBUG_SOCKET   0
 
#define VHOST_USER_DEBUG_VQ   0
 
#define VHOST_USER_COPY_TX_HDR   0
 
#define DBG_SOCK(args...)
 
#define DBG_VQ(args...)
 
#define foreach_vhost_user_tx_func_error
 
#define foreach_vhost_user_input_func_error
 
#define VHOST_LOG_PAGE   0x1000
 
#define vhost_user_log_dirty_ring(vui, vq, member)
 

Enumerations

enum  vhost_user_tx_func_error_t { VHOST_USER_TX_FUNC_N_ERROR }
 
enum  vhost_user_input_func_error_t { VHOST_USER_INPUT_FUNC_N_ERROR }
 

Functions

 VNET_HW_INTERFACE_CLASS (vhost_interface_class, static)
 
static u8format_vhost_user_interface_name (u8 *s, va_list *args)
 
static int vhost_user_name_renumber (vnet_hw_interface_t *hi, u32 new_dev_instance)
 
static_always_inline void * map_guest_mem (vhost_user_intf_t *vui, uword addr, u32 *hint)
 
static void * map_user_mem (vhost_user_intf_t *vui, uword addr)
 
static long get_huge_page_size (int fd)
 
static void unmap_all_mem_regions (vhost_user_intf_t *vui)
 
static clib_error_tvhost_user_callfd_read_ready (unix_file_t *uf)
 
static void vhost_user_if_disconnect (vhost_user_intf_t *vui)
 
static void vhost_user_log_dirty_pages (vhost_user_intf_t *vui, u64 addr, u64 len)
 
static clib_error_tvhost_user_socket_read (unix_file_t *uf)
 
static clib_error_tvhost_user_socket_error (unix_file_t *uf)
 
static clib_error_tvhost_user_socksvr_accept_ready (unix_file_t *uf)
 
static clib_error_tvhost_user_init (vlib_main_t *vm)
 
static clib_error_tvhost_user_exit (vlib_main_t *vm)
 
static u8format_vhost_user_input_trace (u8 *s, va_list *va)
 
void vhost_user_rx_trace (vlib_main_t *vm, vlib_node_runtime_t *node, vhost_user_intf_t *vui, i16 virtqueue)
 
static void vhost_user_send_call (vlib_main_t *vm, vhost_user_vring_t *vq)
 
static u32 vhost_user_if_input (vlib_main_t *vm, vhost_user_main_t *vum, vhost_user_intf_t *vui, vlib_node_runtime_t *node)
 
static uword vhost_user_input (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *f)
 
static uword vhost_user_intfc_tx (vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *frame)
 
static clib_error_tvhost_user_interface_admin_up_down (vnet_main_t *vnm, u32 hw_if_index, u32 flags)
 
 VNET_DEVICE_CLASS (vhost_user_dev_class, static)
 
 VLIB_DEVICE_TX_FUNCTION_MULTIARCH (vhost_user_dev_class, vhost_user_intfc_tx)
 
int vhost_user_delete_if (vnet_main_t *vnm, vlib_main_t *vm, u32 sw_if_index)
 
static int vhost_user_init_server_sock (const char *sock_filename, int *sockfd)
 
static vhost_user_intf_tvhost_user_vui_new ()
 
static void vhost_user_create_ethernet (vnet_main_t *vnm, vlib_main_t *vm, vhost_user_intf_t *vui, u8 *hwaddress)
 
static void vhost_user_vui_init (vnet_main_t *vnm, vhost_user_intf_t *vui, int sockfd, const char *sock_filename, u8 is_server, u64 feature_mask, u32 *sw_if_index)
 
static void vhost_user_vui_register (vlib_main_t *vm, vhost_user_intf_t *vui)
 
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)
 
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)
 
clib_error_tvhost_user_connect_command_fn (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
 
clib_error_tvhost_user_delete_command_fn (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
 
int vhost_user_dump_ifs (vnet_main_t *vnm, vlib_main_t *vm, vhost_user_intf_details_t **out_vuids)
 
clib_error_tshow_vhost_user_command_fn (vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
 
static clib_error_tvhost_user_config (vlib_main_t *vm, unformat_input_t *input)
 
void vhost_user_unmap_all (void)
 

Variables

vlib_node_registration_t vhost_user_input_node
 (constructor) VLIB_REGISTER_NODE (vhost_user_input_node) More...
 
static char * vhost_user_tx_func_error_strings []
 
static char * vhost_user_input_func_error_strings []
 
static vhost_user_main_t vhost_user_main
 
static vlib_node_registration_t vhost_user_process_node
 (constructor) VLIB_REGISTER_NODE (vhost_user_process_node) More...
 
static vlib_cli_command_t vhost_user_connect_command
 (constructor) VLIB_CLI_COMMAND (vhost_user_connect_command) More...
 
static vlib_cli_command_t vhost_user_delete_command
 (constructor) VLIB_CLI_COMMAND (vhost_user_delete_command) More...
 
static vlib_cli_command_t show_vhost_user_command
 (constructor) VLIB_CLI_COMMAND (show_vhost_user_command) More...
 

Macro Definition Documentation

#define DBG_SOCK (   args...)

Definition at line 54 of file vhost-user.c.

#define DBG_VQ (   args...)

Definition at line 60 of file vhost-user.c.

#define foreach_vhost_user_input_func_error
Value:
_(NO_ERROR, "no error") \
_(NO_BUFFER, "no available buffer") \
_(MMAP_FAIL, "mmap failure") \
_(INDIRECT_OVERFLOW, "indirect descriptor overflows table") \
_(UNDERSIZED_FRAME, "undersized ethernet frame received (< 14 bytes)") \
_(FULL_RX_QUEUE, "full rx queue (possible driver tx drop)")

Definition at line 87 of file vhost-user.c.

#define foreach_vhost_user_tx_func_error
Value:
_(NONE, "no error") \
_(NOT_READY, "vhost user state error") \
_(PKT_DROP_NOBUF, "tx packet drops (no available descriptors)") \
_(PKT_DROP_NOMRG, "tx packet drops (cannot merge descriptors)") \
_(MMAP_FAIL, "mmap failure") \
_(INDIRECT_OVERFLOW, "indirect descriptor table overflow")

Definition at line 65 of file vhost-user.c.

#define VHOST_LOG_PAGE   0x1000

Definition at line 338 of file vhost-user.c.

#define VHOST_USER_COPY_TX_HDR   0

Definition at line 49 of file vhost-user.c.

#define VHOST_USER_DEBUG_SOCKET   0

Definition at line 44 of file vhost-user.c.

#define VHOST_USER_DEBUG_VQ   0

Definition at line 45 of file vhost-user.c.

#define vhost_user_log_dirty_ring (   vui,
  vq,
  member 
)
Value:
if (PREDICT_FALSE(vq->log_used)) { \
vhost_user_log_dirty_pages(vui, vq->log_guest_addr + STRUCT_OFFSET_OF(vring_used_t, member), \
sizeof(vq->used->member)); \
}
#define STRUCT_OFFSET_OF(t, f)
Definition: clib.h:62
#define PREDICT_FALSE(x)
Definition: clib.h:97
static void vhost_user_log_dirty_pages(vhost_user_intf_t *vui, u64 addr, u64 len)
Definition: vhost-user.c:340

Definition at line 362 of file vhost-user.c.

Enumeration Type Documentation

Enumerator
VHOST_USER_INPUT_FUNC_N_ERROR 

Definition at line 95 of file vhost-user.c.

Enumerator
VHOST_USER_TX_FUNC_N_ERROR 

Definition at line 73 of file vhost-user.c.

Function Documentation

static u8* format_vhost_user_input_trace ( u8 s,
va_list *  va 
)
static

Definition at line 932 of file vhost-user.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static u8* format_vhost_user_interface_name ( u8 s,
va_list *  args 
)
static

Definition at line 120 of file vhost-user.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static long get_huge_page_size ( int  fd)
static

Definition at line 239 of file vhost-user.c.

+ Here is the caller graph for this function:

static_always_inline void* map_guest_mem ( vhost_user_intf_t vui,
uword  addr,
u32 hint 
)

Definition at line 154 of file vhost-user.c.

+ Here is the caller graph for this function:

static void* map_user_mem ( vhost_user_intf_t vui,
uword  addr 
)
inlinestatic

Definition at line 222 of file vhost-user.c.

+ Here is the caller graph for this function:

clib_error_t* show_vhost_user_command_fn ( vlib_main_t vm,
unformat_input_t input,
vlib_cli_command_t cmd 
)

Definition at line 2252 of file vhost-user.c.

+ Here is the call graph for this function:

static void unmap_all_mem_regions ( vhost_user_intf_t vui)
static

Definition at line 247 of file vhost-user.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static clib_error_t* vhost_user_callfd_read_ready ( unix_file_t uf)
static

Definition at line 284 of file vhost-user.c.

+ Here is the caller graph for this function:

static clib_error_t* vhost_user_config ( vlib_main_t vm,
unformat_input_t input 
)
static

Definition at line 2430 of file vhost-user.c.

+ Here is the call graph for this function:

clib_error_t* vhost_user_connect_command_fn ( vlib_main_t vm,
unformat_input_t input,
vlib_cli_command_t cmd 
)

Definition at line 2112 of file vhost-user.c.

+ Here is the call graph for this function:

static void vhost_user_create_ethernet ( vnet_main_t vnm,
vlib_main_t vm,
vhost_user_intf_t vui,
u8 hwaddress 
)
static

Definition at line 1910 of file vhost-user.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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 
)

Definition at line 2021 of file vhost-user.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

clib_error_t* vhost_user_delete_command_fn ( vlib_main_t vm,
unformat_input_t input,
vlib_cli_command_t cmd 
)

Definition at line 2170 of file vhost-user.c.

+ Here is the call graph for this function:

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

Definition at line 1799 of file vhost-user.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

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

Definition at line 2199 of file vhost-user.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static clib_error_t* vhost_user_exit ( vlib_main_t vm)
static

Definition at line 914 of file vhost-user.c.

static void vhost_user_if_disconnect ( vhost_user_intf_t vui)
inlinestatic

Definition at line 293 of file vhost-user.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static u32 vhost_user_if_input ( vlib_main_t vm,
vhost_user_main_t vum,
vhost_user_intf_t vui,
vlib_node_runtime_t node 
)
static

Definition at line 1009 of file vhost-user.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static clib_error_t* vhost_user_init ( vlib_main_t vm)
static

Definition at line 872 of file vhost-user.c.

+ Here is the call graph for this function:

static int vhost_user_init_server_sock ( const char *  sock_filename,
int *  sockfd 
)
static

Definition at line 1835 of file vhost-user.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static uword vhost_user_input ( vlib_main_t vm,
vlib_node_runtime_t node,
vlib_frame_t f 
)
static

Definition at line 1344 of file vhost-user.c.

+ Here is the call graph for this function:

static clib_error_t* vhost_user_interface_admin_up_down ( vnet_main_t vnm,
u32  hw_if_index,
u32  flags 
)
static

Definition at line 1678 of file vhost-user.c.

+ Here is the call graph for this function:

static uword vhost_user_intfc_tx ( vlib_main_t vm,
vlib_node_runtime_t node,
vlib_frame_t frame 
)
static

Definition at line 1389 of file vhost-user.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void vhost_user_log_dirty_pages ( vhost_user_intf_t vui,
u64  addr,
u64  len 
)
inlinestatic

Definition at line 340 of file vhost-user.c.

+ Here is the caller graph for this function:

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 
)

Definition at line 2062 of file vhost-user.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static int vhost_user_name_renumber ( vnet_hw_interface_t hi,
u32  new_dev_instance 
)
static

Definition at line 137 of file vhost-user.c.

+ Here is the caller graph for this function:

void vhost_user_rx_trace ( vlib_main_t vm,
vlib_node_runtime_t node,
vhost_user_intf_t vui,
i16  virtqueue 
)

Definition at line 961 of file vhost-user.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static void vhost_user_send_call ( vlib_main_t vm,
vhost_user_vring_t vq 
)
inlinestatic

Definition at line 996 of file vhost-user.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static clib_error_t* vhost_user_socket_error ( unix_file_t uf)
static

Definition at line 811 of file vhost-user.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static clib_error_t* vhost_user_socket_read ( unix_file_t uf)
static

Definition at line 369 of file vhost-user.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static clib_error_t* vhost_user_socksvr_accept_ready ( unix_file_t uf)
static

Definition at line 832 of file vhost-user.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void vhost_user_unmap_all ( void  )

Definition at line 2454 of file vhost-user.c.

+ Here is the call graph for this function:

static void vhost_user_vui_init ( vnet_main_t vnm,
vhost_user_intf_t vui,
int  sockfd,
const char *  sock_filename,
u8  is_server,
u64  feature_mask,
u32 sw_if_index 
)
static

Definition at line 1949 of file vhost-user.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static vhost_user_intf_t* vhost_user_vui_new ( )
static

Definition at line 1881 of file vhost-user.c.

+ Here is the caller graph for this function:

static void vhost_user_vui_register ( vlib_main_t vm,
vhost_user_intf_t vui 
)
static

Definition at line 1994 of file vhost-user.c.

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

VLIB_DEVICE_TX_FUNCTION_MULTIARCH ( vhost_user_dev_class  ,
vhost_user_intfc_tx   
)

Definition at line 1708 of file vhost-user.c.

+ Here is the call graph for this function:

VNET_DEVICE_CLASS ( vhost_user_dev_class  ,
static   
)

+ Here is the caller graph for this function:

VNET_HW_INTERFACE_CLASS ( vhost_interface_class  ,
static   
)

Variable Documentation

vlib_cli_command_t show_vhost_user_command
static
Initial value:
= {
.path = "show vhost-user",
.short_help = "show vhost-user interface",
}
clib_error_t * show_vhost_user_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: vhost-user.c:2252

(constructor) VLIB_CLI_COMMAND (show_vhost_user_command)

Definition at line 2422 of file vhost-user.c.

vlib_cli_command_t vhost_user_connect_command
static
Initial value:
= {
.path = "create vhost-user",
.short_help = "create vhost-user socket <socket-filename> [server] [feature-mask <hex>] [renumber <dev_instance>]",
}
clib_error_t * vhost_user_connect_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: vhost-user.c:2112

(constructor) VLIB_CLI_COMMAND (vhost_user_connect_command)

Definition at line 2410 of file vhost-user.c.

vlib_cli_command_t vhost_user_delete_command
static
Initial value:
= {
.path = "delete vhost-user",
.short_help = "delete vhost-user sw_if_index <nn>",
}
clib_error_t * vhost_user_delete_command_fn(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: vhost-user.c:2170

(constructor) VLIB_CLI_COMMAND (vhost_user_delete_command)

Definition at line 2416 of file vhost-user.c.

char* vhost_user_input_func_error_strings[]
static
Initial value:
= {
#define _(n,s)
}
#define foreach_vhost_user_input_func_error
Definition: vhost-user.c:87

Definition at line 103 of file vhost-user.c.

vlib_node_registration_t vhost_user_input_node
Initial value:
= {
.function = vhost_user_input,
.name = "vhost-user-input",
.state = VLIB_NODE_STATE_DISABLED,
}
static uword vhost_user_input(vlib_main_t *vm, vlib_node_runtime_t *node, vlib_frame_t *f)
Definition: vhost-user.c:1344
static u8 * format_vhost_user_input_trace(u8 *s, va_list *va)
Definition: vhost-user.c:932
static char * vhost_user_input_func_error_strings[]
Definition: vhost-user.c:103
#define VNET_DEVICE_INPUT_NEXT_NODES
Definition: devices.h:32
u8 * format_ethernet_header_with_length(u8 *s, va_list *args)
Definition: format.c:115

(constructor) VLIB_REGISTER_NODE (vhost_user_input_node)

Definition at line 63 of file vhost-user.c.

vhost_user_main_t vhost_user_main
static
Initial value:
= {
.mtu_bytes = 1518,
}

Definition at line 110 of file vhost-user.c.

vlib_node_registration_t vhost_user_process_node
static
Initial value:
= {
.function = vhost_user_process,
.name = "vhost-user-process",
}

(constructor) VLIB_REGISTER_NODE (vhost_user_process_node)

Definition at line 1791 of file vhost-user.c.

char* vhost_user_tx_func_error_strings[]
static
Initial value:
= {
#define _(n,s)
}
#define foreach_vhost_user_tx_func_error
Definition: vhost-user.c:65

Definition at line 81 of file vhost-user.c.