vlib buffer access methods. More...

Include dependency graph for buffer_funcs.h:

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

Data Structures
struct	vlib_packet_template_t

Macros
#define	vlib_prefetch_buffer_with_index(vm, bi, type)
	Prefetch buffer metadata by buffer index The first 64 bytes of buffer contains most header information. More...

Enumerations
enum	vlib_buffer_known_state_t { VLIB_BUFFER_UNKNOWN, VLIB_BUFFER_KNOWN_FREE, VLIB_BUFFER_KNOWN_ALLOCATED }

Functions
static vlib_buffer_t *	vlib_get_buffer (vlib_main_t *vm, u32 buffer_index)
	Translate buffer index into buffer pointer. More...

static u32	vlib_get_buffer_index (vlib_main_t vm, void p)
	Translate buffer pointer into buffer index. More...

static vlib_buffer_t *	vlib_get_next_buffer (vlib_main_t vm, vlib_buffer_t b)
	Get next buffer in buffer linklist, or zero for end of list. More...

uword	vlib_buffer_length_in_chain_slow_path (vlib_main_t vm, vlib_buffer_t b_first)

static uword	vlib_buffer_length_in_chain (vlib_main_t vm, vlib_buffer_t b)
	Get length in bytes of the buffer chain. More...

static uword	vlib_buffer_index_length_in_chain (vlib_main_t *vm, u32 bi)
	Get length in bytes of the buffer index buffer chain. More...

static uword	vlib_buffer_contents (vlib_main_t vm, u32 buffer_index, u8 contents)
	Copy buffer contents to memory. More...

static u64	vlib_get_buffer_data_physical_address (vlib_main_t *vm, u32 buffer_index)

static vlib_buffer_known_state_t	vlib_buffer_is_known (vlib_main_t *vm, u32 buffer_index)

static void	vlib_buffer_set_known_state (vlib_main_t *vm, u32 buffer_index, vlib_buffer_known_state_t state)

u8 *	vlib_validate_buffer (vlib_main_t *vm, u32 buffer_index, uword follow_chain)

clib_error_t *	vlib_buffer_pool_create (vlib_main_t *vm, unsigned num_mbufs, unsigned socket_id)

static u32	vlib_buffer_alloc (vlib_main_t vm, u32 buffers, u32 n_buffers)
	Allocate buffers into supplied array. More...

static u32	vlib_buffer_round_size (u32 size)

static u32	vlib_buffer_alloc_from_free_list (vlib_main_t vm, u32 buffers, u32 n_buffers, u32 free_list_index)
	Allocate buffers from specific freelist into supplied array. More...

static void	vlib_buffer_free (vlib_main_t vm, u32 buffers, u32 n_buffers)
	Free buffers Frees the entire buffer chain for each buffer. More...

static void	vlib_buffer_free_no_next (vlib_main_t vm, u32 buffers, u32 n_buffers)
	Free buffers, does not free the buffer chain for each buffer. More...

static void	vlib_buffer_free_one (vlib_main_t *vm, u32 buffer_index)
	Free one buffer Shorthand to free a single buffer chain. More...

u32	vlib_buffer_create_free_list (vlib_main_t vm, u32 n_data_bytes, char fmt,...)

static void	vlib_buffer_delete_free_list (vlib_main_t *vm, u32 free_list_index)

u32	vlib_buffer_get_or_create_free_list (vlib_main_t vm, u32 n_data_bytes, char fmt,...)

void	vlib_buffer_merge_free_lists (vlib_buffer_free_list_t dst, vlib_buffer_free_list_t src)

void	vlib_buffer_free_list_fill_unaligned (vlib_main_t vm, vlib_buffer_free_list_t free_list, uword n_unaligned_buffers)

static u32	vlib_buffer_get_free_list_with_size (vlib_main_t *vm, u32 size)

static vlib_buffer_free_list_t *	vlib_buffer_get_buffer_free_list (vlib_main_t vm, vlib_buffer_t b, u32 *index)

static vlib_buffer_free_list_t *	vlib_buffer_get_free_list (vlib_main_t *vm, u32 free_list_index)

static u32	vlib_buffer_free_list_buffer_size (vlib_main_t *vm, u32 free_list_index)

void	vlib_aligned_memcpy (void _dst, void _src, int n_bytes)

static void	vlib_copy_buffers (u32 dst, u32 src, u32 n)

static void *	vlib_physmem_alloc_aligned (vlib_main_t vm, clib_error_t *error, uword n_bytes, uword alignment)

static void *	vlib_physmem_alloc (vlib_main_t vm, clib_error_t *error, uword n_bytes)

static void	vlib_physmem_free (vlib_main_t vm, void mem)

static u64	vlib_physmem_virtual_to_physical (vlib_main_t vm, void mem)

u32	vlib_buffer_add_data (vlib_main_t vm, u32 free_list_index, u32 buffer_index, void data, u32 n_data_bytes)

static vlib_buffer_t *	vlib_buffer_copy (vlib_main_t vm, vlib_buffer_t b)

static u8	vlib_buffer_clone (vlib_main_t vm, u32 src_buffer, u32 buffers, u8 n_buffers, u16 head_end_offset)
	Create multiple clones of buffer and store them in the supplied array. More...

static void	vlib_buffer_attach_clone (vlib_main_t vm, vlib_buffer_t head, vlib_buffer_t *tail)
	Attach cloned tail to the buffer. More...

static void	vlib_buffer_chain_init (vlib_buffer_t *first)

static vlib_buffer_t *	vlib_buffer_chain_buffer (vlib_main_t vm, vlib_buffer_t first, vlib_buffer_t *last, u32 next_bi)

static void	vlib_buffer_chain_increase_length (vlib_buffer_t first, vlib_buffer_t last, i32 len)

static u16	vlib_buffer_chain_append_data (vlib_main_t vm, u32 free_list_index, vlib_buffer_t first, vlib_buffer_t last, void data, u16 data_len)

u16	vlib_buffer_chain_append_data_with_alloc (vlib_main_t vm, u32 free_list_index, vlib_buffer_t first, vlib_buffer_t *last, void data, u16 data_len)

void	vlib_buffer_chain_validate (vlib_main_t vm, vlib_buffer_t first)

void	vlib_packet_template_get_packet_helper (vlib_main_t vm, vlib_packet_template_t t)

void	vlib_packet_template_init (vlib_main_t vm, vlib_packet_template_t t, void packet_data, uword n_packet_data_bytes, uword min_n_buffers_each_physmem_alloc, char fmt,...)

void *	vlib_packet_template_get_packet (vlib_main_t vm, vlib_packet_template_t t, u32 *bi_result)

static void	vlib_packet_template_free (vlib_main_t vm, vlib_packet_template_t t)

static u32	unserialize_vlib_buffer_n_bytes (serialize_main_t *m)

static void	vlib_buffer_init_for_free_list (vlib_buffer_t dst, vlib_buffer_free_list_t fl)

static void	vlib_buffer_add_to_free_list (vlib_main_t vm, vlib_buffer_free_list_t f, u32 buffer_index, u8 do_init)

static void	vlib_buffer_init_two_for_free_list (vlib_buffer_t dst0, vlib_buffer_t dst1, vlib_buffer_free_list_t *fl)

static void	vlib_validate_buffer_in_use (vlib_buffer_t *b, u32 expected)

static void	vlib_validate_buffer_set_in_use (vlib_buffer_t *b, u32 expected)

Variables
format_function_t	format_vlib_buffer

format_function_t	format_vlib_buffer_and_data

format_function_t	format_vlib_buffer_contents

u32 *	vlib_buffer_state_validation_lock

uword *	vlib_buffer_state_validation_hash

void *	vlib_buffer_state_heap

Detailed Description

vlib buffer access methods.

Definition in file buffer_funcs.h.

Macro Definition Documentation

#define vlib_prefetch_buffer_with_index	(	vm,
		bi,
		type
	)

Value:

do {                                                    \
    vlib_buffer_t * _b = vlib_get_buffer (vm, bi);      \
    vlib_prefetch_buffer_header (_b, type);             \
  } while (0)

Prefetch buffer metadata by buffer index The first 64 bytes of buffer contains most header information.

Parameters

vm	- (vlib_main_t *) vlib main data structure pointer
bi	- (u32) buffer index
type	- LOAD, STORE. In most cases, STORE is the right answer

Definition at line 170 of file buffer_funcs.h.

Enumeration Type Documentation

enum vlib_buffer_known_state_t

Enumerator
VLIB_BUFFER_UNKNOWN
VLIB_BUFFER_KNOWN_FREE
VLIB_BUFFER_KNOWN_ALLOCATED

Definition at line 198 of file buffer_funcs.h.

Function Documentation

static u32 unserialize_vlib_buffer_n_bytes ( serialize_main_t * m )

inlinestatic

Definition at line 744 of file buffer_funcs.h.

Here is the call graph for this function:

Here is the caller graph for this function:

void vlib_aligned_memcpy	(	void *	_dst,
		void *	_src,
		int	n_bytes
	)

Here is the caller graph for this function:

u32 vlib_buffer_add_data	(	vlib_main_t *	vm,
		u32	free_list_index,
		u32	buffer_index,
		void *	data,
		u32	n_data_bytes
	)

Here is the caller graph for this function:

static void vlib_buffer_add_to_free_list	(	vlib_main_t *	vm,
		vlib_buffer_free_list_t *	f,
		u32	buffer_index,
		u8	do_init
	)

inlinestatic

Definition at line 812 of file buffer_funcs.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static u32 vlib_buffer_alloc	(	vlib_main_t *	vm,
		u32 *	buffers,
		u32	n_buffers
	)

inlinestatic

Allocate buffers into supplied array.

Parameters

vm	- (vlib_main_t *) vlib main data structure pointer
buffers	- (u32 * ) buffer index array
n_buffers	- (u32) number of buffers requested

Returns: - (u32) number of buffers actually allocated, may be less than the number requested or zero

Definition at line 245 of file buffer_funcs.h.

Here is the caller graph for this function:

static u32 vlib_buffer_alloc_from_free_list	(	vlib_main_t *	vm,
		u32 *	buffers,
		u32	n_buffers,
		u32	free_list_index
	)

inlinestatic

Allocate buffers from specific freelist into supplied array.

Parameters

vm	- (vlib_main_t *) vlib main data structure pointer
buffers	- (u32 * ) buffer index array
n_buffers	- (u32) number of buffers requested

Returns: - (u32) number of buffers actually allocated, may be less than the number requested or zero

Definition at line 269 of file buffer_funcs.h.

Here is the caller graph for this function:

static void vlib_buffer_attach_clone	(	vlib_main_t *	vm,
		vlib_buffer_t *	head,
		vlib_buffer_t *	tail
	)

inlinestatic

Attach cloned tail to the buffer.

Parameters

vm	- (vlib_main_t *) vlib main data structure pointer
head	- (vlib_buffer_t *) head buffer
tail	- (Vlib buffer_t *) tail buffer to clone and attach to head

Definition at line 610 of file buffer_funcs.h.

Here is the call graph for this function:

static u16 vlib_buffer_chain_append_data	(	vlib_main_t *	vm,
		u32	free_list_index,
		vlib_buffer_t *	first,
		vlib_buffer_t *	last,
		void *	data,
		u16	data_len
	)

inlinestatic

Definition at line 675 of file buffer_funcs.h.

Here is the call graph for this function:

u16 vlib_buffer_chain_append_data_with_alloc	(	vlib_main_t *	vm,
		u32	free_list_index,
		vlib_buffer_t *	first,
		vlib_buffer_t **	last,
		void *	data,
		u16	data_len
	)

Here is the caller graph for this function:

static vlib_buffer_t* vlib_buffer_chain_buffer	(	vlib_main_t *	vm,
		vlib_buffer_t *	first,
		vlib_buffer_t *	last,
		u32	next_bi
	)

inlinestatic

Definition at line 646 of file buffer_funcs.h.

Here is the call graph for this function:

static void vlib_buffer_chain_increase_length	(	vlib_buffer_t *	first,
		vlib_buffer_t *	last,
		i32	len
	)

inlinestatic

Definition at line 663 of file buffer_funcs.h.

Here is the caller graph for this function:

static void vlib_buffer_chain_init ( vlib_buffer_t * first )

inlinestatic

Definition at line 636 of file buffer_funcs.h.

void vlib_buffer_chain_validate	(	vlib_main_t *	vm,
		vlib_buffer_t *	first
	)

Here is the caller graph for this function:

static u8 vlib_buffer_clone	(	vlib_main_t *	vm,
		u32	src_buffer,
		u32 *	buffers,
		u8	n_buffers,
		u16	head_end_offset
	)

inlinestatic

Create multiple clones of buffer and store them in the supplied array.

Parameters

vm	- (vlib_main_t *) vlib main data structure pointer
src_buffer	- (u32) source buffer index
buffers	- (u32 * ) buffer index array
n_buffers	- (u8) number of buffer clones requested
head_end_offset	- (u16) offset relative to current position where packet head ends

Returns: - (u8) number of buffers actually cloned, may be less than the number requested or zero

Definition at line 543 of file buffer_funcs.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static uword vlib_buffer_contents	(	vlib_main_t *	vm,
		u32	buffer_index,
		u8 *	contents
	)

inlinestatic

Copy buffer contents to memory.

Parameters

vm	- (vlib_main_t *) vlib main data structure pointer
buffer_index	- (u32) buffer index
contents	- (u8 ) memory, must be large enough*

Returns: - (uword) length of buffer chain

Definition at line 131 of file buffer_funcs.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static vlib_buffer_t* vlib_buffer_copy	(	vlib_main_t *	vm,
		vlib_buffer_t *	b
	)

inlinestatic

Definition at line 475 of file buffer_funcs.h.

Here is the call graph for this function:

Here is the caller graph for this function:

u32 vlib_buffer_create_free_list	(	vlib_main_t *	vm,
		u32	n_data_bytes,
		char *	fmt,
			...
	)

Here is the caller graph for this function:

static void vlib_buffer_delete_free_list	(	vlib_main_t *	vm,
		u32	free_list_index
	)

inlinestatic

Definition at line 340 of file buffer_funcs.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static void vlib_buffer_free	(	vlib_main_t *	vm,
		u32 *	buffers,
		u32	n_buffers
	)

inlinestatic

Free buffers Frees the entire buffer chain for each buffer.

Parameters

vm	- (vlib_main_t *) vlib main data structure pointer
buffers	- (u32 * ) buffer index array
n_buffers	- (u32) number of buffers to free

Definition at line 290 of file buffer_funcs.h.

Here is the caller graph for this function:

static u32 vlib_buffer_free_list_buffer_size	(	vlib_main_t *	vm,
		u32	free_list_index
	)

inlinestatic

Definition at line 399 of file buffer_funcs.h.

Here is the call graph for this function:

Here is the caller graph for this function:

void vlib_buffer_free_list_fill_unaligned	(	vlib_main_t *	vm,
		vlib_buffer_free_list_t *	free_list,
		uword	n_unaligned_buffers
	)

Here is the caller graph for this function:

static void vlib_buffer_free_no_next	(	vlib_main_t *	vm,
		u32 *	buffers,
		u32	n_buffers
	)

inlinestatic

Free buffers, does not free the buffer chain for each buffer.

Parameters

vm	- (vlib_main_t *) vlib main data structure pointer
buffers	- (u32 * ) buffer index array
n_buffers	- (u32) number of buffers to free

Definition at line 311 of file buffer_funcs.h.

Here is the caller graph for this function:

static void vlib_buffer_free_one	(	vlib_main_t *	vm,
		u32	buffer_index
	)

inlinestatic

Free one buffer Shorthand to free a single buffer chain.

Parameters

vm	- (vlib_main_t *) vlib main data structure pointer
buffer_index	- (u32) buffer index to free

Definition at line 331 of file buffer_funcs.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static vlib_buffer_free_list_t* vlib_buffer_get_buffer_free_list	(	vlib_main_t *	vm,
		vlib_buffer_t *	b,
		u32 *	index
	)

inlinestatic

Definition at line 374 of file buffer_funcs.h.

Here is the caller graph for this function:

static vlib_buffer_free_list_t* vlib_buffer_get_free_list	(	vlib_main_t *	vm,
		u32	free_list_index
	)

inlinestatic

Definition at line 385 of file buffer_funcs.h.

Here is the caller graph for this function:

static u32 vlib_buffer_get_free_list_with_size	(	vlib_main_t *	vm,
		u32	size
	)

inlinestatic

Definition at line 364 of file buffer_funcs.h.

Here is the call graph for this function:

Here is the caller graph for this function:

u32 vlib_buffer_get_or_create_free_list	(	vlib_main_t *	vm,
		u32	n_data_bytes,
		char *	fmt,
			...
	)

Here is the caller graph for this function:

static uword vlib_buffer_index_length_in_chain	(	vlib_main_t *	vm,
		u32	bi
	)

inlinestatic

Get length in bytes of the buffer index buffer chain.

Parameters

vm	- (vlib_main_t *) vlib main data structure pointer
bi	- (u32) buffer index

Returns: - (uword) length of buffer chain

Definition at line 117 of file buffer_funcs.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static void vlib_buffer_init_for_free_list	(	vlib_buffer_t *	dst,
		vlib_buffer_free_list_t *	fl
	)

inlinestatic

Definition at line 777 of file buffer_funcs.h.

Here is the caller graph for this function:

static void vlib_buffer_init_two_for_free_list	(	vlib_buffer_t *	dst0,
		vlib_buffer_t *	dst1,
		vlib_buffer_free_list_t *	fl
	)

inlinestatic

Definition at line 824 of file buffer_funcs.h.

static vlib_buffer_known_state_t vlib_buffer_is_known	(	vlib_main_t *	vm,
		u32	buffer_index
	)

inlinestatic

Definition at line 209 of file buffer_funcs.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static uword vlib_buffer_length_in_chain	(	vlib_main_t *	vm,
		vlib_buffer_t *	b
	)

inlinestatic

Get length in bytes of the buffer chain.

Parameters

vm	- (vlib_main_t *) vlib main data structure pointer
b	- (void *) buffer pointer

Returns: - (uword) length of buffer chain

Definition at line 100 of file buffer_funcs.h.

Here is the call graph for this function:

uword vlib_buffer_length_in_chain_slow_path	(	vlib_main_t *	vm,
		vlib_buffer_t *	b_first
	)

Here is the caller graph for this function:

void vlib_buffer_merge_free_lists	(	vlib_buffer_free_list_t *	dst,
		vlib_buffer_free_list_t *	src
	)

Here is the caller graph for this function:

clib_error_t* vlib_buffer_pool_create	(	vlib_main_t *	vm,
		unsigned	num_mbufs,
		unsigned	socket_id
	)

Definition at line 430 of file buffer.c.

Here is the call graph for this function:

Here is the caller graph for this function:

static u32 vlib_buffer_round_size ( u32 size )

inlinestatic

Definition at line 255 of file buffer_funcs.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static void vlib_buffer_set_known_state	(	vlib_main_t *	vm,
		u32	buffer_index,
		vlib_buffer_known_state_t	state
	)

inlinestatic

Definition at line 219 of file buffer_funcs.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static void vlib_copy_buffers	(	u32 *	dst,
		u32 *	src,
		u32	n
	)

inlinestatic

Definition at line 410 of file buffer_funcs.h.

Here is the caller graph for this function:

static vlib_buffer_t* vlib_get_buffer	(	vlib_main_t *	vm,
		u32	buffer_index
	)

inlinestatic

Translate buffer index into buffer pointer.

Parameters

vm	- (vlib_main_t *) vlib main data structure pointer
buffer_index	- (u32) buffer index

Returns: - (vlib_buffer_t *) buffer pointer

Definition at line 57 of file buffer_funcs.h.

Here is the call graph for this function:

static u64 vlib_get_buffer_data_physical_address	(	vlib_main_t *	vm,
		u32	buffer_index
	)

inlinestatic

Definition at line 153 of file buffer_funcs.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static u32 vlib_get_buffer_index	(	vlib_main_t *	vm,
		void *	p
	)

inlinestatic

Translate buffer pointer into buffer index.

Parameters

vm	- (vlib_main_t *) vlib main data structure pointer
p	- (void *) buffer pointer

Returns: - (u32) buffer index

Definition at line 70 of file buffer_funcs.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static vlib_buffer_t* vlib_get_next_buffer	(	vlib_main_t *	vm,
		vlib_buffer_t *	b
	)

inlinestatic

Get next buffer in buffer linklist, or zero for end of list.

Parameters

vm	- (vlib_main_t *) vlib main data structure pointer
b	- (void *) buffer pointer

Returns: - (vlib_buffer_t *) next buffer, or NULL

Definition at line 84 of file buffer_funcs.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static void vlib_packet_template_free	(	vlib_main_t *	vm,
		vlib_packet_template_t *	t
	)

inlinestatic

Definition at line 738 of file buffer_funcs.h.

void* vlib_packet_template_get_packet	(	vlib_main_t *	vm,
		vlib_packet_template_t *	t,
		u32 *	bi_result
	)

Here is the caller graph for this function:

void vlib_packet_template_get_packet_helper	(	vlib_main_t *	vm,
		vlib_packet_template_t *	t
	)

void vlib_packet_template_init	(	vlib_main_t *	vm,
		vlib_packet_template_t *	t,
		void *	packet_data,
		uword	n_packet_data_bytes,
		uword	min_n_buffers_each_physmem_alloc,
		char *	fmt,
			...
	)

Here is the caller graph for this function:

static void* vlib_physmem_alloc	(	vlib_main_t *	vm,
		clib_error_t **	error,
		uword	n_bytes
	)

inlinestatic

Definition at line 448 of file buffer_funcs.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static void* vlib_physmem_alloc_aligned	(	vlib_main_t *	vm,
		clib_error_t **	error,
		uword	n_bytes,
		uword	alignment
	)

inlinestatic

Definition at line 432 of file buffer_funcs.h.

Here is the caller graph for this function:

static void vlib_physmem_free	(	vlib_main_t *	vm,
		void *	mem
	)

inlinestatic

Definition at line 455 of file buffer_funcs.h.

static u64 vlib_physmem_virtual_to_physical	(	vlib_main_t *	vm,
		void *	mem
	)

inlinestatic

Definition at line 461 of file buffer_funcs.h.

Here is the call graph for this function:

Here is the caller graph for this function:

u8* vlib_validate_buffer	(	vlib_main_t *	vm,
		u32	buffer_index,
		uword	follow_chain
	)

Here is the caller graph for this function:

static void vlib_validate_buffer_in_use	(	vlib_buffer_t *	b,
		u32	expected
	)

inlinestatic

Definition at line 868 of file buffer_funcs.h.

Here is the call graph for this function:

static void vlib_validate_buffer_set_in_use	(	vlib_buffer_t *	b,
		u32	expected
	)

inlinestatic

Definition at line 912 of file buffer_funcs.h.

Here is the call graph for this function:

Variable Documentation

format_function_t format_vlib_buffer

Definition at line 705 of file buffer_funcs.h.

format_function_t format_vlib_buffer_and_data

Definition at line 705 of file buffer_funcs.h.

format_function_t format_vlib_buffer_contents

Definition at line 705 of file buffer_funcs.h.

void* vlib_buffer_state_heap

Definition at line 546 of file buffer.c.

uword* vlib_buffer_state_validation_hash

Definition at line 545 of file buffer.c.

u32* vlib_buffer_state_validation_lock

Definition at line 544 of file buffer.c.

Data Structures

Macros

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation