vlib buffer structure definition and a few select access methods. More...

Include dependency graph for buffer.h:

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

Data Structures
struct	vlib_buffer_t

struct	vlib_buffer_free_list_t

struct	vlib_buffer_callbacks_t

struct	vlib_buffer_pool_t

struct	vlib_buffer_main_t

struct	vlib_serialize_buffer_main_t

Macros
#define	VLIB_BUFFER_DATA_SIZE (2048)

#define	VLIB_BUFFER_PRE_DATA_SIZE __PRE_DATA_SIZE

#define	foreach_vlib_buffer_flag
	Buffer Flags. More...

#define	LOG2_VLIB_BUFFER_FLAG_USER(n) (32 - (n))

#define	VLIB_BUFFER_FLAG_USER(n) (1 << LOG2_VLIB_BUFFER_FLAG_USER(n))

#define	VLIB_BUFFER_HDR_SIZE (sizeof(vlib_buffer_t) - VLIB_BUFFER_PRE_DATA_SIZE)

#define	vlib_prefetch_buffer_header(b, type) CLIB_PREFETCH (b, 64, type)
	Prefetch buffer metadata. More...

#define	VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX (0)

#define	VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES VLIB_BUFFER_DATA_SIZE

#define	VLIB_BUFFER_TRACE_TRAJECTORY 0
	Compile time buffer trajectory tracing option Turn this on if you run into "bad monkey" contexts, and you want to know exactly which nodes they've visited... More...

#define	VLIB_BUFFER_TRACE_TRAJECTORY_INIT(b)

#define	VLIB_BUFFER_REGISTER_CALLBACKS(x, ...)

Typedefs
typedef u8	vlib_buffer_free_list_index_t

typedef struct vlib_buffer_free_list_t	vlib_buffer_free_list_t

typedef uword(	vlib_buffer_fill_free_list_cb_t) (struct vlib_main_t vm, vlib_buffer_free_list_t fl, uword min_free_buffers)

typedef void(	vlib_buffer_free_cb_t) (struct vlib_main_t vm, u32 buffers, u32 n_buffers)

typedef void(	vlib_buffer_free_no_next_cb_t) (struct vlib_main_t vm, u32 buffers, u32 n_buffers)

Enumerations
enum	{ foreach_vlib_buffer_flag }

enum	{ foreach_vlib_buffer_flag }

Functions
static void	vlib_buffer_struct_is_sane (vlib_buffer_t *b)

static void *	vlib_buffer_get_current (vlib_buffer_t *b)
	Get pointer to current data to process. More...

static void	vlib_buffer_advance (vlib_buffer_t *b, word l)
	Advance current data pointer by the supplied (signed!) amount. More...

static u8	vlib_buffer_has_space (vlib_buffer_t *b, word l)
	Check if there is enough space in buffer to advance. More...

static void	vlib_buffer_reset (vlib_buffer_t *b)
	Reset current header & length to state they were in when packet was received. More...

static void *	vlib_get_buffer_opaque (vlib_buffer_t *b)
	Get pointer to buffer's opaque data array. More...

static void *	vlib_get_buffer_opaque2 (vlib_buffer_t *b)
	Get pointer to buffer's opaque2 data array. More...

static u8 *	vlib_buffer_get_tail (vlib_buffer_t *b)
	Get pointer to the end of buffer's data. More...

static void *	vlib_buffer_put_uninit (vlib_buffer_t *b, u8 size)
	Append uninitialized data to buffer. More...

static void *	vlib_buffer_push_uninit (vlib_buffer_t *b, u8 size)
	Prepend uninitialized data to buffer. More...

static void *	vlib_buffer_make_headroom (vlib_buffer_t *b, u8 size)
	Make head room, typically for packet headers. More...

static void *	vlib_buffer_pull (vlib_buffer_t *b, u8 size)
	Retrieve bytes from buffer head. More...

static_always_inline vlib_buffer_pool_t *	vlib_buffer_pool_get (u8 buffer_pool_index)

u8	vlib_buffer_pool_create (struct vlib_main_t *vm, vlib_physmem_region_index_t region, u16 buffer_size)

clib_error_t *	vlib_buffer_main_init (struct vlib_main_t *vm)

void	serialize_open_vlib_buffer (serialize_main_t m, struct vlib_main_t vm, vlib_serialize_buffer_main_t *sm)

void	unserialize_open_vlib_buffer (serialize_main_t m, struct vlib_main_t vm, vlib_serialize_buffer_main_t *sm)

u32	serialize_close_vlib_buffer (serialize_main_t *m)

void	unserialize_close_vlib_buffer (serialize_main_t *m)

void *	vlib_set_buffer_free_callback (struct vlib_main_t vm, void fp)

static u32	serialize_vlib_buffer_n_bytes (serialize_main_t *m)

Variables
vlib_buffer_callbacks_t *	vlib_buffer_callbacks

vlib_buffer_main_t	buffer_main

Detailed Description

vlib buffer structure definition and a few select access methods.

This structure and the buffer allocation mechanism should perhaps live in vnet, but it would take a lot of typing to make it so.

Definition in file buffer.h.

