 |
FD.io VPP
v18.01.2-1-g9b554f3
Vector Packet Processing
|
|
FD.io VPP
v18.01.2-1-g9b554f3
Vector Packet Processing
|
API main structure, used by both vpp and binary API clients. More...
Collaboration diagram for api_main_t:Data Fields | |
| void(** | msg_handlers )(void *) |
| Message handler vector. More... | |
| int(** | pd_msg_handlers )(void *, int) |
| Plaform-dependent (aka hardware) message handler vector. More... | |
| void(** | msg_cleanup_handlers )(void *) |
| non-default message cleanup handler vector More... | |
| void(** | msg_endian_handlers )(void *) |
| Message endian handler vector. More... | |
| void(** | msg_print_handlers )(void *, void *) |
| Message print function vector. More... | |
| const char ** | msg_names |
| Message name vector. More... | |
| u8 * | message_bounce |
| Don't automatically free message buffer vetor. More... | |
| u8 * | is_mp_safe |
| Message is mp safe vector. More... | |
| struct ring_alloc_ * | arings |
| Allocator ring vectors (in shared memory) More... | |
| u32 | ring_misses |
| Number of times that the ring allocator failed. More... | |
| u32 | garbage_collects |
| Number of garbage-collected message buffers. More... | |
| u32 | missing_clients |
| Number of missing clients / failed message sends. More... | |
| vl_api_trace_t * | rx_trace |
| Received message trace configuration. More... | |
| vl_api_trace_t * | tx_trace |
| Sent message trace configuration. More... | |
| int | msg_print_flag |
| Print every received message. More... | |
| trace_cfg_t * | api_trace_cfg |
| Current trace configuration. More... | |
| int | our_pid |
| Current process PID. More... | |
| svm_region_t * | vlib_rp |
| Current binary api segment descriptor. More... | |
| svm_region_t * | vlib_primary_rp |
| Primary api segment descriptor. More... | |
| svm_region_t ** | vlib_private_rps |
| Vector of all mapped shared-VM segments. More... | |
| svm_region_t ** | mapped_shmem_regions |
| struct vl_shmem_hdr_ * | shmem_hdr |
| Binary API shared-memory segment header pointer. More... | |
| vl_api_registration_t ** | vl_clients |
| vlib/vpp only: vector of client registrations More... | |
| u8 * | serialized_message_table_in_shmem |
| vlib/vpp only: serialized (message, name, crc) table More... | |
| u16 | first_available_msg_id |
| First available message ID, for theplugin msg allocator. More... | |
| uword * | msg_range_by_name |
| Message range by name hash. More... | |
| vl_api_msg_range_t * | msg_ranges |
| vector of message ranges More... | |
| int | api_uid |
| uid for the api shared memory region More... | |
| int | api_gid |
| gid for the api shared memory region More... | |
| u64 | global_baseva |
| base virtual address for global VM region More... | |
| u64 | global_size |
| size of the global VM region More... | |
| u64 | api_size |
| size of the API region More... | |
| u64 | global_pvt_heap_size |
| size of the global VM private mheap More... | |
| u64 | api_pvt_heap_size |
| size of the api private mheap More... | |
| unix_shared_memory_queue_t * | vl_input_queue |
| Peer input queue pointer. More... | |
| int | my_client_index |
| All VLIB-side message handlers use my_client_index to identify the queue / client. More... | |
| vl_api_registration_t * | my_registration |
| This is the (shared VM) address of the registration, don't use it to id the connection since it can't possibly work in simulator replay. More... | |
| i32 | vlib_signal |
| (Historical) signal-based queue non-empty signal, to be removed More... | |
| u32 | vlib_input_queue_length |
| vpp/vlib input queue length More... | |
| uword * | msg_index_by_name_and_crc |
| client message index hash table More... | |
| api_version_t * | api_version_list |
| api version list More... | |
| const char * | region_name |
| Shared VM binary API region name. More... | |
| const char * | root_path |
| Chroot path to the shared memory API files. More... | |
| int | replay_in_progress |
| Replay in progress? More... | |
| u8 * | save_msg_table_filename |
| Dump (msg-name, crc) snapshot here at startup. More... | |
| _vl_msg_api_function_list_elt_t * | reaper_function_registrations |
| List of API client reaper functions. More... | |
API main structure, used by both vpp and binary API clients.
Definition at line 198 of file api_common.h.
| int api_main_t::api_gid |
gid for the api shared memory region
Definition at line 282 of file api_common.h.
| u64 api_main_t::api_pvt_heap_size |
size of the api private mheap
Definition at line 297 of file api_common.h.
| u64 api_main_t::api_size |
size of the API region
Definition at line 291 of file api_common.h.
| trace_cfg_t* api_main_t::api_trace_cfg |
Current trace configuration.
Definition at line 245 of file api_common.h.
| int api_main_t::api_uid |
uid for the api shared memory region
Definition at line 279 of file api_common.h.
| api_version_t* api_main_t::api_version_list |
api version list
Definition at line 324 of file api_common.h.
| struct ring_alloc_* api_main_t::arings |
Allocator ring vectors (in shared memory)
Definition at line 224 of file api_common.h.
| u16 api_main_t::first_available_msg_id |
First available message ID, for theplugin msg allocator.
Definition at line 270 of file api_common.h.
| u32 api_main_t::garbage_collects |
Number of garbage-collected message buffers.
Definition at line 230 of file api_common.h.
| u64 api_main_t::global_baseva |
base virtual address for global VM region
Definition at line 285 of file api_common.h.
| u64 api_main_t::global_pvt_heap_size |
size of the global VM private mheap
Definition at line 294 of file api_common.h.
| u64 api_main_t::global_size |
size of the global VM region
Definition at line 288 of file api_common.h.
| u8* api_main_t::is_mp_safe |
Message is mp safe vector.
Definition at line 221 of file api_common.h.
| svm_region_t** api_main_t::mapped_shmem_regions |
Definition at line 258 of file api_common.h.
| u8* api_main_t::message_bounce |
Don't automatically free message buffer vetor.
Definition at line 218 of file api_common.h.
| u32 api_main_t::missing_clients |
Number of missing clients / failed message sends.
Definition at line 233 of file api_common.h.
| void(** api_main_t::msg_cleanup_handlers) (void *) |
non-default message cleanup handler vector
Definition at line 206 of file api_common.h.
| void(** api_main_t::msg_endian_handlers) (void *) |
Message endian handler vector.
Definition at line 209 of file api_common.h.
| void(** api_main_t::msg_handlers) (void *) |
Message handler vector.
Definition at line 201 of file api_common.h.
| uword* api_main_t::msg_index_by_name_and_crc |
client message index hash table
Definition at line 321 of file api_common.h.
| const char** api_main_t::msg_names |
Message name vector.
Definition at line 215 of file api_common.h.
| int api_main_t::msg_print_flag |
Print every received message.
Definition at line 242 of file api_common.h.
| void(** api_main_t::msg_print_handlers) (void *, void *) |
Message print function vector.
Definition at line 212 of file api_common.h.
| uword* api_main_t::msg_range_by_name |
Message range by name hash.
Definition at line 273 of file api_common.h.
| vl_api_msg_range_t* api_main_t::msg_ranges |
vector of message ranges
Definition at line 276 of file api_common.h.
| int api_main_t::my_client_index |
All VLIB-side message handlers use my_client_index to identify the queue / client.
This works in sim replay.
Definition at line 306 of file api_common.h.
| vl_api_registration_t* api_main_t::my_registration |
This is the (shared VM) address of the registration, don't use it to id the connection since it can't possibly work in simulator replay.
Definition at line 312 of file api_common.h.
| int api_main_t::our_pid |
Current process PID.
Definition at line 248 of file api_common.h.
| int(** api_main_t::pd_msg_handlers) (void *, int) |
Plaform-dependent (aka hardware) message handler vector.
Definition at line 203 of file api_common.h.
| _vl_msg_api_function_list_elt_t* api_main_t::reaper_function_registrations |
List of API client reaper functions.
Definition at line 339 of file api_common.h.
| const char* api_main_t::region_name |
Shared VM binary API region name.
Definition at line 327 of file api_common.h.
| int api_main_t::replay_in_progress |
Replay in progress?
Definition at line 333 of file api_common.h.
| u32 api_main_t::ring_misses |
Number of times that the ring allocator failed.
Definition at line 227 of file api_common.h.
| const char* api_main_t::root_path |
Chroot path to the shared memory API files.
Definition at line 330 of file api_common.h.
| vl_api_trace_t* api_main_t::rx_trace |
Received message trace configuration.
Definition at line 236 of file api_common.h.
| u8* api_main_t::save_msg_table_filename |
Dump (msg-name, crc) snapshot here at startup.
Definition at line 336 of file api_common.h.
| u8* api_main_t::serialized_message_table_in_shmem |
vlib/vpp only: serialized (message, name, crc) table
Definition at line 267 of file api_common.h.
| struct vl_shmem_hdr_* api_main_t::shmem_hdr |
Binary API shared-memory segment header pointer.
Definition at line 261 of file api_common.h.
| vl_api_trace_t* api_main_t::tx_trace |
Sent message trace configuration.
Definition at line 239 of file api_common.h.
| vl_api_registration_t** api_main_t::vl_clients |
vlib/vpp only: vector of client registrations
Definition at line 264 of file api_common.h.
| unix_shared_memory_queue_t* api_main_t::vl_input_queue |
Peer input queue pointer.
Definition at line 300 of file api_common.h.
| u32 api_main_t::vlib_input_queue_length |
vpp/vlib input queue length
Definition at line 318 of file api_common.h.
| svm_region_t* api_main_t::vlib_primary_rp |
Primary api segment descriptor.
Definition at line 254 of file api_common.h.
| svm_region_t** api_main_t::vlib_private_rps |
Vector of all mapped shared-VM segments.
Definition at line 257 of file api_common.h.
| svm_region_t* api_main_t::vlib_rp |
Current binary api segment descriptor.
Definition at line 251 of file api_common.h.
| i32 api_main_t::vlib_signal |
(Historical) signal-based queue non-empty signal, to be removed
Definition at line 315 of file api_common.h.
1.8.11 
