dev/src/include/lwip/pbuf.h File Reference

#include "lwip/opt.h"
#include "lwip/err.h"

Data Structures
struct	pbuf

Macros
#define	LWIP_SUPPORT_CUSTOM_PBUF   (IP_FRAG && !IP_FRAG_USES_STATIC_BUF && !LWIP_NETIF_TX_SINGLE_PBUF)
	Currently, the pbuf_custom code is only needed for one specific configuration of IP_FRAG. More...
#define	PBUF_FLAG_IS_CUSTOM   0x02U
	indicates this is a custom pbuf: pbuf_free and pbuf_header handle such a a pbuf differently More...
#define	PBUF_FLAG_LLBCAST   0x08U
	indicates this pbuf was received as link-level broadcast More...
#define	PBUF_FLAG_LLMCAST   0x10U
	indicates this pbuf was received as link-level multicast More...
#define	PBUF_FLAG_MCASTLOOP   0x04U
	indicates this pbuf is UDP multicast to be looped back More...
#define	PBUF_FLAG_PUSH   0x01U
	indicates this packet's data should be immediately passed to the application More...
#define	PBUF_FLAG_TCP_FIN   0x20U
	indicates this pbuf includes a TCP FIN flag More...
#define	pbuf_init()
#define	PBUF_IP_HLEN   20
#define	PBUF_TRANSPORT_HLEN   20

Enumerations
enum	pbuf_layer {   PBUF_TRANSPORT,   PBUF_IP,   PBUF_LINK,   PBUF_RAW,   PBUF_TRANSPORT,   PBUF_IP,   PBUF_LINK,   PBUF_RAW }
enum	pbuf_type {   PBUF_RAM,   PBUF_ROM,   PBUF_REF,   PBUF_POOL,   PBUF_RAM,   PBUF_ROM,   PBUF_REF,   PBUF_POOL }

Functions
struct pbuf *	pbuf_alloc (pbuf_layer l, u16_t length, pbuf_type type)
	Allocates a pbuf of the given type (possibly a chain for PBUF_POOL type). More...
void	pbuf_cat (struct pbuf *head, struct pbuf *tail)
	Concatenate two pbufs (each may be a pbuf chain) and take over the caller's reference of the tail pbuf. More...
void	pbuf_chain (struct pbuf *head, struct pbuf *tail)
	Chain two pbufs (or pbuf chains) together. More...
u8_t	pbuf_clen (struct pbuf *p)
	Count number of pbufs in a chain. More...
struct pbuf *	pbuf_coalesce (struct pbuf *p, pbuf_layer layer)
	Creates a single pbuf out of a queue of pbufs. More...
err_t	pbuf_copy (struct pbuf *p_to, struct pbuf *p_from)
	Create PBUF_RAM copies of pbufs. More...
u16_t	pbuf_copy_partial (struct pbuf *p, void *dataptr, u16_t len, u16_t offset)
	Copy (part of) the contents of a packet buffer to an application supplied buffer. More...
struct pbuf *	pbuf_dechain (struct pbuf *p)
	Dechains the first pbuf from its succeeding pbufs in the chain. More...
u8_t	pbuf_free (struct pbuf *p)
	Dereference a pbuf chain or queue and deallocate any no-longer-used pbufs at the head of this chain or queue. More...
u8_t	pbuf_get_at (struct pbuf *p, u16_t offset)
	Get one byte from the specified position in a pbuf WARNING: returns zero for offset >= p->tot_len. More...
u8_t	pbuf_header (struct pbuf *p, s16_t header_size)
	Adjusts the payload pointer to hide or reveal headers in the payload. More...
u8_t	pbuf_header_force (struct pbuf *p, s16_t header_size)
	Same as pbuf_header but does not check if 'header_size > 0' is allowed. More...
u16_t	pbuf_memcmp (struct pbuf *p, u16_t offset, const void *s2, u16_t n)
	Compare pbuf contents at specified offset with memory s2, both of length n. More...
u16_t	pbuf_memfind (struct pbuf *p, const void *mem, u16_t mem_len, u16_t start_offset)
	Find occurrence of mem (with length mem_len) in pbuf p, starting at offset start_offset. More...
void	pbuf_put_at (struct pbuf *p, u16_t offset, u8_t data)
	Put one byte to the specified position in a pbuf WARNING: silently ignores offset >= p->tot_len. More...
void	pbuf_realloc (struct pbuf *p, u16_t size)
	Shrink a pbuf chain to a desired length. More...
void	pbuf_ref (struct pbuf *p)
	Increment the reference count of the pbuf. More...