Macro Definition Documentation

foreach_vlib_buffer_flag

Value:

_( 0, NON_DEFAULT_FREELIST, "non-default-fl")           \
  _( 1, IS_TRACED, 0)                                   \
  _( 2, NEXT_PRESENT, 0)                                \
  _( 3, IS_RECYCLED, "is-recycled")                     \
  _( 4, TOTAL_LENGTH_VALID, 0)                          \
  _( 5, REPL_FAIL, "repl-fail")                         \
  _( 6, RECYCLE, "recycle")                             \
  _( 7, EXT_HDR_VALID, "ext-hdr-valid")

Buffer Flags.

Definition at line 66 of file buffer.h.

#define LOG2_VLIB_BUFFER_FLAG_USER ( n ) (32 - (n))

Definition at line 94 of file buffer.h.

#define VLIB_BUFFER_DATA_SIZE (2048)

Definition at line 51 of file buffer.h.

#define VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES VLIB_BUFFER_DATA_SIZE

Definition at line 440 of file buffer.h.

#define VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX (0)

Definition at line 439 of file buffer.h.

#define VLIB_BUFFER_FLAG_USER ( n ) (1 << LOG2_VLIB_BUFFER_FLAG_USER(n))

Definition at line 95 of file buffer.h.

#define VLIB_BUFFER_HDR_SIZE (sizeof(vlib_buffer_t) - VLIB_BUFFER_PRE_DATA_SIZE)

Definition at line 175 of file buffer.h.

#define VLIB_BUFFER_PRE_DATA_SIZE __PRE_DATA_SIZE

Definition at line 52 of file buffer.h.

#define VLIB_BUFFER_REGISTER_CALLBACKS	(	x,
		...
	)

Value:

__VA_ARGS__ vlib_buffer_callbacks_t __##x##_buffer_callbacks;       \
static void __vlib_add_buffer_callbacks_t_##x (void)                    \
    __attribute__((__constructor__)) ;                                  \
static void __vlib_add_buffer_callbacks_t_##x (void)                    \
{                                                                       \
    if (vlib_buffer_callbacks)                                          \
      clib_panic ("vlib buffer callbacks already registered");          \
    vlib_buffer_callbacks = &__##x##_buffer_callbacks;                  \
}                                                                       \
static void __vlib_rm_buffer_callbacks_t_##x (void)                     \
    __attribute__((__destructor__)) ;                                   \
static void __vlib_rm_buffer_callbacks_t_##x (void)                     \
{ vlib_buffer_callbacks = 0; }                                          \
__VA_ARGS__ vlib_buffer_callbacks_t __##x##_buffer_callbacks

Definition at line 551 of file buffer.h.

#define VLIB_BUFFER_TRACE_TRAJECTORY 0

Compile time buffer trajectory tracing option Turn this on if you run into "bad monkey" contexts, and you want to know exactly which nodes they've visited...

See vlib/main.c...

Definition at line 537 of file buffer.h.

#define VLIB_BUFFER_TRACE_TRAJECTORY_INIT ( b )

Definition at line 546 of file buffer.h.

#define vlib_prefetch_buffer_header	(	b,
		type
	)	CLIB_PREFETCH (b, 64, type)

Prefetch buffer metadata.

The first 64 bytes of buffer contains most header information

Parameters

b	- (vlib_buffer_t *) pointer to the buffer
type	- LOAD, STORE. In most cases, STORE is the right answer

Definition at line 184 of file buffer.h.

Typedef Documentation

typedef uword( vlib_buffer_fill_free_list_cb_t) (struct vlib_main_t *vm, vlib_buffer_free_list_t *fl, uword min_free_buffers)

Definition at line 381 of file buffer.h.

typedef void( vlib_buffer_free_cb_t) (struct vlib_main_t *vm, u32 *buffers, u32 n_buffers)

Definition at line 384 of file buffer.h.

typedef u8 vlib_buffer_free_list_index_t

Definition at line 54 of file buffer.h.

typedef struct vlib_buffer_free_list_t vlib_buffer_free_list_t

typedef void( vlib_buffer_free_no_next_cb_t) (struct vlib_main_t *vm, u32 *buffers, u32 n_buffers)

Definition at line 386 of file buffer.h.

Enumeration Type Documentation

anonymous enum

Enumerator
foreach_vlib_buffer_flag

Definition at line 79 of file buffer.h.

anonymous enum

Enumerator
foreach_vlib_buffer_flag

Definition at line 86 of file buffer.h.

Function Documentation

u32 serialize_close_vlib_buffer ( serialize_main_t * m )

Definition at line 204 of file buffer_serialize.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void serialize_open_vlib_buffer	(	serialize_main_t *	m,
		struct vlib_main_t *	vm,
		vlib_serialize_buffer_main_t *	sm
	)

Definition at line 190 of file buffer_serialize.c.

Here is the call graph for this function:

Here is the caller graph for this function:

static u32 serialize_vlib_buffer_n_bytes ( serialize_main_t * m )

inlinestatic

Definition at line 519 of file buffer.h.

Here is the caller graph for this function:

void unserialize_close_vlib_buffer ( serialize_main_t * m )

Definition at line 229 of file buffer_serialize.c.

Here is the call graph for this function:

Here is the caller graph for this function:

void unserialize_open_vlib_buffer	(	serialize_main_t *	m,
		struct vlib_main_t *	vm,
		vlib_serialize_buffer_main_t *	sm
	)

Definition at line 197 of file buffer_serialize.c.

Here is the call graph for this function:

Here is the caller graph for this function:

static void vlib_buffer_advance	(	vlib_buffer_t *	b,
		word	l
	)

inlinestatic

Advance current data pointer by the supplied (signed!) amount.

Parameters

b	- (vlib_buffer_t *) pointer to the buffer
l	- (word) signed increment

Definition at line 215 of file buffer.h.

static void* vlib_buffer_get_current ( vlib_buffer_t * b )

inlinestatic

Get pointer to current data to process.

Parameters

b	- (vlib_buffer_t *) pointer to the buffer

Returns: - (void *) (b->data + b->current_data)

Definition at line 202 of file buffer.h.

static u8* vlib_buffer_get_tail ( vlib_buffer_t * b )

inlinestatic

Get pointer to the end of buffer's data.

Parameters

b	pointer to the buffer

Returns: pointer to tail of packet's data

Definition at line 274 of file buffer.h.

Here is the caller graph for this function:

static u8 vlib_buffer_has_space	(	vlib_buffer_t *	b,
		word	l
	)

inlinestatic

Check if there is enough space in buffer to advance.

Parameters

b	- (vlib_buffer_t *) pointer to the buffer
l	- (word) size to check

Returns: - 0 if there is less space than 'l' in buffer

Definition at line 229 of file buffer.h.

Here is the caller graph for this function:

clib_error_t* vlib_buffer_main_init ( struct vlib_main_t * vm )

Definition at line 1018 of file buffer.c.

Here is the call graph for this function:

Here is the caller graph for this function:

static void* vlib_buffer_make_headroom	(	vlib_buffer_t *	b,
		u8	size
	)

inlinestatic

Make head room, typically for packet headers.

Parameters

b	pointer to the buffer
size	number of head room bytes

Returns: pointer to start of buffer (current data)

Definition at line 314 of file buffer.h.

Here is the call graph for this function:

Here is the caller graph for this function:

u8 vlib_buffer_pool_create	(	struct vlib_main_t *	vm,
		vlib_physmem_region_index_t	region,
		u16	buffer_size
	)

Definition at line 904 of file buffer.c.

Here is the call graph for this function:

Here is the caller graph for this function:

static_always_inline vlib_buffer_pool_t* vlib_buffer_pool_get ( u8 buffer_pool_index )

Definition at line 461 of file buffer.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static void* vlib_buffer_pull	(	vlib_buffer_t *	b,
		u8	size
	)

inlinestatic

Retrieve bytes from buffer head.

Parameters

b	pointer to the buffer
size	number of bytes to pull

Returns: pointer to start of buffer (current data)

Definition at line 327 of file buffer.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static void* vlib_buffer_push_uninit	(	vlib_buffer_t *	b,
		u8	size
	)

inlinestatic

Prepend uninitialized data to buffer.

Parameters

b	pointer to the buffer
size	number of uninitialized bytes

Returns: pointer to beginning of uninitialized data

Definition at line 299 of file buffer.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static void* vlib_buffer_put_uninit	(	vlib_buffer_t *	b,
		u8	size
	)

inlinestatic

Append uninitialized data to buffer.

Parameters

b	pointer to the buffer
size	number of uninitialized bytes

Returns: pointer to beginning of uninitialized data

Definition at line 285 of file buffer.h.

Here is the call graph for this function:

Here is the caller graph for this function:

static void vlib_buffer_reset ( vlib_buffer_t * b )

inlinestatic

Reset current header & length to state they were in when packet was received.

Parameters

b	- (vlib_buffer_t *) pointer to the buffer

Definition at line 241 of file buffer.h.

Here is the caller graph for this function:

static void vlib_buffer_struct_is_sane ( vlib_buffer_t * b )

inlinestatic

Definition at line 187 of file buffer.h.

static void* vlib_get_buffer_opaque ( vlib_buffer_t * b )

inlinestatic

Get pointer to buffer's opaque data array.

Parameters

b	- (vlib_buffer_t *) pointer to the buffer

Returns: - (void *) b->opaque

Definition at line 253 of file buffer.h.

static void* vlib_get_buffer_opaque2 ( vlib_buffer_t * b )

inlinestatic

Get pointer to buffer's opaque2 data array.

Parameters

b	- (vlib_buffer_t *) pointer to the buffer

Returns: - (void *) b->opaque2

Definition at line 264 of file buffer.h.

void* vlib_set_buffer_free_callback	(	struct vlib_main_t *	vm,
		void *	fp
	)

Definition at line 561 of file buffer.c.

Variable Documentation

vlib_buffer_main_t buffer_main

Definition at line 52 of file buffer.c.

vlib_buffer_callbacks_t* vlib_buffer_callbacks

Definition at line 49 of file buffer.c.

Data Structures

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation