1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2010-2014 Intel Corporation
8 #include <rte_string_fns.h>
11 #include <rte_eal_memconfig.h>
12 #include <rte_errno.h>
13 #include <rte_malloc.h>
15 #include "rte_reorder.h"
17 TAILQ_HEAD(rte_reorder_list, rte_tailq_entry);
19 static struct rte_tailq_elem rte_reorder_tailq = {
20 .name = "RTE_REORDER",
22 EAL_REGISTER_TAILQ(rte_reorder_tailq)
25 #define RTE_REORDER_PREFIX "RO_"
26 #define RTE_REORDER_NAMESIZE 32
28 /* Macros for printing using RTE_LOG */
29 #define RTE_LOGTYPE_REORDER RTE_LOGTYPE_USER1
31 /* A generic circular buffer */
33 unsigned int size; /**< Number of entries that can be stored */
34 unsigned int mask; /**< [buffer_size - 1]: used for wrap-around */
35 unsigned int head; /**< insertion point in buffer */
36 unsigned int tail; /**< extraction point in buffer */
37 struct rte_mbuf **entries;
38 } __rte_cache_aligned;
40 /* The reorder buffer data structure itself */
41 struct rte_reorder_buffer {
42 char name[RTE_REORDER_NAMESIZE];
43 uint32_t min_seqn; /**< Lowest seq. number that can be in the buffer */
44 unsigned int memsize; /**< memory area size of reorder buffer */
45 struct cir_buffer ready_buf; /**< temp buffer for dequeued entries */
46 struct cir_buffer order_buf; /**< buffer used to reorder entries */
48 } __rte_cache_aligned;
51 rte_reorder_free_mbufs(struct rte_reorder_buffer *b);
53 struct rte_reorder_buffer *
54 rte_reorder_init(struct rte_reorder_buffer *b, unsigned int bufsize,
55 const char *name, unsigned int size)
57 const unsigned int min_bufsize = sizeof(*b) +
58 (2 * size * sizeof(struct rte_mbuf *));
61 RTE_LOG(ERR, REORDER, "Invalid reorder buffer parameter:"
66 if (!rte_is_power_of_2(size)) {
67 RTE_LOG(ERR, REORDER, "Invalid reorder buffer size"
68 " - Not a power of 2\n");
73 RTE_LOG(ERR, REORDER, "Invalid reorder buffer name ptr:"
78 if (bufsize < min_bufsize) {
79 RTE_LOG(ERR, REORDER, "Invalid reorder buffer memory size: %u, "
80 "minimum required: %u\n", bufsize, min_bufsize);
85 memset(b, 0, bufsize);
86 strlcpy(b->name, name, sizeof(b->name));
88 b->order_buf.size = b->ready_buf.size = size;
89 b->order_buf.mask = b->ready_buf.mask = size - 1;
90 b->ready_buf.entries = (void *)&b[1];
91 b->order_buf.entries = RTE_PTR_ADD(&b[1],
92 size * sizeof(b->ready_buf.entries[0]));
97 struct rte_reorder_buffer*
98 rte_reorder_create(const char *name, unsigned socket_id, unsigned int size)
100 struct rte_reorder_buffer *b = NULL;
101 struct rte_tailq_entry *te;
102 struct rte_reorder_list *reorder_list;
103 const unsigned int bufsize = sizeof(struct rte_reorder_buffer) +
104 (2 * size * sizeof(struct rte_mbuf *));
106 reorder_list = RTE_TAILQ_CAST(rte_reorder_tailq.head, rte_reorder_list);
108 /* Check user arguments. */
109 if (!rte_is_power_of_2(size)) {
110 RTE_LOG(ERR, REORDER, "Invalid reorder buffer size"
111 " - Not a power of 2\n");
116 RTE_LOG(ERR, REORDER, "Invalid reorder buffer name ptr:"
122 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
124 /* guarantee there's no existing */
125 TAILQ_FOREACH(te, reorder_list, next) {
126 b = (struct rte_reorder_buffer *) te->data;
127 if (strncmp(name, b->name, RTE_REORDER_NAMESIZE) == 0)
133 /* allocate tailq entry */
134 te = rte_zmalloc("REORDER_TAILQ_ENTRY", sizeof(*te), 0);
136 RTE_LOG(ERR, REORDER, "Failed to allocate tailq entry\n");
142 /* Allocate memory to store the reorder buffer structure. */
143 b = rte_zmalloc_socket("REORDER_BUFFER", bufsize, 0, socket_id);
145 RTE_LOG(ERR, REORDER, "Memzone allocation failed\n");
149 rte_reorder_init(b, bufsize, name, size);
150 te->data = (void *)b;
151 TAILQ_INSERT_TAIL(reorder_list, te, next);
155 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
160 rte_reorder_reset(struct rte_reorder_buffer *b)
162 char name[RTE_REORDER_NAMESIZE];
164 rte_reorder_free_mbufs(b);
165 strlcpy(name, b->name, sizeof(name));
166 /* No error checking as current values should be valid */
167 rte_reorder_init(b, b->memsize, name, b->order_buf.size);
171 rte_reorder_free_mbufs(struct rte_reorder_buffer *b)
175 /* Free up the mbufs of order buffer & ready buffer */
176 for (i = 0; i < b->order_buf.size; i++) {
177 if (b->order_buf.entries[i])
178 rte_pktmbuf_free(b->order_buf.entries[i]);
179 if (b->ready_buf.entries[i])
180 rte_pktmbuf_free(b->ready_buf.entries[i]);
185 rte_reorder_free(struct rte_reorder_buffer *b)
187 struct rte_reorder_list *reorder_list;
188 struct rte_tailq_entry *te;
190 /* Check user arguments. */
194 reorder_list = RTE_TAILQ_CAST(rte_reorder_tailq.head, rte_reorder_list);
196 rte_rwlock_write_lock(RTE_EAL_TAILQ_RWLOCK);
198 /* find our tailq entry */
199 TAILQ_FOREACH(te, reorder_list, next) {
200 if (te->data == (void *) b)
204 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
208 TAILQ_REMOVE(reorder_list, te, next);
210 rte_rwlock_write_unlock(RTE_EAL_TAILQ_RWLOCK);
212 rte_reorder_free_mbufs(b);
218 struct rte_reorder_buffer *
219 rte_reorder_find_existing(const char *name)
221 struct rte_reorder_buffer *b = NULL;
222 struct rte_tailq_entry *te;
223 struct rte_reorder_list *reorder_list;
230 reorder_list = RTE_TAILQ_CAST(rte_reorder_tailq.head, rte_reorder_list);
232 rte_rwlock_read_lock(RTE_EAL_TAILQ_RWLOCK);
233 TAILQ_FOREACH(te, reorder_list, next) {
234 b = (struct rte_reorder_buffer *) te->data;
235 if (strncmp(name, b->name, RTE_REORDER_NAMESIZE) == 0)
238 rte_rwlock_read_unlock(RTE_EAL_TAILQ_RWLOCK);
249 rte_reorder_fill_overflow(struct rte_reorder_buffer *b, unsigned n)
252 * 1. Move all ready entries that fit to the ready_buf
253 * 2. check if we meet the minimum needed (n).
254 * 3. If not, then skip any gaps and keep moving.
255 * 4. If at any point the ready buffer is full, stop
256 * 5. Return the number of positions the order_buf head has moved
259 struct cir_buffer *order_buf = &b->order_buf,
260 *ready_buf = &b->ready_buf;
262 unsigned int order_head_adv = 0;
265 * move at least n packets to ready buffer, assuming ready buffer
266 * has room for those packets.
268 while (order_head_adv < n &&
269 ((ready_buf->head + 1) & ready_buf->mask) != ready_buf->tail) {
271 /* if we are blocked waiting on a packet, skip it */
272 if (order_buf->entries[order_buf->head] == NULL) {
273 order_buf->head = (order_buf->head + 1) & order_buf->mask;
277 /* Move all ready entries that fit to the ready_buf */
278 while (order_buf->entries[order_buf->head] != NULL) {
279 ready_buf->entries[ready_buf->head] =
280 order_buf->entries[order_buf->head];
282 order_buf->entries[order_buf->head] = NULL;
285 order_buf->head = (order_buf->head + 1) & order_buf->mask;
287 if (((ready_buf->head + 1) & ready_buf->mask) == ready_buf->tail)
290 ready_buf->head = (ready_buf->head + 1) & ready_buf->mask;
294 b->min_seqn += order_head_adv;
295 /* Return the number of positions the order_buf head has moved */
296 return order_head_adv;
300 rte_reorder_insert(struct rte_reorder_buffer *b, struct rte_mbuf *mbuf)
302 uint32_t offset, position;
303 struct cir_buffer *order_buf;
305 if (b == NULL || mbuf == NULL) {
310 order_buf = &b->order_buf;
311 if (!b->is_initialized) {
312 b->min_seqn = mbuf->seqn;
313 b->is_initialized = 1;
317 * calculate the offset from the head pointer we need to go.
318 * The subtraction takes care of the sequence number wrapping.
319 * For example (using 16-bit for brevity):
322 * offset = 0x0010 - 0xFFFD = 0x13
324 offset = mbuf->seqn - b->min_seqn;
327 * action to take depends on offset.
328 * offset < buffer->size: the mbuf fits within the current window of
329 * sequence numbers we can reorder. EXPECTED CASE.
330 * offset > buffer->size: the mbuf is outside the current window. There
331 * are a number of cases to consider:
332 * 1. The packet sequence is just outside the window, then we need
333 * to see about shifting the head pointer and taking any ready
334 * to return packets out of the ring. If there was a delayed
335 * or dropped packet preventing drains from shifting the window
336 * this case will skip over the dropped packet instead, and any
337 * packets dequeued here will be returned on the next drain call.
338 * 2. The packet sequence number is vastly outside our window, taken
339 * here as having offset greater than twice the buffer size. In
340 * this case, the packet is probably an old or late packet that
341 * was previously skipped, so just enqueue the packet for
342 * immediate return on the next drain call, or else return error.
344 if (offset < b->order_buf.size) {
345 position = (order_buf->head + offset) & order_buf->mask;
346 order_buf->entries[position] = mbuf;
347 } else if (offset < 2 * b->order_buf.size) {
348 if (rte_reorder_fill_overflow(b, offset + 1 - order_buf->size)
349 < (offset + 1 - order_buf->size)) {
350 /* Put in handling for enqueue straight to output */
354 offset = mbuf->seqn - b->min_seqn;
355 position = (order_buf->head + offset) & order_buf->mask;
356 order_buf->entries[position] = mbuf;
358 /* Put in handling for enqueue straight to output */
366 rte_reorder_drain(struct rte_reorder_buffer *b, struct rte_mbuf **mbufs,
369 unsigned int drain_cnt = 0;
371 struct cir_buffer *order_buf = &b->order_buf,
372 *ready_buf = &b->ready_buf;
374 /* Try to fetch requested number of mbufs from ready buffer */
375 while ((drain_cnt < max_mbufs) && (ready_buf->tail != ready_buf->head)) {
376 mbufs[drain_cnt++] = ready_buf->entries[ready_buf->tail];
377 ready_buf->tail = (ready_buf->tail + 1) & ready_buf->mask;
381 * If requested number of buffers not fetched from ready buffer, fetch
382 * remaining buffers from order buffer
384 while ((drain_cnt < max_mbufs) &&
385 (order_buf->entries[order_buf->head] != NULL)) {
386 mbufs[drain_cnt++] = order_buf->entries[order_buf->head];
387 order_buf->entries[order_buf->head] = NULL;
389 order_buf->head = (order_buf->head + 1) & order_buf->mask;