u16_t	pbuf_strstr (struct pbuf *p, const char *substr)
	Find occurrence of substr with length substr_len in pbuf p, start at offset start_offset WARNING: in contrast to strstr(), this one does not stop at the first \0 in the pbuf/source string! More...
err_t	pbuf_take (struct pbuf *buf, const void *dataptr, u16_t len)
	Copy application supplied data into a pbuf. More...
err_t	pbuf_take_at (struct pbuf *buf, const void *dataptr, u16_t len, u16_t offset)
	Same as pbuf_take() but puts data at an offset. More...

#define LWIP_SUPPORT_CUSTOM_PBUF   (IP_FRAG && !IP_FRAG_USES_STATIC_BUF && !LWIP_NETIF_TX_SINGLE_PBUF)

Currently, the pbuf_custom code is only needed for one specific configuration of IP_FRAG.

#define PBUF_FLAG_IS_CUSTOM   0x02U

indicates this is a custom pbuf: pbuf_free and pbuf_header handle such a a pbuf differently

#define PBUF_FLAG_LLBCAST   0x08U

indicates this pbuf was received as link-level broadcast

#define PBUF_FLAG_LLMCAST   0x10U

indicates this pbuf was received as link-level multicast

#define PBUF_FLAG_MCASTLOOP   0x04U

indicates this pbuf is UDP multicast to be looped back

#define PBUF_FLAG_PUSH   0x01U

indicates this packet's data should be immediately passed to the application

#define PBUF_FLAG_TCP_FIN   0x20U

indicates this pbuf includes a TCP FIN flag

#define pbuf_init

(

)

#define PBUF_IP_HLEN   20

#define PBUF_TRANSPORT_HLEN   20

enum pbuf_layer

Enumerator
PBUF_TRANSPORT
PBUF_IP
PBUF_LINK
PBUF_RAW
PBUF_TRANSPORT
PBUF_IP
PBUF_LINK
PBUF_RAW

enum pbuf_type

Enumerator
PBUF_RAM
PBUF_ROM
PBUF_REF
PBUF_POOL
PBUF_RAM
PBUF_ROM
PBUF_REF
PBUF_POOL

struct pbuf* pbuf_alloc	(	pbuf_layer	layer,
		u16_t	length,
		pbuf_type	type
	)

Allocates a pbuf of the given type (possibly a chain for PBUF_POOL type).

The actual memory allocated for the pbuf is determined by the layer at which the pbuf is allocated and the requested size (from the size parameter).

Parameters

layer	flag to define header size
length	size of the pbuf's payload
type	this parameter decides how and where the pbuf should be allocated as follows:

• PBUF_RAM: buffer memory for pbuf is allocated as one large chunk. This includes protocol headers as well.
• PBUF_ROM: no buffer memory is allocated for the pbuf, even for protocol headers. Additional headers must be prepended by allocating another pbuf and chain in to the front of the ROM pbuf. It is assumed that the memory used is really similar to ROM in that it is immutable and will not be changed. Memory which is dynamic should generally not be attached to PBUF_ROM pbufs. Use PBUF_REF instead.
• PBUF_REF: no buffer memory is allocated for the pbuf, even for protocol headers. It is assumed that the pbuf is only being used in a single thread. If the pbuf gets queued, then pbuf_take should be called to copy the buffer.
• PBUF_POOL: the pbuf is allocated as a pbuf chain, with pbufs from the pbuf pool that is allocated during pbuf_init().

Returns

the allocated pbuf. If multiple pbufs where allocated, this is the first pbuf of a pbuf chain.

References pbuf::flags, pbuf::len, length, LWIP_ASSERT, LWIP_DBG_LEVEL_SERIOUS, LWIP_DBG_TRACE, LWIP_DEBUGF, LWIP_MEM_ALIGN, LWIP_MEM_ALIGN_SIZE, LWIP_MIN, MEM_ALIGNMENT, mem_malloc(), memp_malloc(), pbuf::next, NULL, pbuf::payload, PBUF_DEBUG, pbuf_free(), PBUF_IP, PBUF_IP_HLEN, PBUF_LINK, PBUF_LINK_ENCAPSULATION_HLEN, PBUF_LINK_HLEN, PBUF_POOL, PBUF_POOL_BUFSIZE_ALIGNED, PBUF_POOL_IS_EMPTY, PBUF_RAM, PBUF_RAW, PBUF_REF, PBUF_ROM, PBUF_TRANSPORT, PBUF_TRANSPORT_HLEN, pbuf::ref, SIZEOF_STRUCT_PBUF, pbuf::tot_len, pbuf::type, and U16_F.

Referenced by ksz8851snl_rx_populate_queue(), and pbuf_coalesce().

void pbuf_cat	(	struct pbuf *	h,
		struct pbuf *	t
	)

Concatenate two pbufs (each may be a pbuf chain) and take over the caller's reference of the tail pbuf.

Note

The caller MAY NOT reference the tail pbuf afterwards. Use pbuf_chain() for that purpose.

See Also

pbuf_chain()

References pbuf::len, LWIP_ASSERT, LWIP_ERROR, pbuf::next, NULL, and pbuf::tot_len.

Referenced by pbuf_chain().

void pbuf_chain	(	struct pbuf *	h,
		struct pbuf *	t
	)

Chain two pbufs (or pbuf chains) together.

The caller MUST call pbuf_free(t) once it has stopped using it. Use pbuf_cat() instead if you no longer use t.

Parameters

h	head pbuf (chain)
t	tail pbuf (chain)

Note

The pbufs MUST belong to the same packet.

MAY NOT be called on a packet queue.

The ->tot_len fields of all pbufs of the head chain are adjusted. The ->next field of the last pbuf of the head chain is adjusted. The ->ref field of the first pbuf of the tail chain is adjusted.

References LWIP_DBG_TRACE, LWIP_DEBUGF, pbuf_cat(), PBUF_DEBUG, and pbuf_ref().

u8_t pbuf_clen

(

struct pbuf *

p

)

Count number of pbufs in a chain.

Parameters

p	first pbuf of chain

Returns

the number of pbufs in a chain

References pbuf::next, and NULL.

Referenced by ksz8851snl_rx_populate_queue().

struct pbuf* pbuf_coalesce	(	struct pbuf *	p,
		pbuf_layer	layer
	)

Creates a single pbuf out of a queue of pbufs.

Remarks

: Either the source pbuf 'p' is freed by this function or the original pbuf 'p' is returned, therefore the caller has to check the result!

Parameters

p	the source pbuf
layer	pbuf_layer of the new pbuf

Returns

a new, single pbuf (p->next is NULL) or the old pbuf if allocation fails

References ERR_OK, LWIP_ASSERT, pbuf::next, NULL, pbuf_alloc(), pbuf_copy(), pbuf_free(), PBUF_RAM, and pbuf::tot_len.

err_t pbuf_copy	(	struct pbuf *	p_to,
		struct pbuf *	p_from
	)

Create PBUF_RAM copies of pbufs.

Used to queue packets on behalf of the lwIP stack, such as ARP based queueing.

Note

You MUST explicitly use p = pbuf_take(p);

Only one packet is copied, no packet queue!

Parameters

p_to	pbuf destination of the copy
p_from	pbuf source of the copy

Returns

ERR_OK if pbuf was copied ERR_ARG if one of the pbufs is NULL or p_to is not big enough to hold p_from

References ERR_ARG, ERR_OK, ERR_VAL, pbuf::len, LWIP_ASSERT, LWIP_DBG_TRACE, LWIP_DEBUGF, LWIP_ERROR, MEMCPY, pbuf::next, NULL, pbuf::payload, PBUF_DEBUG, and pbuf::tot_len.

Referenced by pbuf_coalesce().

u16_t pbuf_copy_partial	(	struct pbuf *	buf,
		void *	dataptr,
		u16_t	len,
		u16_t	offset
	)

Copy (part of) the contents of a packet buffer to an application supplied buffer.

Parameters

buf	the pbuf from which to copy data
dataptr	the application supplied buffer
len	length of data to copy (dataptr must be big enough). No more than buf->tot_len will be copied, irrespective of len
offset	offset into the packet buffer from where to begin copying len bytes

Returns

the number of bytes copied, or 0 on failure

References pbuf::len, LWIP_ERROR, MEMCPY, pbuf::next, NULL, and pbuf::payload.

struct pbuf* pbuf_dechain

(

struct pbuf *

p

)

Dechains the first pbuf from its succeeding pbufs in the chain.

Makes p->tot_len field equal to p->len.

Parameters

p	pbuf to dechain

Returns

remainder of the pbuf chain, or NULL if it was de-allocated.

Note

May not be called on a packet queue.

References pbuf::len, LWIP_ASSERT, LWIP_DBG_TRACE, LWIP_DEBUGF, pbuf::next, NULL, PBUF_DEBUG, pbuf_free(), and pbuf::tot_len.

u8_t pbuf_free

(

struct pbuf *

p

)

Dereference a pbuf chain or queue and deallocate any no-longer-used pbufs at the head of this chain or queue.

Decrements the pbuf reference count. If it reaches zero, the pbuf is deallocated.

For a pbuf chain, this is repeated for each pbuf in the chain, up to the first pbuf which has a non-zero reference count after decrementing. So, when all reference counts are one, the whole chain is free'd.

Parameters

p	The pbuf (chain) to be dereferenced.

Returns

the number of pbufs that were de-allocated from the head of the chain.

Note

MUST NOT be called on a packet queue (Not verified to work yet).

the reference counter of a pbuf equals the number of pointers that refer to the pbuf (or into the pbuf).

examples:

Assuming existing chains a->b->c with the following reference counts, calling pbuf_free(a) results in:

1->2->3 becomes ...1->3 3->3->3 becomes 2->3->3 1->1->2 becomes ......1 2->1->1 becomes 1->1->1 1->1->1 becomes .......

References pbuf::flags, LWIP_ASSERT, LWIP_DBG_LEVEL_SERIOUS, LWIP_DBG_TRACE, LWIP_DEBUGF, mem_free(), memp_free(), pbuf::next, NULL, PBUF_DEBUG, PBUF_FLAG_IS_CUSTOM, PBUF_POOL, PBUF_RAM, PBUF_REF, PBUF_ROM, PERF_START, PERF_STOP, pbuf::ref, SYS_ARCH_DECL_PROTECT, SYS_ARCH_PROTECT, SYS_ARCH_UNPROTECT, pbuf::type, and U16_F.

Referenced by ethernetif_input(), ip_input(), ksz8851snl_update(), pbuf_alloc(), pbuf_coalesce(), pbuf_dechain(), pbuf_free_int(), and pbuf_realloc().

u8_t pbuf_get_at	(	struct pbuf *	p,
		u16_t	offset
	)

Get one byte from the specified position in a pbuf WARNING: returns zero for offset >= p->tot_len.

Parameters

p	pbuf to parse
offset	offset into p of the byte to return

Returns

byte at an offset into p OR ZERO IF 'offset' >= p->tot_len

References pbuf::len, pbuf::next, NULL, pbuf::payload, and pbuf_skip().

Referenced by pbuf_memcmp().

u8_t pbuf_header	(	struct pbuf *	p,
		s16_t	header_size_increment
	)

Adjusts the payload pointer to hide or reveal headers in the payload.

Adjusts the ->payload pointer so that space for a header (dis)appears in the pbuf payload.

The ->payload, ->tot_len and ->len fields are adjusted.

Parameters

p	pbuf to change the header size.
header_size_increment	Number of bytes to increment header size which increases the size of the pbuf. New space is on the front. (Using a negative value decreases the header size.) If hdr_size_inc is 0, this function does nothing and returns succesful.

PBUF_ROM and PBUF_REF type buffers cannot have their sizes increased, so the call will fail. A check is made that the increase in header size does not move the payload pointer in front of the start of the buffer.

Returns

non-zero on failure, zero on success.

Adjusts the ->payload pointer so that space for a header (dis)appears in the pbuf payload.

The ->payload, ->tot_len and ->len fields are adjusted.

Parameters

p	pbuf to change the header size.
header_size_increment	Number of bytes to increment header size which increases the size of the pbuf. New space is on the front. (Using a negative value decreases the header size.) If hdr_size_inc is 0, this function does nothing and returns successful.

PBUF_ROM and PBUF_REF type buffers cannot have their sizes increased, so the call will fail. A check is made that the increase in header size does not move the payload pointer in front of the start of the buffer.

Returns

non-zero on failure, zero on success.

References if(), pbuf::len, LWIP_ASSERT, LWIP_DBG_LEVEL_SERIOUS, LWIP_DBG_TRACE, LWIP_DEBUGF, LWIP_ERROR, NULL, pbuf::payload, PBUF_DEBUG, pbuf_header_impl(), PBUF_POOL, PBUF_RAM, PBUF_REF, PBUF_ROM, S16_F, SIZEOF_STRUCT_PBUF, pbuf::tot_len, and pbuf::type.

Referenced by ip_input().

u8_t pbuf_header_force	(	struct pbuf *	p,
		s16_t	header_size_increment
	)

Same as pbuf_header but does not check if 'header_size > 0' is allowed.

This is used internally only, to allow PBUF_REF for RX.

References pbuf_header_impl().

Referenced by ip_input().

u16_t pbuf_memcmp	(	struct pbuf *	p,
		u16_t	offset,
		const void *	s2,
		u16_t	n
	)

Compare pbuf contents at specified offset with memory s2, both of length n.

Parameters

p	pbuf to compare
offset	offset into p at wich to start comparing
s2	buffer to compare
n	length of buffer to compare

