api.h File Reference

Include dependency graph for api.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	vl_api_registration_
struct	trace_cfg_t
struct	vl_api_trace_t
struct	vl_api_msg_range_t
struct	api_main_t
struct	vl_msg_api_msg_config_t
struct	msgbuf_

Macros
#define	VL_API_LITTLE_ENDIAN   0x00
#define	VL_API_BIG_ENDIAN   0x01
#define	VLIB_API_INIT_FUNCTION(x)   VLIB_DECLARE_INIT_FUNCTION(x,api_init)

Typedefs
typedef struct vl_api_registration_	vl_api_registration_t
typedef struct msgbuf_	msgbuf_t

Enumerations
enum	vl_registration_type_t {   REGISTRATION_TYPE_FREE = 0, REGISTRATION_TYPE_SHMEM, REGISTRATION_TYPE_SOCKET_LISTEN, REGISTRATION_TYPE_SOCKET_SERVER,   REGISTRATION_TYPE_SOCKET_CLIENT }
enum	vl_api_trace_which_t { VL_API_TRACE_TX, VL_API_TRACE_RX }

Functions
typedef	CLIB_PACKED (struct{u8 endian;u8 wrapped;u32 nitems;}) vl_api_trace_file_header_t
int	vl_msg_api_rx_trace_enabled (api_main_t *am)
int	vl_msg_api_tx_trace_enabled (api_main_t *am)
void	vl_msg_api_trace (api_main_t *am, vl_api_trace_t *tp, void *msg)
int	vl_msg_api_trace_onoff (api_main_t *am, vl_api_trace_which_t which, int onoff)
int	vl_msg_api_trace_free (api_main_t *am, vl_api_trace_which_t which)
int	vl_msg_api_trace_save (api_main_t *am, vl_api_trace_which_t which, FILE *fp)
int	vl_msg_api_trace_configure (api_main_t *am, vl_api_trace_which_t which, u32 nitems)
void	vl_msg_api_handler_with_vm_node (api_main_t *am, void *the_msg, vlib_main_t *vm, vlib_node_runtime_t *node)
void	vl_msg_api_handler (void *the_msg)
void	vl_msg_api_handler_no_free (void *the_msg)
void	vl_msg_api_handler_no_trace_no_free (void *the_msg)
void	vl_msg_api_trace_only (void *the_msg)
void	vl_msg_api_cleanup_handler (void *the_msg)
void	vl_msg_api_replay_handler (void *the_msg)
void	vl_msg_api_socket_handler (void *the_msg)
void	vl_msg_api_set_handlers (int msg_id, char *msg_name, void *handler, void *cleanup, void *endian, void *print, int msg_size, int traced)
void	vl_msg_api_config (vl_msg_api_msg_config_t *)
void	vl_msg_api_set_cleanup_handler (int msg_id, void *fp)
void	vl_msg_api_queue_handler (unix_shared_memory_queue_t *q)
vl_api_trace_t *	vl_msg_api_trace_get (api_main_t *am, vl_api_trace_which_t which)
void	vl_msg_api_free (void *)
void	vl_noop_handler (void *mp)
clib_error_t *	vl_api_init (vlib_main_t *vm)
void	vl_msg_api_increment_missing_client_counter (void)
void	vl_msg_api_post_mortem_dump (void)
void	vl_msg_api_register_pd_handler (void *handler, u16 msg_id_host_byte_order)
int	vl_msg_api_pd_handler (void *mp, int rv)
void	vl_msg_api_set_first_available_msg_id (u16 first_avail)
u16	vl_msg_api_get_msg_ids (char *name, int n)
void	vl_msg_api_add_msg_name_crc (api_main_t *am, char *string, u32 id)
u32	vl_api_get_msg_index (u8 *name_and_crc)
u8 *	vlib_node_serialize (vlib_node_main_t *nm, u8 *vector, u32 max_threads, int include_nexts, int include_stats)
vlib_node_t **	vlib_node_unserialize (u8 *vector)

Variables
api_main_t	api_main

Macro Definition Documentation

#define VL_API_BIG_ENDIAN   0x01

Definition at line 106 of file api.h.

#define VL_API_LITTLE_ENDIAN   0x00

Definition at line 105 of file api.h.

#define VLIB_API_INIT_FUNCTION

(

x

)

VLIB_DECLARE_INIT_FUNCTION(x,api_init)

Definition at line 271 of file api.h.

Typedef Documentation

typedef struct msgbuf_ msgbuf_t

typedef struct vl_api_registration_ vl_api_registration_t

Enumeration Type Documentation

enum vl_api_trace_which_t

Enumerator
VL_API_TRACE_TX
VL_API_TRACE_RX

Definition at line 99 of file api.h.

enum vl_registration_type_t

Enumerator
REGISTRATION_TYPE_FREE
REGISTRATION_TYPE_SHMEM
REGISTRATION_TYPE_SOCKET_LISTEN
REGISTRATION_TYPE_SOCKET_SERVER
REGISTRATION_TYPE_SOCKET_CLIENT

Definition at line 29 of file api.h.

Function Documentation

typedef CLIB_PACKED

(

struct{u8 endian;u8 wrapped;u32 nitems;}

)

