2 * Copyright (c) 2015 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 * buffer_funcs.h: VLIB buffer related functions/inlines
18 * Copyright (c) 2008 Eliot Dresselhaus
20 * Permission is hereby granted, free of charge, to any person obtaining
21 * a copy of this software and associated documentation files (the
22 * "Software"), to deal in the Software without restriction, including
23 * without limitation the rights to use, copy, modify, merge, publish,
24 * distribute, sublicense, and/or sell copies of the Software, and to
25 * permit persons to whom the Software is furnished to do so, subject to
26 * the following conditions:
28 * The above copyright notice and this permission notice shall be
29 * included in all copies or substantial portions of the Software.
31 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 #ifndef included_vlib_buffer_funcs_h
41 #define included_vlib_buffer_funcs_h
43 #include <vppinfra/hash.h>
44 #include <vppinfra/fifo.h>
47 vlib buffer access methods.
51 vlib_buffer_validate (vlib_main_t * vm, vlib_buffer_t * b)
53 vlib_buffer_main_t *bm = vm->buffer_main;
54 vlib_buffer_pool_t *bp;
56 /* reference count in allocated buffer always must be 1 or higher */
57 ASSERT (b->ref_count > 0);
59 /* verify that buffer pointer is from buffer memory range */
60 ASSERT (pointer_to_uword (b) >= bm->buffer_mem_start);
61 ASSERT (pointer_to_uword (b) < bm->buffer_mem_start + bm->buffer_mem_size -
62 VLIB_BUFFER_DATA_SIZE);
64 /* verify that buffer pool index is valid */
65 bp = vec_elt_at_index (bm->buffer_pools, b->buffer_pool_index);
66 ASSERT (pointer_to_uword (b) >= bp->start);
67 ASSERT (pointer_to_uword (b) < bp->start + bp->size -
68 VLIB_BUFFER_DATA_SIZE);
72 vlib_buffer_ptr_from_index (uword buffer_mem_start, u32 buffer_index,
75 offset += ((uword) buffer_index) << CLIB_LOG2_CACHE_LINE_BYTES;
76 return uword_to_pointer (buffer_mem_start + offset, vlib_buffer_t *);
79 /** \brief Translate buffer index into buffer pointer
81 @param vm - (vlib_main_t *) vlib main data structure pointer
82 @param buffer_index - (u32) buffer index
83 @return - (vlib_buffer_t *) buffer pointer
85 always_inline vlib_buffer_t *
86 vlib_get_buffer (vlib_main_t * vm, u32 buffer_index)
88 vlib_buffer_main_t *bm = vm->buffer_main;
91 b = vlib_buffer_ptr_from_index (bm->buffer_mem_start, buffer_index, 0);
92 vlib_buffer_validate (vm, b);
96 static_always_inline void
97 vlib_buffer_copy_indices (u32 * dst, u32 * src, u32 n_indices)
99 clib_memcpy_fast (dst, src, n_indices * sizeof (u32));
102 STATIC_ASSERT_OFFSET_OF (vlib_buffer_t, template_end, 64);
103 static_always_inline void
104 vlib_buffer_copy_template (vlib_buffer_t * b, vlib_buffer_t * bt)
106 #if defined CLIB_HAVE_VEC512
107 b->as_u8x64[0] = bt->as_u8x64[0];
108 #elif defined (CLIB_HAVE_VEC256)
109 b->as_u8x32[0] = bt->as_u8x32[0];
110 b->as_u8x32[1] = bt->as_u8x32[1];
111 #elif defined (CLIB_HAVE_VEC128)
112 b->as_u8x16[0] = bt->as_u8x16[0];
113 b->as_u8x16[1] = bt->as_u8x16[1];
114 b->as_u8x16[2] = bt->as_u8x16[2];
115 b->as_u8x16[3] = bt->as_u8x16[3];
117 clib_memcpy_fast (b, bt, 64);
122 vlib_buffer_pool_get_default_for_numa (vlib_main_t * vm, u32 numa_node)
124 ASSERT (numa_node < vm->buffer_main->n_numa_nodes);
128 /** \brief Translate array of buffer indices into buffer pointers with offset
130 @param vm - (vlib_main_t *) vlib main data structure pointer
131 @param bi - (u32 *) array of buffer indices
132 @param b - (void **) array to store buffer pointers
133 @param count - (uword) number of elements
134 @param offset - (i32) offset applied to each pointer
136 static_always_inline void
137 vlib_get_buffers_with_offset (vlib_main_t * vm, u32 * bi, void **b, int count,
140 uword buffer_mem_start = vm->buffer_main->buffer_mem_start;
141 #ifdef CLIB_HAVE_VEC256
142 u64x4 off = u64x4_splat (buffer_mem_start + offset);
143 /* if count is not const, compiler will not unroll while loop
144 se we maintain two-in-parallel variant */
147 u64x4 b0 = u32x4_extend_to_u64x4 (u32x4_load_unaligned (bi));
148 u64x4 b1 = u32x4_extend_to_u64x4 (u32x4_load_unaligned (bi + 4));
149 /* shift and add to get vlib_buffer_t pointer */
150 u64x4_store_unaligned ((b0 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b);
151 u64x4_store_unaligned ((b1 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b + 4);
159 #ifdef CLIB_HAVE_VEC256
160 u64x4 b0 = u32x4_extend_to_u64x4 (u32x4_load_unaligned (bi));
161 /* shift and add to get vlib_buffer_t pointer */
162 u64x4_store_unaligned ((b0 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b);
163 #elif defined (CLIB_HAVE_VEC128)
164 u64x2 off = u64x2_splat (buffer_mem_start + offset);
165 u32x4 bi4 = u32x4_load_unaligned (bi);
166 u64x2 b0 = u32x4_extend_to_u64x2 ((u32x4) bi4);
167 #if defined (__aarch64__)
168 u64x2 b1 = u32x4_extend_to_u64x2_high ((u32x4) bi4);
170 bi4 = u32x4_shuffle (bi4, 2, 3, 0, 1);
171 u64x2 b1 = u32x4_extend_to_u64x2 ((u32x4) bi4);
173 u64x2_store_unaligned ((b0 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b);
174 u64x2_store_unaligned ((b1 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b + 2);
176 b[0] = vlib_buffer_ptr_from_index (buffer_mem_start, bi[0], offset);
177 b[1] = vlib_buffer_ptr_from_index (buffer_mem_start, bi[1], offset);
178 b[2] = vlib_buffer_ptr_from_index (buffer_mem_start, bi[2], offset);
179 b[3] = vlib_buffer_ptr_from_index (buffer_mem_start, bi[3], offset);
187 b[0] = vlib_buffer_ptr_from_index (buffer_mem_start, bi[0], offset);
194 /** \brief Translate array of buffer indices into buffer pointers
196 @param vm - (vlib_main_t *) vlib main data structure pointer
197 @param bi - (u32 *) array of buffer indices
198 @param b - (vlib_buffer_t **) array to store buffer pointers
199 @param count - (uword) number of elements
202 static_always_inline void
203 vlib_get_buffers (vlib_main_t * vm, u32 * bi, vlib_buffer_t ** b, int count)
205 vlib_get_buffers_with_offset (vm, bi, (void **) b, count, 0);
208 /** \brief Translate buffer pointer into buffer index
210 @param vm - (vlib_main_t *) vlib main data structure pointer
211 @param p - (void *) buffer pointer
212 @return - (u32) buffer index
216 vlib_get_buffer_index (vlib_main_t * vm, void *p)
218 vlib_buffer_main_t *bm = vm->buffer_main;
219 uword offset = pointer_to_uword (p) - bm->buffer_mem_start;
220 ASSERT (pointer_to_uword (p) >= bm->buffer_mem_start);
221 ASSERT (offset < bm->buffer_mem_size);
222 ASSERT ((offset % (1 << CLIB_LOG2_CACHE_LINE_BYTES)) == 0);
223 return offset >> CLIB_LOG2_CACHE_LINE_BYTES;
226 /** \brief Translate array of buffer pointers into buffer indices with offset
228 @param vm - (vlib_main_t *) vlib main data structure pointer
229 @param b - (void **) array of buffer pointers
230 @param bi - (u32 *) array to store buffer indices
231 @param count - (uword) number of elements
232 @param offset - (i32) offset applied to each pointer
234 static_always_inline void
235 vlib_get_buffer_indices_with_offset (vlib_main_t * vm, void **b, u32 * bi,
236 uword count, i32 offset)
238 #ifdef CLIB_HAVE_VEC256
239 u32x8 mask = { 0, 2, 4, 6, 1, 3, 5, 7 };
240 u64x4 off4 = u64x4_splat (vm->buffer_main->buffer_mem_start - offset);
244 /* load 4 pointers into 256-bit register */
245 u64x4 v0 = u64x4_load_unaligned (b);
246 u64x4 v1 = u64x4_load_unaligned (b + 4);
252 v0 >>= CLIB_LOG2_CACHE_LINE_BYTES;
253 v1 >>= CLIB_LOG2_CACHE_LINE_BYTES;
255 /* permute 256-bit register so lower u32s of each buffer index are
256 * placed into lower 128-bits */
257 v2 = u32x8_permute ((u32x8) v0, mask);
258 v3 = u32x8_permute ((u32x8) v1, mask);
260 /* extract lower 128-bits and save them to the array of buffer indices */
261 u32x4_store_unaligned (u32x8_extract_lo (v2), bi);
262 u32x4_store_unaligned (u32x8_extract_lo (v3), bi + 4);
270 /* equivalent non-nector implementation */
271 bi[0] = vlib_get_buffer_index (vm, ((u8 *) b[0]) + offset);
272 bi[1] = vlib_get_buffer_index (vm, ((u8 *) b[1]) + offset);
273 bi[2] = vlib_get_buffer_index (vm, ((u8 *) b[2]) + offset);
274 bi[3] = vlib_get_buffer_index (vm, ((u8 *) b[3]) + offset);
281 bi[0] = vlib_get_buffer_index (vm, ((u8 *) b[0]) + offset);
288 /** \brief Translate array of buffer pointers into buffer indices
290 @param vm - (vlib_main_t *) vlib main data structure pointer
291 @param b - (vlib_buffer_t **) array of buffer pointers
292 @param bi - (u32 *) array to store buffer indices
293 @param count - (uword) number of elements
295 static_always_inline void
296 vlib_get_buffer_indices (vlib_main_t * vm, vlib_buffer_t ** b, u32 * bi,
299 vlib_get_buffer_indices_with_offset (vm, (void **) b, bi, count, 0);
302 /** \brief Get next buffer in buffer linklist, or zero for end of list.
304 @param vm - (vlib_main_t *) vlib main data structure pointer
305 @param b - (void *) buffer pointer
306 @return - (vlib_buffer_t *) next buffer, or NULL
308 always_inline vlib_buffer_t *
309 vlib_get_next_buffer (vlib_main_t * vm, vlib_buffer_t * b)
311 return (b->flags & VLIB_BUFFER_NEXT_PRESENT
312 ? vlib_get_buffer (vm, b->next_buffer) : 0);
315 uword vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
316 vlib_buffer_t * b_first);
318 /** \brief Get length in bytes of the buffer chain
320 @param vm - (vlib_main_t *) vlib main data structure pointer
321 @param b - (void *) buffer pointer
322 @return - (uword) length of buffer chain
325 vlib_buffer_length_in_chain (vlib_main_t * vm, vlib_buffer_t * b)
327 uword len = b->current_length;
329 if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) == 0))
332 if (PREDICT_TRUE (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID))
333 return len + b->total_length_not_including_first_buffer;
335 return vlib_buffer_length_in_chain_slow_path (vm, b);
338 /** \brief Get length in bytes of the buffer index buffer chain
340 @param vm - (vlib_main_t *) vlib main data structure pointer
341 @param bi - (u32) buffer index
342 @return - (uword) length of buffer chain
345 vlib_buffer_index_length_in_chain (vlib_main_t * vm, u32 bi)
347 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
348 return vlib_buffer_length_in_chain (vm, b);
351 /** \brief Copy buffer contents to memory
353 @param vm - (vlib_main_t *) vlib main data structure pointer
354 @param buffer_index - (u32) buffer index
355 @param contents - (u8 *) memory, <strong>must be large enough</strong>
356 @return - (uword) length of buffer chain
359 vlib_buffer_contents (vlib_main_t * vm, u32 buffer_index, u8 * contents)
361 uword content_len = 0;
367 b = vlib_get_buffer (vm, buffer_index);
368 l = b->current_length;
369 clib_memcpy_fast (contents + content_len, b->data + b->current_data, l);
371 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
373 buffer_index = b->next_buffer;
380 vlib_buffer_get_pa (vlib_main_t * vm, vlib_buffer_t * b)
382 return vlib_physmem_get_pa (vm, b->data);
386 vlib_buffer_get_current_pa (vlib_main_t * vm, vlib_buffer_t * b)
388 return vlib_buffer_get_pa (vm, b) + b->current_data;
391 /** \brief Prefetch buffer metadata by buffer index
392 The first 64 bytes of buffer contains most header information
394 @param vm - (vlib_main_t *) vlib main data structure pointer
395 @param bi - (u32) buffer index
396 @param type - LOAD, STORE. In most cases, STORE is the right answer
398 /* Prefetch buffer header given index. */
399 #define vlib_prefetch_buffer_with_index(vm,bi,type) \
401 vlib_buffer_t * _b = vlib_get_buffer (vm, bi); \
402 vlib_prefetch_buffer_header (_b, type); \
407 /* Index is unknown. */
410 /* Index is known and free/allocated. */
411 VLIB_BUFFER_KNOWN_FREE,
412 VLIB_BUFFER_KNOWN_ALLOCATED,
413 } vlib_buffer_known_state_t;
415 void vlib_buffer_validate_alloc_free (vlib_main_t * vm, u32 * buffers,
417 vlib_buffer_known_state_t
420 always_inline vlib_buffer_known_state_t
421 vlib_buffer_is_known (vlib_main_t * vm, u32 buffer_index)
423 vlib_buffer_main_t *bm = vm->buffer_main;
425 clib_spinlock_lock (&bm->buffer_known_hash_lockp);
426 uword *p = hash_get (bm->buffer_known_hash, buffer_index);
427 clib_spinlock_unlock (&bm->buffer_known_hash_lockp);
428 return p ? p[0] : VLIB_BUFFER_UNKNOWN;
431 /* Validates sanity of a single buffer.
432 Returns format'ed vector with error message if any. */
433 u8 *vlib_validate_buffer (vlib_main_t * vm, u32 buffer_index,
436 static_always_inline vlib_buffer_pool_t *
437 vlib_get_buffer_pool (vlib_main_t * vm, u8 buffer_pool_index)
439 vlib_buffer_main_t *bm = vm->buffer_main;
440 return vec_elt_at_index (bm->buffer_pools, buffer_pool_index);
443 static_always_inline uword
444 vlib_buffer_pool_get (vlib_main_t * vm, u8 buffer_pool_index, u32 * buffers,
447 vlib_buffer_pool_t *bp = vlib_get_buffer_pool (vm, buffer_pool_index);
450 ASSERT (bp->buffers);
452 clib_spinlock_lock (&bp->lock);
453 len = vec_len (bp->buffers);
454 if (PREDICT_TRUE (n_buffers < len))
457 vlib_buffer_copy_indices (buffers, bp->buffers + len, n_buffers);
458 _vec_len (bp->buffers) = len;
459 clib_spinlock_unlock (&bp->lock);
464 vlib_buffer_copy_indices (buffers, bp->buffers, len);
465 _vec_len (bp->buffers) = 0;
466 clib_spinlock_unlock (&bp->lock);
472 /** \brief Allocate buffers from specific pool into supplied array
474 @param vm - (vlib_main_t *) vlib main data structure pointer
475 @param buffers - (u32 * ) buffer index array
476 @param n_buffers - (u32) number of buffers requested
477 @return - (u32) number of buffers actually allocated, may be
478 less than the number requested or zero
482 vlib_buffer_alloc_from_pool (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
483 u8 buffer_pool_index)
485 vlib_buffer_main_t *bm = vm->buffer_main;
486 vlib_buffer_pool_t *bp;
487 vlib_buffer_pool_thread_t *bpt;
488 u32 *src, *dst, len, n_left;
490 bp = vec_elt_at_index (bm->buffer_pools, buffer_pool_index);
491 bpt = vec_elt_at_index (bp->threads, vm->thread_index);
495 len = vec_len (bpt->cached_buffers);
497 /* per-thread cache contains enough buffers */
498 if (len >= n_buffers)
500 src = bpt->cached_buffers + len - n_buffers;
501 vlib_buffer_copy_indices (dst, src, n_buffers);
502 _vec_len (bpt->cached_buffers) -= n_buffers;
505 vlib_buffer_validate_alloc_free (vm, buffers, n_buffers,
506 VLIB_BUFFER_KNOWN_FREE);
510 /* take everything available in the cache */
513 vlib_buffer_copy_indices (dst, bpt->cached_buffers, len);
514 _vec_len (bpt->cached_buffers) = 0;
519 len = round_pow2 (n_left, 32);
520 vec_validate_aligned (bpt->cached_buffers, len - 1, CLIB_CACHE_LINE_BYTES);
521 len = vlib_buffer_pool_get (vm, buffer_pool_index, bpt->cached_buffers,
523 _vec_len (bpt->cached_buffers) = len;
527 u32 n_copy = clib_min (len, n_left);
528 src = bpt->cached_buffers + len - n_copy;
529 vlib_buffer_copy_indices (dst, src, n_copy);
530 _vec_len (bpt->cached_buffers) -= n_copy;
536 /* Verify that buffers are known free. */
538 vlib_buffer_validate_alloc_free (vm, buffers, n_buffers,
539 VLIB_BUFFER_KNOWN_FREE);
544 /** \brief Allocate buffers from specific numa node into supplied array
546 @param vm - (vlib_main_t *) vlib main data structure pointer
547 @param buffers - (u32 * ) buffer index array
548 @param n_buffers - (u32) number of buffers requested
549 @param numa_node - (u32) numa node
550 @return - (u32) number of buffers actually allocated, may be
551 less than the number requested or zero
554 vlib_buffer_alloc_on_numa (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
557 u8 index = vlib_buffer_pool_get_default_for_numa (vm, numa_node);
558 return vlib_buffer_alloc_from_pool (vm, buffers, n_buffers, index);
561 /** \brief Allocate buffers into supplied array
563 @param vm - (vlib_main_t *) vlib main data structure pointer
564 @param buffers - (u32 * ) buffer index array
565 @param n_buffers - (u32) number of buffers requested
566 @return - (u32) number of buffers actually allocated, may be
567 less than the number requested or zero
571 vlib_buffer_alloc (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
573 return vlib_buffer_alloc_on_numa (vm, buffers, n_buffers, vm->numa_node);
576 /** \brief Allocate buffers into ring
578 @param vm - (vlib_main_t *) vlib main data structure pointer
579 @param buffers - (u32 * ) buffer index ring
580 @param start - (u32) first slot in the ring
581 @param ring_size - (u32) ring size
582 @param n_buffers - (u32) number of buffers requested
583 @return - (u32) number of buffers actually allocated, may be
584 less than the number requested or zero
587 vlib_buffer_alloc_to_ring (vlib_main_t * vm, u32 * ring, u32 start,
588 u32 ring_size, u32 n_buffers)
592 ASSERT (n_buffers <= ring_size);
594 if (PREDICT_TRUE (start + n_buffers <= ring_size))
595 return vlib_buffer_alloc (vm, ring + start, n_buffers);
597 n_alloc = vlib_buffer_alloc (vm, ring + start, ring_size - start);
599 if (PREDICT_TRUE (n_alloc == ring_size - start))
600 n_alloc += vlib_buffer_alloc (vm, ring, n_buffers - n_alloc);
605 /** \brief Allocate buffers into ring from specific buffer pool
607 @param vm - (vlib_main_t *) vlib main data structure pointer
608 @param buffers - (u32 * ) buffer index ring
609 @param start - (u32) first slot in the ring
610 @param ring_size - (u32) ring size
611 @param n_buffers - (u32) number of buffers requested
612 @return - (u32) number of buffers actually allocated, may be
613 less than the number requested or zero
616 vlib_buffer_alloc_to_ring_from_pool (vlib_main_t * vm, u32 * ring, u32 start,
617 u32 ring_size, u32 n_buffers,
618 u8 buffer_pool_index)
622 ASSERT (n_buffers <= ring_size);
624 if (PREDICT_TRUE (start + n_buffers <= ring_size))
625 return vlib_buffer_alloc_from_pool (vm, ring + start, n_buffers,
628 n_alloc = vlib_buffer_alloc_from_pool (vm, ring + start, ring_size - start,
631 if (PREDICT_TRUE (n_alloc == ring_size - start))
632 n_alloc += vlib_buffer_alloc_from_pool (vm, ring, n_buffers - n_alloc,
638 static_always_inline void
639 vlib_buffer_pool_put (vlib_main_t * vm, u8 buffer_pool_index,
640 u32 * buffers, u32 n_buffers)
642 vlib_buffer_pool_t *bp = vlib_get_buffer_pool (vm, buffer_pool_index);
643 vlib_buffer_pool_thread_t *bpt =
644 vec_elt_at_index (bp->threads, vm->thread_index);
647 vlib_buffer_validate_alloc_free (vm, buffers, n_buffers,
648 VLIB_BUFFER_KNOWN_ALLOCATED);
650 vec_add_aligned (bpt->cached_buffers, buffers, n_buffers,
651 CLIB_CACHE_LINE_BYTES);
653 if (vec_len (bpt->cached_buffers) > 4 * VLIB_FRAME_SIZE)
655 clib_spinlock_lock (&bp->lock);
656 /* keep last stored buffers, as they are more likely hot in the cache */
657 vec_add_aligned (bp->buffers, bpt->cached_buffers, VLIB_FRAME_SIZE,
658 CLIB_CACHE_LINE_BYTES);
659 vec_delete (bpt->cached_buffers, VLIB_FRAME_SIZE, 0);
660 bpt->n_alloc -= VLIB_FRAME_SIZE;
661 clib_spinlock_unlock (&bp->lock);
665 static_always_inline void
666 vlib_buffer_free_inline (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
669 const int queue_size = 128;
670 vlib_buffer_pool_t *bp = 0;
671 u8 buffer_pool_index = ~0;
672 u32 n_queue = 0, queue[queue_size + 4];
673 vlib_buffer_t bt = { };
674 #if defined(CLIB_HAVE_VEC128) && !__aarch64__
675 vlib_buffer_t bpi_mask = {.buffer_pool_index = ~0 };
676 vlib_buffer_t bpi_vec = {.buffer_pool_index = ~0 };
677 vlib_buffer_t flags_refs_mask = {
678 .flags = VLIB_BUFFER_NEXT_PRESENT,
686 u32 bi, sum = 0, flags, next;
691 vlib_get_buffers (vm, buffers, b, 4);
692 vlib_get_buffers (vm, buffers + 8, b + 4, 4);
694 vlib_prefetch_buffer_header (b[4], LOAD);
695 vlib_prefetch_buffer_header (b[5], LOAD);
696 vlib_prefetch_buffer_header (b[6], LOAD);
697 vlib_prefetch_buffer_header (b[7], LOAD);
699 #if defined(CLIB_HAVE_VEC128) && !__aarch64__
700 u8x16 p0, p1, p2, p3, r;
701 p0 = u8x16_load_unaligned (b[0]);
702 p1 = u8x16_load_unaligned (b[1]);
703 p2 = u8x16_load_unaligned (b[2]);
704 p3 = u8x16_load_unaligned (b[3]);
706 r = p0 ^ bpi_vec.as_u8x16[0];
707 r |= p1 ^ bpi_vec.as_u8x16[0];
708 r |= p2 ^ bpi_vec.as_u8x16[0];
709 r |= p3 ^ bpi_vec.as_u8x16[0];
710 r &= bpi_mask.as_u8x16[0];
711 r |= (p0 | p1 | p2 | p3) & flags_refs_mask.as_u8x16[0];
713 sum = !u8x16_is_all_zero (r);
719 sum &= VLIB_BUFFER_NEXT_PRESENT;
720 sum += b[0]->ref_count - 1;
721 sum += b[1]->ref_count - 1;
722 sum += b[2]->ref_count - 1;
723 sum += b[3]->ref_count - 1;
724 sum |= b[0]->buffer_pool_index ^ buffer_pool_index;
725 sum |= b[1]->buffer_pool_index ^ buffer_pool_index;
726 sum |= b[2]->buffer_pool_index ^ buffer_pool_index;
727 sum |= b[3]->buffer_pool_index ^ buffer_pool_index;
733 vlib_buffer_copy_indices (queue + n_queue, buffers, 4);
734 vlib_buffer_copy_template (b[0], &bt);
735 vlib_buffer_copy_template (b[1], &bt);
736 vlib_buffer_copy_template (b[2], &bt);
737 vlib_buffer_copy_template (b[3], &bt);
740 vlib_buffer_validate (vm, b[0]);
741 vlib_buffer_validate (vm, b[1]);
742 vlib_buffer_validate (vm, b[2]);
743 vlib_buffer_validate (vm, b[3]);
745 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
746 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[1]);
747 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[2]);
748 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[3]);
750 if (n_queue >= queue_size)
752 vlib_buffer_pool_put (vm, buffer_pool_index, queue, n_queue);
763 b[0] = vlib_get_buffer (vm, bi);
765 next = b[0]->next_buffer;
767 if (PREDICT_FALSE (buffer_pool_index != b[0]->buffer_pool_index))
769 buffer_pool_index = b[0]->buffer_pool_index;
770 #if defined(CLIB_HAVE_VEC128) && !__aarch64__
771 bpi_vec.buffer_pool_index = buffer_pool_index;
773 bp = vlib_get_buffer_pool (vm, buffer_pool_index);
774 vlib_buffer_copy_template (&bt, &bp->buffer_template);
778 vlib_buffer_pool_put (vm, buffer_pool_index, queue, n_queue);
783 vlib_buffer_validate (vm, b[0]);
785 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
787 if (clib_atomic_sub_fetch (&b[0]->ref_count, 1) == 0)
789 vlib_buffer_copy_template (b[0], &bt);
790 queue[n_queue++] = bi;
793 if (n_queue == queue_size)
795 vlib_buffer_pool_put (vm, buffer_pool_index, queue, queue_size);
799 if (flags & VLIB_BUFFER_NEXT_PRESENT)
810 vlib_buffer_pool_put (vm, buffer_pool_index, queue, n_queue);
814 /** \brief Free buffers
815 Frees the entire buffer chain for each buffer
817 @param vm - (vlib_main_t *) vlib main data structure pointer
818 @param buffers - (u32 * ) buffer index array
819 @param n_buffers - (u32) number of buffers to free
823 vlib_buffer_free (vlib_main_t * vm,
824 /* pointer to first buffer */
826 /* number of buffers to free */
829 vlib_buffer_free_inline (vm, buffers, n_buffers, /* maybe next */ 1);
832 /** \brief Free buffers, does not free the buffer chain for each buffer
834 @param vm - (vlib_main_t *) vlib main data structure pointer
835 @param buffers - (u32 * ) buffer index array
836 @param n_buffers - (u32) number of buffers to free
840 vlib_buffer_free_no_next (vlib_main_t * vm,
841 /* pointer to first buffer */
843 /* number of buffers to free */
846 vlib_buffer_free_inline (vm, buffers, n_buffers, /* maybe next */ 0);
849 /** \brief Free one buffer
850 Shorthand to free a single buffer chain.
852 @param vm - (vlib_main_t *) vlib main data structure pointer
853 @param buffer_index - (u32) buffer index to free
856 vlib_buffer_free_one (vlib_main_t * vm, u32 buffer_index)
858 vlib_buffer_free_inline (vm, &buffer_index, 1, /* maybe next */ 1);
861 /** \brief Free buffers from ring
863 @param vm - (vlib_main_t *) vlib main data structure pointer
864 @param buffers - (u32 * ) buffer index ring
865 @param start - (u32) first slot in the ring
866 @param ring_size - (u32) ring size
867 @param n_buffers - (u32) number of buffers
870 vlib_buffer_free_from_ring (vlib_main_t * vm, u32 * ring, u32 start,
871 u32 ring_size, u32 n_buffers)
873 ASSERT (n_buffers <= ring_size);
875 if (PREDICT_TRUE (start + n_buffers <= ring_size))
877 vlib_buffer_free (vm, ring + start, n_buffers);
881 vlib_buffer_free (vm, ring + start, ring_size - start);
882 vlib_buffer_free (vm, ring, n_buffers - (ring_size - start));
886 /** \brief Free buffers from ring without freeing tail buffers
888 @param vm - (vlib_main_t *) vlib main data structure pointer
889 @param buffers - (u32 * ) buffer index ring
890 @param start - (u32) first slot in the ring
891 @param ring_size - (u32) ring size
892 @param n_buffers - (u32) number of buffers
895 vlib_buffer_free_from_ring_no_next (vlib_main_t * vm, u32 * ring, u32 start,
896 u32 ring_size, u32 n_buffers)
898 ASSERT (n_buffers <= ring_size);
900 if (PREDICT_TRUE (start + n_buffers <= ring_size))
902 vlib_buffer_free_no_next (vm, ring + start, n_buffers);
906 vlib_buffer_free_no_next (vm, ring + start, ring_size - start);
907 vlib_buffer_free_no_next (vm, ring, n_buffers - (ring_size - start));
911 /* Append given data to end of buffer, possibly allocating new buffers. */
912 int vlib_buffer_add_data (vlib_main_t * vm, u32 * buffer_index, void *data,
915 /* duplicate all buffers in chain */
916 always_inline vlib_buffer_t *
917 vlib_buffer_copy (vlib_main_t * vm, vlib_buffer_t * b)
919 vlib_buffer_t *s, *d, *fd;
920 uword n_alloc, n_buffers = 1;
921 u32 flag_mask = VLIB_BUFFER_NEXT_PRESENT | VLIB_BUFFER_TOTAL_LENGTH_VALID;
925 while (s->flags & VLIB_BUFFER_NEXT_PRESENT)
928 s = vlib_get_buffer (vm, s->next_buffer);
930 u32 new_buffers[n_buffers];
932 n_alloc = vlib_buffer_alloc (vm, new_buffers, n_buffers);
934 /* No guarantee that we'll get all the buffers we asked for */
935 if (PREDICT_FALSE (n_alloc < n_buffers))
938 vlib_buffer_free (vm, new_buffers, n_alloc);
944 fd = d = vlib_get_buffer (vm, new_buffers[0]);
945 d->current_data = s->current_data;
946 d->current_length = s->current_length;
947 d->flags = s->flags & flag_mask;
948 d->total_length_not_including_first_buffer =
949 s->total_length_not_including_first_buffer;
950 clib_memcpy_fast (d->opaque, s->opaque, sizeof (s->opaque));
951 clib_memcpy_fast (d->opaque2, s->opaque2, sizeof (s->opaque2));
952 clib_memcpy_fast (vlib_buffer_get_current (d),
953 vlib_buffer_get_current (s), s->current_length);
956 for (i = 1; i < n_buffers; i++)
959 d->next_buffer = new_buffers[i];
961 s = vlib_get_buffer (vm, s->next_buffer);
962 d = vlib_get_buffer (vm, new_buffers[i]);
963 d->current_data = s->current_data;
964 d->current_length = s->current_length;
965 clib_memcpy_fast (vlib_buffer_get_current (d),
966 vlib_buffer_get_current (s), s->current_length);
967 d->flags = s->flags & flag_mask;
973 /** \brief Create a maximum of 256 clones of buffer and store them
974 in the supplied array
976 @param vm - (vlib_main_t *) vlib main data structure pointer
977 @param src_buffer - (u32) source buffer index
978 @param buffers - (u32 * ) buffer index array
979 @param n_buffers - (u16) number of buffer clones requested (<=256)
980 @param head_end_offset - (u16) offset relative to current position
981 where packet head ends
982 @return - (u16) number of buffers actually cloned, may be
983 less than the number requested or zero
986 vlib_buffer_clone_256 (vlib_main_t * vm, u32 src_buffer, u32 * buffers,
987 u16 n_buffers, u16 head_end_offset)
990 vlib_buffer_t *s = vlib_get_buffer (vm, src_buffer);
992 ASSERT (s->ref_count == 1);
994 ASSERT (n_buffers <= 256);
996 if (s->current_length <= head_end_offset + CLIB_CACHE_LINE_BYTES * 2)
998 buffers[0] = src_buffer;
999 for (i = 1; i < n_buffers; i++)
1002 d = vlib_buffer_copy (vm, s);
1005 buffers[i] = vlib_get_buffer_index (vm, d);
1011 if (PREDICT_FALSE (n_buffers == 1))
1013 buffers[0] = src_buffer;
1017 n_buffers = vlib_buffer_alloc_from_pool (vm, buffers, n_buffers,
1018 s->buffer_pool_index);
1020 for (i = 0; i < n_buffers; i++)
1022 vlib_buffer_t *d = vlib_get_buffer (vm, buffers[i]);
1023 d->current_data = s->current_data;
1024 d->current_length = head_end_offset;
1025 ASSERT (d->buffer_pool_index == s->buffer_pool_index);
1027 d->total_length_not_including_first_buffer = s->current_length -
1029 if (PREDICT_FALSE (s->flags & VLIB_BUFFER_NEXT_PRESENT))
1031 d->total_length_not_including_first_buffer +=
1032 s->total_length_not_including_first_buffer;
1034 d->flags = s->flags | VLIB_BUFFER_NEXT_PRESENT;
1035 d->flags &= ~VLIB_BUFFER_EXT_HDR_VALID;
1036 clib_memcpy_fast (d->opaque, s->opaque, sizeof (s->opaque));
1037 clib_memcpy_fast (d->opaque2, s->opaque2, sizeof (s->opaque2));
1038 clib_memcpy_fast (vlib_buffer_get_current (d),
1039 vlib_buffer_get_current (s), head_end_offset);
1040 d->next_buffer = src_buffer;
1042 vlib_buffer_advance (s, head_end_offset);
1043 s->ref_count = n_buffers;
1044 while (s->flags & VLIB_BUFFER_NEXT_PRESENT)
1046 s = vlib_get_buffer (vm, s->next_buffer);
1047 s->ref_count = n_buffers;
1053 /** \brief Create multiple clones of buffer and store them
1054 in the supplied array
1056 @param vm - (vlib_main_t *) vlib main data structure pointer
1057 @param src_buffer - (u32) source buffer index
1058 @param buffers - (u32 * ) buffer index array
1059 @param n_buffers - (u16) number of buffer clones requested (<=256)
1060 @param head_end_offset - (u16) offset relative to current position
1061 where packet head ends
1062 @return - (u16) number of buffers actually cloned, may be
1063 less than the number requested or zero
1066 vlib_buffer_clone (vlib_main_t * vm, u32 src_buffer, u32 * buffers,
1067 u16 n_buffers, u16 head_end_offset)
1069 vlib_buffer_t *s = vlib_get_buffer (vm, src_buffer);
1072 while (n_buffers > 256)
1074 vlib_buffer_t *copy;
1075 copy = vlib_buffer_copy (vm, s);
1076 n_cloned += vlib_buffer_clone_256 (vm,
1077 vlib_get_buffer_index (vm, copy),
1078 (buffers + n_cloned),
1079 256, head_end_offset);
1082 n_cloned += vlib_buffer_clone_256 (vm, src_buffer,
1084 n_buffers, head_end_offset);
1089 /** \brief Attach cloned tail to the buffer
1091 @param vm - (vlib_main_t *) vlib main data structure pointer
1092 @param head - (vlib_buffer_t *) head buffer
1093 @param tail - (Vlib buffer_t *) tail buffer to clone and attach to head
1097 vlib_buffer_attach_clone (vlib_main_t * vm, vlib_buffer_t * head,
1098 vlib_buffer_t * tail)
1100 ASSERT ((head->flags & VLIB_BUFFER_NEXT_PRESENT) == 0);
1101 ASSERT (head->buffer_pool_index == tail->buffer_pool_index);
1103 head->flags |= VLIB_BUFFER_NEXT_PRESENT;
1104 head->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
1105 head->flags &= ~VLIB_BUFFER_EXT_HDR_VALID;
1106 head->flags |= (tail->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID);
1107 head->next_buffer = vlib_get_buffer_index (vm, tail);
1108 head->total_length_not_including_first_buffer = tail->current_length +
1109 tail->total_length_not_including_first_buffer;
1112 clib_atomic_add_fetch (&tail->ref_count, 1);
1114 if (tail->flags & VLIB_BUFFER_NEXT_PRESENT)
1116 tail = vlib_get_buffer (vm, tail->next_buffer);
1121 /* Initializes the buffer as an empty packet with no chained buffers. */
1123 vlib_buffer_chain_init (vlib_buffer_t * first)
1125 first->total_length_not_including_first_buffer = 0;
1126 first->current_length = 0;
1127 first->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
1128 first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
1131 /* The provided next_bi buffer index is appended to the end of the packet. */
1132 always_inline vlib_buffer_t *
1133 vlib_buffer_chain_buffer (vlib_main_t * vm, vlib_buffer_t * last, u32 next_bi)
1135 vlib_buffer_t *next_buffer = vlib_get_buffer (vm, next_bi);
1136 last->next_buffer = next_bi;
1137 last->flags |= VLIB_BUFFER_NEXT_PRESENT;
1138 next_buffer->current_length = 0;
1139 next_buffer->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
1143 /* Increases or decreases the packet length.
1144 * It does not allocate or deallocate new buffers.
1145 * Therefore, the added length must be compatible
1146 * with the last buffer. */
1148 vlib_buffer_chain_increase_length (vlib_buffer_t * first,
1149 vlib_buffer_t * last, i32 len)
1151 last->current_length += len;
1153 first->total_length_not_including_first_buffer += len;
1156 /* Copy data to the end of the packet and increases its length.
1157 * It does not allocate new buffers.
1158 * Returns the number of copied bytes. */
1160 vlib_buffer_chain_append_data (vlib_main_t * vm,
1161 vlib_buffer_t * first,
1162 vlib_buffer_t * last, void *data, u16 data_len)
1164 u32 n_buffer_bytes = VLIB_BUFFER_DATA_SIZE;
1165 ASSERT (n_buffer_bytes >= last->current_length + last->current_data);
1166 u16 len = clib_min (data_len,
1167 n_buffer_bytes - last->current_length -
1168 last->current_data);
1169 clib_memcpy_fast (vlib_buffer_get_current (last) + last->current_length,
1171 vlib_buffer_chain_increase_length (first, last, len);
1175 /* Copy data to the end of the packet and increases its length.
1176 * Allocates additional buffers from the free list if necessary.
1177 * Returns the number of copied bytes.
1178 * 'last' value is modified whenever new buffers are allocated and
1179 * chained and points to the last buffer in the chain. */
1181 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
1182 vlib_buffer_t * first,
1183 vlib_buffer_t ** last, void *data,
1185 void vlib_buffer_chain_validate (vlib_main_t * vm, vlib_buffer_t * first);
1187 format_function_t format_vlib_buffer, format_vlib_buffer_and_data,
1188 format_vlib_buffer_contents;
1192 /* Vector of packet data. */
1195 /* Number of buffers to allocate in each call to allocator. */
1196 u32 min_n_buffers_each_alloc;
1199 } vlib_packet_template_t;
1201 void vlib_packet_template_init (vlib_main_t * vm,
1202 vlib_packet_template_t * t,
1204 uword n_packet_data_bytes,
1205 uword min_n_buffers_each_alloc,
1208 void *vlib_packet_template_get_packet (vlib_main_t * vm,
1209 vlib_packet_template_t * t,
1213 vlib_packet_template_free (vlib_main_t * vm, vlib_packet_template_t * t)
1215 vec_free (t->packet_data);
1219 * @brief compress buffer chain in a way where the first buffer is at least
1220 * VLIB_BUFFER_CLONE_HEAD_SIZE long
1222 * @param[in] vm - vlib_main
1223 * @param[in,out] first - first buffer in chain
1224 * @param[in,out] discard_vector - vector of buffer indexes which were removed
1228 vlib_buffer_chain_compress (vlib_main_t * vm,
1229 vlib_buffer_t * first, u32 ** discard_vector)
1231 if (first->current_length >= VLIB_BUFFER_CLONE_HEAD_SIZE ||
1232 !(first->flags & VLIB_BUFFER_NEXT_PRESENT))
1234 /* this is already big enough or not a chain */
1238 u32 want_first_size = clib_min (VLIB_BUFFER_CLONE_HEAD_SIZE,
1239 VLIB_BUFFER_DATA_SIZE -
1240 first->current_data);
1243 vlib_buffer_t *second = vlib_get_buffer (vm, first->next_buffer);
1244 u32 need = want_first_size - first->current_length;
1245 u32 amount_to_copy = clib_min (need, second->current_length);
1246 clib_memcpy_fast (((u8 *) vlib_buffer_get_current (first)) +
1247 first->current_length,
1248 vlib_buffer_get_current (second), amount_to_copy);
1249 first->current_length += amount_to_copy;
1250 second->current_data += amount_to_copy;
1251 second->current_length -= amount_to_copy;
1252 if (first->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID)
1254 first->total_length_not_including_first_buffer -= amount_to_copy;
1256 if (!second->current_length)
1258 vec_add1 (*discard_vector, first->next_buffer);
1259 if (second->flags & VLIB_BUFFER_NEXT_PRESENT)
1261 first->next_buffer = second->next_buffer;
1265 first->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
1267 second->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
1270 while ((first->current_length < want_first_size) &&
1271 (first->flags & VLIB_BUFFER_NEXT_PRESENT));
1275 * @brief linearize buffer chain - the first buffer is filled, if needed,
1276 * buffers are allocated and filled, returns free space in last buffer or
1277 * negative on failure
1279 * @param[in] vm - vlib_main
1280 * @param[in,out] first - first buffer in chain
1283 vlib_buffer_chain_linearize (vlib_main_t * vm, vlib_buffer_t * first)
1285 vlib_buffer_t *b = first;
1286 u32 buf_len = VLIB_BUFFER_DATA_SIZE;
1287 // free buffer chain starting from the second buffer
1288 int free_count = (b->flags & VLIB_BUFFER_NEXT_PRESENT) != 0;
1289 u32 chain_to_free = b->next_buffer;
1291 u32 len = vlib_buffer_length_in_chain (vm, b);
1292 u32 free_len = buf_len - b->current_data - b->current_length;
1293 int alloc_len = clib_max (len - free_len, 0); //use the free len in the first buffer
1294 int n_buffers = (alloc_len + buf_len - 1) / buf_len;
1295 u32 new_buffers[n_buffers];
1297 u32 n_alloc = vlib_buffer_alloc (vm, new_buffers, n_buffers);
1298 if (n_alloc != n_buffers)
1300 vlib_buffer_free_no_next (vm, new_buffers, n_alloc);
1304 vlib_buffer_t *s = b;
1305 while (s->flags & VLIB_BUFFER_NEXT_PRESENT)
1307 s = vlib_get_buffer (vm, s->next_buffer);
1308 int d_free_len = buf_len - b->current_data - b->current_length;
1309 ASSERT (d_free_len >= 0);
1310 // chain buf and split write
1311 u32 copy_len = clib_min (d_free_len, s->current_length);
1312 u8 *d = vlib_buffer_put_uninit (b, copy_len);
1313 clib_memcpy (d, vlib_buffer_get_current (s), copy_len);
1314 int rest = s->current_length - copy_len;
1318 ASSERT (vlib_buffer_get_tail (b) == b->data + buf_len);
1319 ASSERT (n_buffers > 0);
1320 b = vlib_buffer_chain_buffer (vm, b, new_buffers[--n_buffers]);
1321 //make full use of the new buffers
1322 b->current_data = 0;
1323 d = vlib_buffer_put_uninit (b, rest);
1324 clib_memcpy (d, vlib_buffer_get_current (s) + copy_len, rest);
1327 vlib_buffer_free (vm, &chain_to_free, free_count);
1328 b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
1329 if (b == first) /* no buffers addeed */
1330 b->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
1331 ASSERT (len == vlib_buffer_length_in_chain (vm, first));
1332 ASSERT (n_buffers == 0);
1333 return buf_len - b->current_data - b->current_length;
1336 #endif /* included_vlib_buffer_funcs_h */
1339 * fd.io coding-style-patch-verification: ON
1342 * eval: (c-set-style "gnu")