Returns

zero if equal, nonzero otherwise (0xffff if p is too short, diffoffset+1 otherwise)

Parameters

p	pbuf to compare
offset	offset into p at which to start comparing
s2	buffer to compare
n	length of buffer to compare

Returns

zero if equal, nonzero otherwise (0xffff if p is too short, diffoffset+1 otherwise)

References pbuf::len, pbuf::next, NULL, and pbuf_get_at().

Referenced by pbuf_memfind().

u16_t pbuf_memfind	(	struct pbuf *	p,
		const void *	mem,
		u16_t	mem_len,
		u16_t	start_offset
	)

Find occurrence of mem (with length mem_len) in pbuf p, starting at offset start_offset.

Parameters

p	pbuf to search, maximum length is 0xFFFE since 0xFFFF is used as return value 'not found'
mem	search for the contents of this buffer
mem_len	length of 'mem'
start_offset	offset into p at which to start searching

Returns

0xFFFF if substr was not found in p or the index where it was found

References max, pbuf_memcmp(), and pbuf::tot_len.

Referenced by pbuf_strstr().

void pbuf_put_at	(	struct pbuf *	p,
		u16_t	offset,
		u8_t	data
	)

Put one byte to the specified position in a pbuf WARNING: silently ignores offset >= p->tot_len.

Parameters

p	pbuf to fill
offset	offset into p of the byte to write
data	byte to write at an offset into p

References data, pbuf::len, NULL, pbuf::payload, and pbuf_skip().

void pbuf_realloc	(	struct pbuf *	p,
		u16_t	new_len
	)

Shrink a pbuf chain to a desired length.

Parameters

p	pbuf to shrink.
new_len	desired new length of pbuf chain

Depending on the desired length, the first few pbufs in a chain might be skipped and left unchanged. The new last pbuf in the chain will be resized, and any remaining pbufs will be freed.

Note

If the pbuf is ROM/REF, only the ->tot_len and ->len fields are adjusted.

May not be called on a packet queue.

Despite its name, pbuf_realloc cannot grow the size of a pbuf (chain).

References pbuf::len, LWIP_ASSERT, mem_trim(), pbuf::next, NULL, pbuf::payload, pbuf_free(), PBUF_POOL, PBUF_RAM, PBUF_REF, PBUF_ROM, pbuf::tot_len, and pbuf::type.

Referenced by ip_input().

void pbuf_ref

(

struct pbuf *

p

)

Increment the reference count of the pbuf.

Parameters

p	pbuf to increase reference counter of

References NULL, pbuf::ref, SYS_ARCH_DECL_PROTECT, SYS_ARCH_PROTECT, and SYS_ARCH_UNPROTECT.

Referenced by ksz8851snl_low_level_output(), and pbuf_chain().

u16_t pbuf_strstr	(	struct pbuf *	p,
		const char *	substr
	)

Find occurrence of substr with length substr_len in pbuf p, start at offset start_offset WARNING: in contrast to strstr(), this one does not stop at the first \0 in the pbuf/source string!

Parameters

p	pbuf to search, maximum length is 0xFFFE since 0xFFFF is used as return value 'not found'
substr	string to search for in p, maximum length is 0xFFFE

Returns

0xFFFF if substr was not found in p or the index where it was found

References NULL, pbuf_memfind(), and pbuf::tot_len.

err_t pbuf_take	(	struct pbuf *	buf,
		const void *	dataptr,
		u16_t	len
	)

Copy application supplied data into a pbuf.

This function can only be used to copy the equivalent of buf->tot_len data.

Parameters

buf	pbuf to fill with data
dataptr	application supplied data buffer
len	length of the application supplied data buffer

Returns

ERR_OK if successful, ERR_MEM if the pbuf is not big enough

References ERR_ARG, ERR_OK, pbuf::len, LWIP_ASSERT, LWIP_ERROR, MEMCPY, pbuf::next, NULL, pbuf::payload, and pbuf::tot_len.

Referenced by pbuf_take_at().

err_t pbuf_take_at	(	struct pbuf *	buf,
		const void *	dataptr,
		u16_t	len,
		u16_t	offset
	)

Same as pbuf_take() but puts data at an offset.

Parameters

buf	pbuf to fill with data
dataptr	application supplied data buffer
len	length of the application supplied data buffer

Returns

ERR_OK if successful, ERR_MEM if the pbuf is not big enough

References ERR_MEM, ERR_OK, pbuf::len, LWIP_MIN, MEMCPY, pbuf::next, NULL, pbuf::payload, pbuf_skip(), pbuf_take(), and pbuf::tot_len.