FD.io VPP  v21.10.1-2-g0a485f517
Vector Packet Processing
vl_api_memif_create_t Struct Reference

Create memory interface. More...

Data Fields

u32 client_index
 
u32 context
 
vl_api_memif_role_t role
 
vl_api_memif_mode_t mode
 
u8 rx_queues
 
u8 tx_queues
 
u32 id
 
u32 socket_id
 
u32 ring_size
 
u16 buffer_size
 
bool no_zero_copy
 
vl_api_mac_address_t hw_addr
 
string secret [24]
 
option vat_help = "[id <id>] [socket-id <id>] [ring_size <size>] [buffer_size <size>] [hw_addr <mac_address>] [secret <string>] [mode ip] <master|slave>"
 

Detailed Description

Create memory interface.

Template Parameters
client_index- opaque cookie to identify the sender
context- sender context, to match reply w/ request
role- role of the interface in the connection (master/slave)
mode- interface mode
rx_queues- number of rx queues (only valid for slave)
tx_queues- number of tx queues (only valid for slave)
id- 32bit integer used to authenticate and match opposite sides of the connection
socket_id- socket filename id to be used for connection establishment
ring_size- the number of entries of RX/TX rings
buffer_size- size of the buffer allocated for each ring entry
no_zero_copy- if true, disable zero copy
hw_addr- interface MAC address
secret- optional, default is "", max length 24

Definition at line 71 of file memif.api.

Field Documentation

◆ buffer_size

u16 vl_api_memif_create_t::buffer_size

Definition at line 83 of file memif.api.

◆ client_index

u32 vl_api_memif_create_t::client_index

Definition at line 73 of file memif.api.

◆ context

u32 vl_api_memif_create_t::context

Definition at line 74 of file memif.api.

◆ hw_addr

vl_api_mac_address_t vl_api_memif_create_t::hw_addr

Definition at line 85 of file memif.api.

◆ id

u32 vl_api_memif_create_t::id

Definition at line 80 of file memif.api.

◆ mode

vl_api_memif_mode_t vl_api_memif_create_t::mode

Definition at line 77 of file memif.api.

◆ no_zero_copy

bool vl_api_memif_create_t::no_zero_copy

Definition at line 84 of file memif.api.

◆ ring_size

u32 vl_api_memif_create_t::ring_size

Definition at line 82 of file memif.api.

◆ role

vl_api_memif_role_t vl_api_memif_create_t::role

Definition at line 76 of file memif.api.

◆ rx_queues

u8 vl_api_memif_create_t::rx_queues

Definition at line 78 of file memif.api.

◆ secret

string vl_api_memif_create_t::secret[24]

Definition at line 86 of file memif.api.

◆ socket_id

u32 vl_api_memif_create_t::socket_id

Definition at line 81 of file memif.api.

◆ tx_queues

u8 vl_api_memif_create_t::tx_queues

Definition at line 79 of file memif.api.

◆ vat_help

option vl_api_memif_create_t::vat_help = "[id <id>] [socket-id <id>] [ring_size <size>] [buffer_size <size>] [hw_addr <mac_address>] [secret <string>] [mode ip] <master|slave>"

Definition at line 87 of file memif.api.


The documentation for this struct was generated from the following file: