OpenVPN: src/openvpn/mbuf.h File Reference

OpenVPN

#include "basic.h"
#include "buffer.h"

Include dependency graph for mbuf.h:

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

Go to the source code of this file.

Data Structures
struct	mbuf_buffer
struct	mbuf_item
struct	mbuf_set

Macros
#define	MBUF_INDEX(head, offset, size)
#define	MBUF_SIZE_MAX (ALLOC_SIZE_MAX / sizeof(struct mbuf_item))
#define	MF_UNICAST (1 << 0)

Functions
struct mbuf_set *	mbuf_init (unsigned int size)
void	mbuf_free (struct mbuf_set *ms)
struct mbuf_buffer *	mbuf_alloc_buf (const struct buffer *buf)
void	mbuf_free_buf (struct mbuf_buffer *mb)
void	mbuf_add_item (struct mbuf_set ms, const struct mbuf_item item)
bool	mbuf_extract_item (struct mbuf_set ms, struct mbuf_item item)
void	mbuf_dereference_instance (struct mbuf_set ms, const struct multi_instance mi)
static bool	mbuf_defined (const struct mbuf_set *ms)
static unsigned int	mbuf_len (const struct mbuf_set *ms)
static int	mbuf_maximum_queued (const struct mbuf_set *ms)
struct multi_instance *	mbuf_peek_dowork (struct mbuf_set *ms)
static struct multi_instance *	mbuf_peek (struct mbuf_set *ms)

Macro Definition Documentation

◆ MBUF_INDEX

#define MBUF_INDEX	(		head,
			offset,
			size )

Value:

(((head) + (offset)) & ((size) - 1))

Definition at line 38 of file mbuf.h.

Referenced by mbuf_add_item(), mbuf_dereference_instance(), mbuf_extract_item(), mbuf_free(), mbuf_peek_dowork(), and mbuf_reclaim_head().

◆ MBUF_SIZE_MAX

#define MBUF_SIZE_MAX (ALLOC_SIZE_MAX / sizeof(struct mbuf_item))

Definition at line 40 of file mbuf.h.

Referenced by add_option(), mbuf_init(), and test_mbuf_init().

◆ MF_UNICAST

#define MF_UNICAST (1 << 0)

Definition at line 47 of file mbuf.h.

Referenced by multi_get_queue(), and multi_unicast().

Function Documentation

◆ mbuf_add_item()

void mbuf_add_item	(	struct mbuf_set *	ms,
		const struct mbuf_item *	item )

Definition at line 104 of file mbuf.c.

References mbuf_set::array, ASSERT, mbuf_item::buffer, mbuf_set::capacity, D_MULTI_DROPPED, mbuf_set::head, mbuf_set::len, mbuf_set::max_queued, mbuf_extract_item(), mbuf_free_buf(), MBUF_INDEX, msg, and mbuf_buffer::refcount.

Referenced by multi_add_mbuf(), multi_io_write_link(), test_mbuf_add_on_full_queue_with_holes(), test_mbuf_add_remove(), test_mbuf_dereference_reclaims_queue(), test_mbuf_extract_reclaims_tail(), and test_mbuf_extract_reclaims_up_to_live().

◆ mbuf_alloc_buf()

struct mbuf_buffer * mbuf_alloc_buf ( const struct buffer * buf )

Definition at line 65 of file mbuf.c.

References ALLOC_OBJ, mbuf_buffer::buf, clone_buf(), mbuf_buffer::flags, and mbuf_buffer::refcount.

Referenced by multi_bcast(), multi_io_write_link(), multi_unicast(), test_mbuf_add_on_full_queue_with_holes(), test_mbuf_add_remove(), test_mbuf_dereference_reclaims_queue(), test_mbuf_extract_reclaims_tail(), and test_mbuf_extract_reclaims_up_to_live().

◆ mbuf_defined()

bool mbuf_defined ( const struct mbuf_set * ms )

inlinestatic

Definition at line 81 of file mbuf.h.

References mbuf_set::len.

Referenced by mbuf_peek(), multi_io_write_link(), multi_io_write_link_pre(), multi_tcp_set_global_rw_flags(), test_mbuf_add_remove(), test_mbuf_dereference_reclaims_queue(), test_mbuf_extract_reclaims_tail(), test_mbuf_extract_reclaims_up_to_live(), and test_mbuf_init().

◆ mbuf_dereference_instance()

void mbuf_dereference_instance	(	struct mbuf_set *	ms,
		const struct multi_instance *	mi )

Definition at line 168 of file mbuf.c.

References mbuf_set::array, mbuf_item::buffer, mbuf_set::capacity, D_MBUF, mbuf_set::head, mbuf_item::instance, mbuf_set::len, mbuf_free_buf(), MBUF_INDEX, mbuf_reclaim_head(), and msg.

Referenced by multi_close_instance(), test_mbuf_add_on_full_queue_with_holes(), test_mbuf_add_remove(), test_mbuf_dereference_reclaims_queue(), test_mbuf_extract_reclaims_tail(), and test_mbuf_extract_reclaims_up_to_live().

◆ mbuf_extract_item()

bool mbuf_extract_item	(	struct mbuf_set *	ms,
		struct mbuf_item *	item )

Definition at line 126 of file mbuf.c.

References mbuf_set::array, ASSERT, mbuf_set::capacity, mbuf_set::head, mbuf_item::instance, mbuf_set::len, MBUF_INDEX, and mbuf_reclaim_head().

Referenced by mbuf_add_item(), multi_get_queue(), multi_io_write_link_deferred(), test_mbuf_add_remove(), test_mbuf_extract_reclaims_tail(), and test_mbuf_extract_reclaims_up_to_live().

◆ mbuf_free()

void mbuf_free ( struct mbuf_set * ms )

Definition at line 50 of file mbuf.c.

References mbuf_set::array, mbuf_item::buffer, mbuf_set::capacity, mbuf_set::head, mbuf_set::len, mbuf_free_buf(), and MBUF_INDEX.

Referenced by multi_tcp_instance_specific_free(), multi_uninit(), test_mbuf_add_on_full_queue_with_holes(), test_mbuf_add_remove(), test_mbuf_dereference_reclaims_queue(), test_mbuf_extract_reclaims_tail(), test_mbuf_extract_reclaims_up_to_live(), and test_mbuf_init().

◆ mbuf_free_buf()

void mbuf_free_buf ( struct mbuf_buffer * mb )

Definition at line 76 of file mbuf.c.

References mbuf_buffer::buf, free_buf(), and mbuf_buffer::refcount.

Referenced by mbuf_add_item(), mbuf_dereference_instance(), mbuf_free(), multi_bcast(), multi_get_queue(), multi_io_write_link(), multi_io_write_link_deferred(), multi_unicast(), test_mbuf_add_on_full_queue_with_holes(), test_mbuf_add_remove(), test_mbuf_dereference_reclaims_queue(), test_mbuf_extract_reclaims_tail(), and test_mbuf_extract_reclaims_up_to_live().

◆ mbuf_init()

struct mbuf_set * mbuf_init ( unsigned int size )

Definition at line 38 of file mbuf.c.

References adjust_power_of_2(), ALLOC_ARRAY, ALLOC_OBJ_CLEAR, mbuf_set::array, ASSERT, mbuf_set::capacity, and MBUF_SIZE_MAX.

Referenced by multi_init(), multi_tcp_instance_specific_init(), test_mbuf_add_on_full_queue_with_holes(), test_mbuf_add_remove(), test_mbuf_dereference_reclaims_queue(), test_mbuf_extract_reclaims_tail(), test_mbuf_extract_reclaims_up_to_live(), and test_mbuf_init().

◆ mbuf_len()

unsigned int mbuf_len ( const struct mbuf_set * ms )

inlinestatic

Definition at line 87 of file mbuf.h.

References mbuf_set::len.

Referenced by multi_output_queue_ready(), test_mbuf_add_on_full_queue_with_holes(), test_mbuf_add_remove(), test_mbuf_dereference_reclaims_queue(), test_mbuf_extract_reclaims_tail(), and test_mbuf_extract_reclaims_up_to_live().

◆ mbuf_maximum_queued()

int mbuf_maximum_queued ( const struct mbuf_set * ms )

inlinestatic

Definition at line 93 of file mbuf.h.

References mbuf_set::max_queued.

Referenced by multi_print_status(), and test_mbuf_add_remove().

◆ mbuf_peek()

struct multi_instance * mbuf_peek ( struct mbuf_set * ms )

inlinestatic

Definition at line 101 of file mbuf.h.

References mbuf_defined(), and mbuf_peek_dowork().

Referenced by multi_io_process_io(), test_mbuf_add_on_full_queue_with_holes(), test_mbuf_add_remove(), test_mbuf_dereference_reclaims_queue(), test_mbuf_extract_reclaims_tail(), and test_mbuf_extract_reclaims_up_to_live().

◆ mbuf_peek_dowork()

struct multi_instance * mbuf_peek_dowork ( struct mbuf_set * ms )

Definition at line 149 of file mbuf.c.

References mbuf_set::array, mbuf_set::capacity, mbuf_set::head, mbuf_item::instance, mbuf_set::len, and MBUF_INDEX.

Referenced by mbuf_peek().