DPDK: Data Plane Development Kit

18.02.0-rc0
rte_reorder.h File Reference
#include <rte_mbuf.h>

Go to the source code of this file.

Functions

struct rte_reorder_buffer * rte_reorder_create (const char *name, unsigned socket_id, unsigned int size)
struct rte_reorder_buffer * rte_reorder_init (struct rte_reorder_buffer *b, unsigned int bufsize, const char *name, unsigned int size)
struct rte_reorder_buffer * rte_reorder_find_existing (const char *name)
void rte_reorder_reset (struct rte_reorder_buffer *b)
void rte_reorder_free (struct rte_reorder_buffer *b)
int rte_reorder_insert (struct rte_reorder_buffer *b, struct rte_mbuf *mbuf)
unsigned int rte_reorder_drain (struct rte_reorder_buffer *b, struct rte_mbuf **mbufs, unsigned max_mbufs)

Detailed Description

RTE reorder

Reorder library is a component which is designed to provide ordering of out of ordered packets based on sequence number present in mbuf.

Definition in file rte_reorder.h.

Function Documentation

struct rte_reorder_buffer* rte_reorder_create ( const char *  name,
unsigned  socket_id,
unsigned int  size 
)
read

Create a new reorder buffer instance

Allocate memory and initialize a new reorder buffer in that memory, returning the reorder buffer pointer to the user

Parameters
nameThe name to be given to the reorder buffer instance.
socket_idThe NUMA node on which the memory for the reorder buffer instance is to be reserved.
sizeMax number of elements that can be stored in the reorder buffer
Returns
The initialized reorder buffer instance, or NULL on error On error case, rte_errno will be set appropriately:
  • ENOMEM - no appropriate memory area found in which to create memzone
  • EINVAL - invalid parameters
Examples:
examples/packet_ordering/main.c.
struct rte_reorder_buffer* rte_reorder_init ( struct rte_reorder_buffer *  b,
unsigned int  bufsize,
const char *  name,
unsigned int  size 
)
read

Initializes given reorder buffer instance

Parameters
bReorder buffer instance to initialize
bufsizeSize of the reorder buffer
nameThe name to be given to the reorder buffer
sizeNumber of elements that can be stored in reorder buffer
Returns
The initialized reorder buffer instance, or NULL on error On error case, rte_errno will be set appropriately:
  • EINVAL - invalid parameters
struct rte_reorder_buffer* rte_reorder_find_existing ( const char *  name)
read

Find an existing reorder buffer instance and return a pointer to it.

Parameters
nameName of the reorder buffer instacne as passed to rte_reorder_create()
Returns
Pointer to reorder buffer instance or NULL if object not found with rte_errno set appropriately. Possible rte_errno values include:
  • ENOENT - required entry not available to return. reorder instance list
void rte_reorder_reset ( struct rte_reorder_buffer *  b)

Reset the given reorder buffer instance with initial values.

Parameters
bReorder buffer instance which has to be reset
void rte_reorder_free ( struct rte_reorder_buffer *  b)

Free reorder buffer instance.

Parameters
breorder buffer instance
Returns
None
int rte_reorder_insert ( struct rte_reorder_buffer *  b,
struct rte_mbuf mbuf 
)

Insert given mbuf in reorder buffer in its correct position

The given mbuf is to be reordered relative to other mbufs in the system. The mbuf must contain a sequence number which is then used to place the buffer in the correct position in the reorder buffer. Reordered packets can later be taken from the buffer using the rte_reorder_drain() API.

Parameters
bReorder buffer where the mbuf has to be inserted.
mbufmbuf of packet that needs to be inserted in reorder buffer.
Returns
0 on success -1 on error On error case, rte_errno will be set appropriately:
  • ENOSPC - Cannot move existing mbufs from reorder buffer to accommodate early mbuf, but it can be accommodated by performing drain and then insert.
  • ERANGE - Too early or late mbuf which is vastly out of range of expected window should be ignored without any handling.
Examples:
examples/packet_ordering/main.c.
unsigned int rte_reorder_drain ( struct rte_reorder_buffer *  b,
struct rte_mbuf **  mbufs,
unsigned  max_mbufs 
)

Fetch reordered buffers

Returns a set of in-order buffers from the reorder buffer structure. Gaps may be present in the sequence numbers of the mbuf if packets have been delayed too long before reaching the reorder window, or have been previously dropped by the system.

Parameters
bReorder buffer instance from which packets are to be drained
mbufsarray of mbufs where reordered packets will be inserted from reorder buffer
max_mbufsthe number of elements in the mbufs array.
Returns
number of mbuf pointers written to mbufs. 0 <= N < max_mbufs.
Examples:
examples/packet_ordering/main.c.