--- name: "rte_reorder_memory_footprint_get" section: "3" platform: "linux" package: "dpdk-doc" version: "24.11.4-0+deb13u1" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/rte_reorder.h" --- # rte\_reorder\_memory\_footprint\_get(3) Part of [rte\_reorder.h(3)](/rte_reorder.h/3.md). ## NAME rte\_reorder.h ## SYNOPSIS `#include `\ `#include `\ `#include `\ ### Functions static \_\_rte\_experimental rte\_reorder\_seqn\_t \* **rte\_reorder\_seqn** (struct **rte\_mbuf** \*mbuf)\ 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)\ \_\_rte\_experimental unsigned int **rte\_reorder\_drain\_up\_to\_seqn** (struct rte\_reorder\_buffer \*b, struct **rte\_mbuf** \*\*mbufs, unsigned int max\_mbufs, rte\_reorder\_seqn\_t seqn)\ \_\_rte\_experimental unsigned int **rte\_reorder\_min\_seqn\_set** (struct rte\_reorder\_buffer \*b, rte\_reorder\_seqn\_t min\_seqn)\ \_\_rte\_experimental unsigned int **rte\_reorder\_memory\_footprint\_get** (unsigned int size)\ ## 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 ### static \_\_rte\_experimental rte\_reorder\_seqn\_t \* rte\_reorder\_seqn (struct rte\_mbuf \* mbuf)` [inline]`, ` [static]` **Warning** **EXPERIMENTAL:** this API may change without prior notice Read reorder sequence number from mbuf. **Parameters** *mbuf* Structure to read from. **Returns** pointer to reorder sequence number. Definition at line **41** of file **rte\_reorder.h**. ### struct rte\_reorder\_buffer \* rte\_reorder\_create (const char \* name, unsigned socket\_id, unsigned int size) 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** *name* The name to be given to the reorder buffer instance. \ *socket\_id* The NUMA node on which the memory for the reorder buffer instance is to be reserved. \ *size* Max 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 ### struct rte\_reorder\_buffer \* rte\_reorder\_init (struct rte\_reorder\_buffer \* b, unsigned int bufsize, const char \* name, unsigned int size) Initializes given reorder buffer instance **Parameters** *b* Reorder buffer instance to initialize \ *bufsize* Size of the reorder buffer \ *name* The name to be given to the reorder buffer \ *size* Number 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 - • ENOMEM - not enough memory to register dynamic field ### struct rte\_reorder\_buffer \* rte\_reorder\_find\_existing (const char \* name) Find an existing reorder buffer instance and return a pointer to it. **Parameters** *name* Name of the reorder buffer instance 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** *b* Reorder buffer instance which has to be reset ### void rte\_reorder\_free (struct rte\_reorder\_buffer \* b) Free reorder buffer instance. **Parameters** *b* Pointer to reorder buffer instance. If b is NULL, no operation is performed. ### 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** *b* Reorder buffer where the mbuf has to be inserted. \ *mbuf* mbuf 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. ### 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** *b* Reorder buffer instance from which packets are to be drained \ *mbufs* array of mbufs where reordered packets will be inserted from reorder buffer \ *max\_mbufs* the number of elements in the mbufs array. **Returns** number of mbuf pointers written to mbufs. 0 \<= N \< max\_mbufs. ### \_\_rte\_experimental unsigned int rte\_reorder\_drain\_up\_to\_seqn (struct rte\_reorder\_buffer \* b, struct rte\_mbuf \*\* mbufs, unsigned int max\_mbufs, rte\_reorder\_seqn\_t seqn) **Warning** **EXPERIMENTAL:** this API may change without prior notice Fetch set of reordered packets up to specified sequence number (exclusive). Returns a set of in-order packets from the reorder buffer structure. Gaps may be present since reorder buffer will try to fetch all possible packets up to given sequence number. **Parameters** *b* Reorder buffer instance from which packets are to be drained. \ *mbufs* Array of mbufs where reordered packets will be inserted from reorder buffer. \ *max\_mbufs* The number of elements in the mbuf array. \ *seqn* Sequence number up to which buffer will be drained. **Returns** Number of mbuf pointers written to mbufs. 0 \<= N \< max\_mbufs. ### \_\_rte\_experimental unsigned int rte\_reorder\_min\_seqn\_set (struct rte\_reorder\_buffer \* b, rte\_reorder\_seqn\_t min\_seqn) **Warning** **EXPERIMENTAL:** this API may change without prior notice Set minimum sequence number of packet allowed to be buffered. To successfully set new value, reorder buffer has to be empty (after create, reset or drain\_all). **Parameters** *b* Empty reorder buffer instance to modify. \ *min\_seqn* New sequence number to set. **Returns** 0 on success, a negative value otherwise. ### \_\_rte\_experimental unsigned int rte\_reorder\_memory\_footprint\_get (unsigned int size) **Warning** **EXPERIMENTAL:** this API may change without prior notice Determine the amount of memory needed by the reorder buffer to accommodate a given number of elements. **See also** **rte\_reorder\_init()** **Parameters** *size* Number of elements that can be stored in reorder buffer. **Returns** Reorder buffer footprint measured in bytes. ## Author Generated automatically by Doxygen for DPDK from the source code.