Inheritance diagram for NanostackMemoryManager:

Public Member Functions
emac_mem_buf_t *	alloc_heap (uint32_t size, uint32_t align) override
	Allocates memory buffer from the heap. More...

emac_mem_buf_t *	alloc_pool (uint32_t size, uint32_t align) override
	Allocates memory buffer chain from a pool. More...

uint32_t	get_pool_alloc_unit (uint32_t align) const override
	Get memory buffer pool allocation unit. More...

void	free (emac_mem_buf_t *buf) override
	Free memory buffer chain. More...

uint32_t	get_total_len (const emac_mem_buf_t *buf) const override
	Return total length of a memory buffer chain. More...

void	copy (emac_mem_buf_t to_buf, const emac_mem_buf_t from_buf) override
	Copy a memory buffer chain. More...

void	cat (emac_mem_buf_t to_buf, emac_mem_buf_t cat_buf) override
	Concatenate two memory buffer chains. More...

emac_mem_buf_t *	get_next (const emac_mem_buf_t *buf) const override
	Returns the next buffer. More...

void *	get_ptr (const emac_mem_buf_t *buf) const override
	Return pointer to the payload of the buffer. More...

uint32_t	get_len (const emac_mem_buf_t *buf) const override
	Return payload size of the buffer. More...

void	set_len (emac_mem_buf_t *buf, uint32_t len) override
	Sets the payload size of the buffer. More...

virtual void	copy_to_buf (net_stack_mem_buf_t to_buf, const void ptr, uint32_t len)
	Copy to a memory buffer chain. More...

virtual uint32_t	copy_from_buf (void ptr, uint32_t len, const net_stack_mem_buf_t from_buf) const
	Copy from a memory buffer chain. More...

Detailed Description

Definition at line 22 of file NanostackMemoryManager.h.

Member Function Documentation

◆ alloc_heap()

emac_mem_buf_t * alloc_heap	(	uint32_t	size,
		uint32_t	align
	)

overridevirtual

Allocates memory buffer from the heap.

Memory buffer allocated from heap is always contiguous and can be arbitrary size.

Parameters

size	Size of the memory to allocate in bytes
align	Memory alignment requirement in bytes

Returns: Allocated memory buffer, or NULL in case of error

Implements NetStackMemoryManager.

◆ alloc_pool()

emac_mem_buf_t * alloc_pool	(	uint32_t	size,
		uint32_t	align
	)

overridevirtual

Allocates memory buffer chain from a pool.

Memory allocated from pool is contiguous if size is equal or less than (aligned) allocation unit, otherwise may be chained. Will typically come from fixed-size packet pool memory.

Parameters

size	Total size of the memory to allocate in bytes
align	Memory alignment requirement for each buffer in bytes

Returns: Allocated memory buffer chain, or NULL in case of error

Implements NetStackMemoryManager.

◆ get_pool_alloc_unit()

uint32_t get_pool_alloc_unit ( uint32_t align ) const

overridevirtual

Get memory buffer pool allocation unit.

Returns the maximum size of contiguous memory that can be allocated from a pool.

Parameters

align Memory alignment requirement in bytes

Returns: Contiguous memory size

Implements NetStackMemoryManager.

◆ free()

void free ( emac_mem_buf_t * buf )

overridevirtual

Free memory buffer chain.

If memory buffer is chained must point to the start of the chain. Frees all buffers from the chained list.

Parameters

buf	Memory buffer chain to be freed.

Implements NetStackMemoryManager.

◆ get_total_len()

uint32_t get_total_len ( const emac_mem_buf_t * buf ) const

overridevirtual

Return total length of a memory buffer chain.

Returns a total length of this buffer and any following buffers in the chain.

Parameters

buf	Memory buffer chain

Returns: Total length in bytes

Implements NetStackMemoryManager.

◆ copy()

void copy	(	emac_mem_buf_t *	to_buf,
		const emac_mem_buf_t *	from_buf
	)

overridevirtual

Copy a memory buffer chain.

Copies data from one buffer chain to another. Copy operation does not adjust the lengths of the copied-to memory buffer chain, so chain total lengths must be the same.

Parameters

to_buf	Memory buffer chain to copy to
from_buf	Memory buffer chain to copy from

Implements NetStackMemoryManager.

◆ cat()

void cat	(	emac_mem_buf_t *	to_buf,
		emac_mem_buf_t *	cat_buf
	)

overridevirtual

Concatenate two memory buffer chains.

Concatenates buffer chain to end of the other buffer chain. Concatenated-to buffer total length is adjusted accordingly. cat_buf must point to the start of a the chain. After concatenation to_buf's chain now owns those buffers, and they will be freed when the to_buf chain is freed.

Parameters

to_buf	Memory buffer chain to concatenate to
cat_buf	Memory buffer chain to concatenate

Implements NetStackMemoryManager.

◆ get_next()

emac_mem_buf_t * get_next ( const emac_mem_buf_t * buf ) const

overridevirtual

Returns the next buffer.

Returns the next buffer from the memory buffer chain.

Parameters

buf	Memory buffer

Returns: The next memory buffer, or NULL if last

Implements NetStackMemoryManager.

◆ get_ptr()

void * get_ptr ( const emac_mem_buf_t * buf ) const

overridevirtual

Return pointer to the payload of the buffer.

Parameters

buf	Memory buffer

Returns: Pointer to the payload

Implements NetStackMemoryManager.

◆ get_len()

uint32_t get_len ( const emac_mem_buf_t * buf ) const

overridevirtual

Return payload size of the buffer.

Parameters

buf	Memory buffer

Returns: Size in bytes

Implements NetStackMemoryManager.

◆ set_len()

void set_len	(	emac_mem_buf_t *	buf,
		uint32_t	len
	)

overridevirtual

Sets the payload size of the buffer.

The allocated payload size will not change. It is not permitted to change the length of a buffer that is not the first (or only) in a chain.

Parameters

buf	Memory buffer
len	Payload size, must be less or equal allocated size

Implements NetStackMemoryManager.

◆ copy_to_buf()

virtual void copy_to_buf	(	net_stack_mem_buf_t *	to_buf,
		const void *	ptr,
		uint32_t	len
	)

virtualinherited

Copy to a memory buffer chain.

Copies data to a buffer chain. Copy operation does not adjust the lengths of the copied-to memory buffer chain, so chain total length must match the copied length.

Parameters

to_buf	Memory buffer chain to copy to
ptr	Pointer to data
len	Data length

◆ copy_from_buf()

virtual uint32_t copy_from_buf	(	void *	ptr,
		uint32_t	len,
		const net_stack_mem_buf_t *	from_buf
	)		const

virtualinherited

Copy from a memory buffer chain.

Copies data from a memory buffer chain.

Parameters

len	Data length
ptr	Pointer to data
from_buf	Memory buffer chain to copy from

Returns: Length of the data that was copied

Public Member Functions

Detailed Description

Member Function Documentation

◆ alloc_heap()

◆ alloc_pool()

◆ get_pool_alloc_unit()

◆ free()

◆ get_total_len()

◆ copy()

◆ cat()

◆ get_next()

◆ get_ptr()

◆ get_len()

◆ set_len()

◆ copy_to_buf()

◆ copy_from_buf()