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...

svm_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...

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...

Detailed Description

API main structure, used by both vpp and binary API clients.

Definition at line 202 of file api_common.h.

Field Documentation

◆ api_gid

int api_main_t::api_gid

gid for the api shared memory region

Definition at line 286 of file api_common.h.

◆ api_pvt_heap_size

u64 api_main_t::api_pvt_heap_size

size of the api private mheap

Definition at line 301 of file api_common.h.

◆ api_size

u64 api_main_t::api_size

size of the API region

Definition at line 295 of file api_common.h.

◆ api_trace_cfg

trace_cfg_t* api_main_t::api_trace_cfg

Current trace configuration.

Definition at line 249 of file api_common.h.

◆ api_uid

int api_main_t::api_uid

uid for the api shared memory region

Definition at line 283 of file api_common.h.

◆ api_version_list

api_version_t* api_main_t::api_version_list

api version list

Definition at line 325 of file api_common.h.

◆ arings

struct ring_alloc_* api_main_t::arings

Allocator ring vectors (in shared memory)

Definition at line 228 of file api_common.h.

◆ first_available_msg_id

u16 api_main_t::first_available_msg_id

First available message ID, for theplugin msg allocator.

Definition at line 274 of file api_common.h.

◆ garbage_collects

u32 api_main_t::garbage_collects

Number of garbage-collected message buffers.

Definition at line 234 of file api_common.h.

◆ global_baseva

u64 api_main_t::global_baseva

base virtual address for global VM region

Definition at line 289 of file api_common.h.

◆ global_pvt_heap_size

u64 api_main_t::global_pvt_heap_size

size of the global VM private mheap

Definition at line 298 of file api_common.h.

◆ global_size

u64 api_main_t::global_size

size of the global VM region

Definition at line 292 of file api_common.h.

◆ is_mp_safe

u8* api_main_t::is_mp_safe

Message is mp safe vector.

Definition at line 225 of file api_common.h.

◆ mapped_shmem_regions

svm_region_t** api_main_t::mapped_shmem_regions

Definition at line 262 of file api_common.h.

◆ message_bounce

u8* api_main_t::message_bounce

Don't automatically free message buffer vetor.

Definition at line 222 of file api_common.h.

◆ missing_clients

u32 api_main_t::missing_clients

Number of missing clients / failed message sends.

Definition at line 237 of file api_common.h.

◆ msg_cleanup_handlers

void(** api_main_t::msg_cleanup_handlers) (void *)

non-default message cleanup handler vector

Definition at line 210 of file api_common.h.

◆ msg_endian_handlers

void(** api_main_t::msg_endian_handlers) (void *)

Message endian handler vector.

Definition at line 213 of file api_common.h.

◆ msg_handlers

void(** api_main_t::msg_handlers) (void *)

Message handler vector.

Definition at line 205 of file api_common.h.

◆ msg_index_by_name_and_crc

uword* api_main_t::msg_index_by_name_and_crc

client message index hash table

Definition at line 322 of file api_common.h.

◆ msg_names

const char** api_main_t::msg_names

Message name vector.

Definition at line 219 of file api_common.h.

◆ msg_print_flag

int api_main_t::msg_print_flag

Print every received message.

Definition at line 246 of file api_common.h.

◆ msg_print_handlers

void(** api_main_t::msg_print_handlers) (void *, void *)

Message print function vector.

Definition at line 216 of file api_common.h.

◆ msg_range_by_name

uword* api_main_t::msg_range_by_name

Message range by name hash.

Definition at line 277 of file api_common.h.

◆ msg_ranges

vl_api_msg_range_t* api_main_t::msg_ranges

vector of message ranges

Definition at line 280 of file api_common.h.

◆ my_client_index

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 310 of file api_common.h.

◆ my_registration

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 316 of file api_common.h.

◆ our_pid

int api_main_t::our_pid

Current process PID.

Definition at line 252 of file api_common.h.

◆ pd_msg_handlers

int(** api_main_t::pd_msg_handlers) (void *, int)

Plaform-dependent (aka hardware) message handler vector.

Definition at line 207 of file api_common.h.

◆ reaper_function_registrations

_vl_msg_api_function_list_elt_t* api_main_t::reaper_function_registrations

List of API client reaper functions.

Definition at line 340 of file api_common.h.

◆ region_name

const char* api_main_t::region_name

Shared VM binary API region name.

Definition at line 328 of file api_common.h.

◆ replay_in_progress

int api_main_t::replay_in_progress

Replay in progress?

Definition at line 334 of file api_common.h.

◆ ring_misses

u32 api_main_t::ring_misses

Number of times that the ring allocator failed.

Definition at line 231 of file api_common.h.

◆ root_path

const char* api_main_t::root_path

Chroot path to the shared memory API files.

Definition at line 331 of file api_common.h.

◆ rx_trace

vl_api_trace_t* api_main_t::rx_trace

Received message trace configuration.

Definition at line 240 of file api_common.h.

◆ save_msg_table_filename

u8* api_main_t::save_msg_table_filename

Dump (msg-name, crc) snapshot here at startup.

Definition at line 337 of file api_common.h.

◆ serialized_message_table_in_shmem

u8* api_main_t::serialized_message_table_in_shmem

vlib/vpp only: serialized (message, name, crc) table

Definition at line 271 of file api_common.h.

◆ shmem_hdr

struct vl_shmem_hdr_* api_main_t::shmem_hdr

Binary API shared-memory segment header pointer.

Definition at line 265 of file api_common.h.

◆ tx_trace

vl_api_trace_t* api_main_t::tx_trace

Sent message trace configuration.

Definition at line 243 of file api_common.h.

◆ vl_clients

vl_api_registration_t** api_main_t::vl_clients

vlib/vpp only: vector of client registrations

Definition at line 268 of file api_common.h.

◆ vl_input_queue

svm_queue_t* api_main_t::vl_input_queue

Peer input queue pointer.

Definition at line 304 of file api_common.h.

◆ vlib_input_queue_length

u32 api_main_t::vlib_input_queue_length

vpp/vlib input queue length

Definition at line 319 of file api_common.h.

◆ vlib_primary_rp

svm_region_t* api_main_t::vlib_primary_rp

Primary api segment descriptor.

Definition at line 258 of file api_common.h.

◆ vlib_private_rps

svm_region_t** api_main_t::vlib_private_rps

Vector of all mapped shared-VM segments.

Definition at line 261 of file api_common.h.

◆ vlib_rp

svm_region_t* api_main_t::vlib_rp

Current binary api segment descriptor.

Definition at line 255 of file api_common.h.

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

src/vlibapi/api_common.h

Data Fields