u32 vl_api_get_msg_index

(

u8 *

name_and_crc

)

Definition at line 588 of file memory_shared.c.

Here is the caller graph for this function:

clib_error_t* vl_api_init

(

vlib_main_t *

vm

)

Definition at line 748 of file api_shared.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void vl_msg_api_add_msg_name_crc	(	api_main_t *	am,
		char *	string,
		u32	id
	)

Definition at line 1353 of file api_shared.c.

void vl_msg_api_cleanup_handler

(

void *

the_msg

)

Definition at line 598 of file api_shared.c.

Here is the call graph for this function:

void vl_msg_api_config

(

vl_msg_api_msg_config_t *

)

Definition at line 660 of file api_shared.c.

Here is the caller graph for this function:

void vl_msg_api_free

(

void *

)

Definition at line 188 of file memory_shared.c.

Here is the caller graph for this function:

u16 vl_msg_api_get_msg_ids	(	char *	name,
		int	n
	)

Definition at line 1309 of file api_shared.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void vl_msg_api_handler

(

void *

the_msg

)

Definition at line 549 of file api_shared.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void vl_msg_api_handler_no_free

(

void *

the_msg

)

Definition at line 344 of file threads.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void vl_msg_api_handler_no_trace_no_free

(

void *

the_msg

)

Definition at line 570 of file api_shared.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void vl_msg_api_handler_with_vm_node	(	api_main_t *	am,
		void *	the_msg,
		vlib_main_t *	vm,
		vlib_node_runtime_t *	node
	)

Definition at line 473 of file api_shared.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void vl_msg_api_increment_missing_client_counter

(

void

)

Definition at line 54 of file api_shared.c.

Here is the caller graph for this function:

int vl_msg_api_pd_handler	(	void *	mp,
		int	rv
	)

Definition at line 1280 of file api_shared.c.

void vl_msg_api_post_mortem_dump

(

void

)

Definition at line 1231 of file api_shared.c.

void vl_msg_api_queue_handler

(

unix_shared_memory_queue_t *

q

)

Definition at line 720 of file api_shared.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void vl_msg_api_register_pd_handler	(	void *	handler,
		u16	msg_id_host_byte_order
	)

Definition at line 1266 of file api_shared.c.

void vl_msg_api_replay_handler

(

void *

the_msg

)

Definition at line 618 of file api_shared.c.

int vl_msg_api_rx_trace_enabled

(

api_main_t *

am

)

Definition at line 69 of file api_shared.c.

void vl_msg_api_set_cleanup_handler	(	int	msg_id,
		void *	fp
	)

Definition at line 710 of file api_shared.c.

void vl_msg_api_set_first_available_msg_id

(

u16

first_avail

)

Definition at line 1301 of file api_shared.c.

Here is the caller graph for this function:

void vl_msg_api_set_handlers	(	int	msg_id,
		char *	msg_name,
		void *	handler,
		void *	cleanup,
		void *	endian,
		void *	print,
		int	msg_size,
		int	traced
	)

Definition at line 688 of file api_shared.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void vl_msg_api_socket_handler

(

void *

the_msg

)

Definition at line 639 of file api_shared.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void vl_msg_api_trace	(	api_main_t *	am,
		vl_api_trace_t *	tp,
		void *	msg
	)

Definition at line 84 of file api_shared.c.

Here is the caller graph for this function:

int vl_msg_api_trace_configure	(	api_main_t *	am,
		vl_api_trace_which_t	which,
		u32	nitems
	)

Definition at line 340 of file api_shared.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int vl_msg_api_trace_free	(	api_main_t *	am,
		vl_api_trace_which_t	which
	)

Definition at line 172 of file api_shared.c.

Here is the caller graph for this function:

vl_api_trace_t* vl_msg_api_trace_get	(	api_main_t *	am,
		vl_api_trace_which_t	which
	)

Definition at line 729 of file api_shared.c.

void vl_msg_api_trace_only

(

void *

the_msg

)

Definition at line 587 of file api_shared.c.

Here is the call graph for this function:

int vl_msg_api_trace_onoff	(	api_main_t *	am,
		vl_api_trace_which_t	which,
		int	onoff
	)

Definition at line 130 of file api_shared.c.

Here is the call graph for this function:

Here is the caller graph for this function:

int vl_msg_api_trace_save	(	api_main_t *	am,
		vl_api_trace_which_t	which,
		FILE *	fp
	)

Definition at line 209 of file api_shared.c.

Here is the caller graph for this function:

int vl_msg_api_tx_trace_enabled

(

api_main_t *

am

)

Definition at line 75 of file api_shared.c.

void vl_noop_handler

(

void *

mp

)

Definition at line 743 of file api_shared.c.

Here is the caller graph for this function:

u8* vlib_node_serialize	(	vlib_node_main_t *	nm,
		u8 *	vector,
		u32	max_threads,
		int	include_nexts,
		int	include_stats
	)

Definition at line 55 of file node_serialize.c.

Here is the call graph for this function:

Here is the caller graph for this function:

vlib_node_t** vlib_node_unserialize

(

u8 *

vector

)

Definition at line 217 of file node_serialize.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

api_main_t api_main

Definition at line 39 of file api_shared.c.