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>
45 #include <vlib/buffer.h>
46 #include <vlib/physmem_funcs.h>
47 #include <vlib/main.h>
48 #include <vlib/node.h>
51 vlib buffer access methods.
54 typedef void (vlib_buffer_enqueue_to_next_fn_t) (vlib_main_t *vm,
55 vlib_node_runtime_t *node,
56 u32 *buffers, u16 *nexts,
58 typedef void (vlib_buffer_enqueue_to_single_next_fn_t) (
59 vlib_main_t *vm, vlib_node_runtime_t *node, u32 *ers, u16 next_index,
62 typedef u32 (vlib_buffer_enqueue_to_thread_fn_t) (
63 vlib_main_t *vm, u32 frame_queue_index, u32 *buffer_indices,
64 u16 *thread_indices, u32 n_packets, int drop_on_congestion);
67 vlib_buffer_enqueue_to_next_fn_t *buffer_enqueue_to_next_fn;
68 vlib_buffer_enqueue_to_single_next_fn_t *buffer_enqueue_to_single_next_fn;
69 vlib_buffer_enqueue_to_thread_fn_t *buffer_enqueue_to_thread_fn;
70 } vlib_buffer_func_main_t;
72 extern vlib_buffer_func_main_t vlib_buffer_func_main;
75 vlib_buffer_validate (vlib_main_t * vm, vlib_buffer_t * b)
77 vlib_buffer_main_t *bm = vm->buffer_main;
78 vlib_buffer_pool_t *bp;
80 /* reference count in allocated buffer always must be 1 or higher */
81 ASSERT (b->ref_count > 0);
83 /* verify that buffer pool index is valid */
84 bp = vec_elt_at_index (bm->buffer_pools, b->buffer_pool_index);
85 ASSERT (pointer_to_uword (b) >= bp->start);
86 ASSERT (pointer_to_uword (b) < bp->start + bp->size -
87 (bp->data_size + sizeof (vlib_buffer_t)));
91 vlib_buffer_ptr_from_index (uword buffer_mem_start, u32 buffer_index,
94 offset += ((uword) buffer_index) << CLIB_LOG2_CACHE_LINE_BYTES;
95 return uword_to_pointer (buffer_mem_start + offset, vlib_buffer_t *);
98 /** \brief Translate buffer index into buffer pointer
100 @param vm - (vlib_main_t *) vlib main data structure pointer
101 @param buffer_index - (u32) buffer index
102 @return - (vlib_buffer_t *) buffer pointer
104 always_inline vlib_buffer_t *
105 vlib_get_buffer (vlib_main_t * vm, u32 buffer_index)
107 vlib_buffer_main_t *bm = vm->buffer_main;
110 b = vlib_buffer_ptr_from_index (bm->buffer_mem_start, buffer_index, 0);
111 vlib_buffer_validate (vm, b);
115 static_always_inline u32
116 vlib_buffer_get_default_data_size (vlib_main_t * vm)
118 return vm->buffer_main->default_data_size;
121 static_always_inline void
122 vlib_buffer_copy_indices (u32 * dst, u32 * src, u32 n_indices)
124 #if defined(CLIB_HAVE_VEC512)
125 while (n_indices >= 16)
127 u32x16_store_unaligned (u32x16_load_unaligned (src), dst);
134 #if defined(CLIB_HAVE_VEC256)
135 while (n_indices >= 8)
137 u32x8_store_unaligned (u32x8_load_unaligned (src), dst);
144 #if defined(CLIB_HAVE_VEC128)
145 while (n_indices >= 4)
147 u32x4_store_unaligned (u32x4_load_unaligned (src), dst);
164 vlib_buffer_copy_indices_from_ring (u32 * dst, u32 * ring, u32 start,
165 u32 ring_size, u32 n_buffers)
167 ASSERT (n_buffers <= ring_size);
169 if (PREDICT_TRUE (start + n_buffers <= ring_size))
171 vlib_buffer_copy_indices (dst, ring + start, n_buffers);
175 u32 n = ring_size - start;
176 vlib_buffer_copy_indices (dst, ring + start, n);
177 vlib_buffer_copy_indices (dst + n, ring, n_buffers - n);
182 vlib_buffer_copy_indices_to_ring (u32 * ring, u32 * src, u32 start,
183 u32 ring_size, u32 n_buffers)
185 ASSERT (n_buffers <= ring_size);
187 if (PREDICT_TRUE (start + n_buffers <= ring_size))
189 vlib_buffer_copy_indices (ring + start, src, n_buffers);
193 u32 n = ring_size - start;
194 vlib_buffer_copy_indices (ring + start, src, n);
195 vlib_buffer_copy_indices (ring, src + n, n_buffers - n);
199 STATIC_ASSERT_OFFSET_OF (vlib_buffer_t, template_end, 64);
200 static_always_inline void
201 vlib_buffer_copy_template (vlib_buffer_t * b, vlib_buffer_t * bt)
203 #if defined CLIB_HAVE_VEC512
204 b->as_u8x64[0] = bt->as_u8x64[0];
205 #elif defined (CLIB_HAVE_VEC256)
206 b->as_u8x32[0] = bt->as_u8x32[0];
207 b->as_u8x32[1] = bt->as_u8x32[1];
208 #elif defined (CLIB_HAVE_VEC128)
209 b->as_u8x16[0] = bt->as_u8x16[0];
210 b->as_u8x16[1] = bt->as_u8x16[1];
211 b->as_u8x16[2] = bt->as_u8x16[2];
212 b->as_u8x16[3] = bt->as_u8x16[3];
214 clib_memcpy_fast (b, bt, 64);
219 vlib_buffer_pool_get_default_for_numa (vlib_main_t * vm, u32 numa_node)
221 ASSERT (numa_node < VLIB_BUFFER_MAX_NUMA_NODES);
222 return vm->buffer_main->default_buffer_pool_index_for_numa[numa_node];
225 /** \brief Translate array of buffer indices into buffer pointers with offset
227 @param vm - (vlib_main_t *) vlib main data structure pointer
228 @param bi - (u32 *) array of buffer indices
229 @param b - (void **) array to store buffer pointers
230 @param count - (uword) number of elements
231 @param offset - (i32) offset applied to each pointer
233 static_always_inline void
234 vlib_get_buffers_with_offset (vlib_main_t * vm, u32 * bi, void **b, int count,
237 uword buffer_mem_start = vm->buffer_main->buffer_mem_start;
238 #ifdef CLIB_HAVE_VEC256
239 u64x4 off = u64x4_splat (buffer_mem_start + offset);
240 /* if count is not const, compiler will not unroll while loop
241 se we maintain two-in-parallel variant */
244 u64x4 b0 = u64x4_from_u32x4 (u32x4_load_unaligned (bi));
245 u64x4 b1 = u64x4_from_u32x4 (u32x4_load_unaligned (bi + 4));
246 /* shift and add to get vlib_buffer_t pointer */
247 u64x4_store_unaligned ((b0 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b);
248 u64x4_store_unaligned ((b1 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b + 4);
256 #ifdef CLIB_HAVE_VEC256
257 u64x4 b0 = u64x4_from_u32x4 (u32x4_load_unaligned (bi));
258 /* shift and add to get vlib_buffer_t pointer */
259 u64x4_store_unaligned ((b0 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b);
260 #elif defined (CLIB_HAVE_VEC128)
261 u64x2 off = u64x2_splat (buffer_mem_start + offset);
262 u32x4 bi4 = u32x4_load_unaligned (bi);
263 u64x2 b0 = u64x2_from_u32x4 ((u32x4) bi4);
264 #if defined (__aarch64__)
265 u64x2 b1 = u64x2_from_u32x4_high ((u32x4) bi4);
267 bi4 = u32x4_shuffle (bi4, 2, 3, 0, 1);
268 u64x2 b1 = u64x2_from_u32x4 ((u32x4) bi4);
270 u64x2_store_unaligned ((b0 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b);
271 u64x2_store_unaligned ((b1 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b + 2);
273 b[0] = vlib_buffer_ptr_from_index (buffer_mem_start, bi[0], offset);
274 b[1] = vlib_buffer_ptr_from_index (buffer_mem_start, bi[1], offset);
275 b[2] = vlib_buffer_ptr_from_index (buffer_mem_start, bi[2], offset);
276 b[3] = vlib_buffer_ptr_from_index (buffer_mem_start, bi[3], offset);
284 b[0] = vlib_buffer_ptr_from_index (buffer_mem_start, bi[0], offset);
291 /** \brief Translate array of buffer indices into buffer pointers
293 @param vm - (vlib_main_t *) vlib main data structure pointer
294 @param bi - (u32 *) array of buffer indices
295 @param b - (vlib_buffer_t **) array to store buffer pointers
296 @param count - (uword) number of elements
299 static_always_inline void
300 vlib_get_buffers (vlib_main_t * vm, u32 * bi, vlib_buffer_t ** b, int count)
302 vlib_get_buffers_with_offset (vm, bi, (void **) b, count, 0);
305 /** \brief Translate buffer pointer into buffer index
307 @param vm - (vlib_main_t *) vlib main data structure pointer
308 @param p - (void *) buffer pointer
309 @return - (u32) buffer index
313 vlib_get_buffer_index (vlib_main_t * vm, void *p)
315 vlib_buffer_main_t *bm = vm->buffer_main;
316 uword offset = pointer_to_uword (p) - bm->buffer_mem_start;
317 ASSERT (pointer_to_uword (p) >= bm->buffer_mem_start);
318 ASSERT (offset < bm->buffer_mem_size);
319 ASSERT ((offset % (1 << CLIB_LOG2_CACHE_LINE_BYTES)) == 0);
320 return offset >> CLIB_LOG2_CACHE_LINE_BYTES;
323 /** \brief Translate array of buffer pointers into buffer indices with offset
325 @param vm - (vlib_main_t *) vlib main data structure pointer
326 @param b - (void **) array of buffer pointers
327 @param bi - (u32 *) array to store buffer indices
328 @param count - (uword) number of elements
329 @param offset - (i32) offset applied to each pointer
331 static_always_inline void
332 vlib_get_buffer_indices_with_offset (vlib_main_t * vm, void **b, u32 * bi,
333 uword count, i32 offset)
335 #ifdef CLIB_HAVE_VEC256
336 u32x8 mask = { 0, 2, 4, 6, 1, 3, 5, 7 };
337 u64x4 off4 = u64x4_splat (vm->buffer_main->buffer_mem_start - offset);
341 /* load 4 pointers into 256-bit register */
342 u64x4 v0 = u64x4_load_unaligned (b);
343 u64x4 v1 = u64x4_load_unaligned (b + 4);
349 v0 >>= CLIB_LOG2_CACHE_LINE_BYTES;
350 v1 >>= CLIB_LOG2_CACHE_LINE_BYTES;
352 /* permute 256-bit register so lower u32s of each buffer index are
353 * placed into lower 128-bits */
354 v2 = u32x8_permute ((u32x8) v0, mask);
355 v3 = u32x8_permute ((u32x8) v1, mask);
357 /* extract lower 128-bits and save them to the array of buffer indices */
358 u32x4_store_unaligned (u32x8_extract_lo (v2), bi);
359 u32x4_store_unaligned (u32x8_extract_lo (v3), bi + 4);
367 /* equivalent non-nector implementation */
368 bi[0] = vlib_get_buffer_index (vm, ((u8 *) b[0]) + offset);
369 bi[1] = vlib_get_buffer_index (vm, ((u8 *) b[1]) + offset);
370 bi[2] = vlib_get_buffer_index (vm, ((u8 *) b[2]) + offset);
371 bi[3] = vlib_get_buffer_index (vm, ((u8 *) b[3]) + offset);
378 bi[0] = vlib_get_buffer_index (vm, ((u8 *) b[0]) + offset);
385 /** \brief Translate array of buffer pointers into buffer indices
387 @param vm - (vlib_main_t *) vlib main data structure pointer
388 @param b - (vlib_buffer_t **) array of buffer pointers
389 @param bi - (u32 *) array to store buffer indices
390 @param count - (uword) number of elements
392 static_always_inline void
393 vlib_get_buffer_indices (vlib_main_t * vm, vlib_buffer_t ** b, u32 * bi,
396 vlib_get_buffer_indices_with_offset (vm, (void **) b, bi, count, 0);
399 /** \brief Get next buffer in buffer linklist, or zero for end of list.
401 @param vm - (vlib_main_t *) vlib main data structure pointer
402 @param b - (void *) buffer pointer
403 @return - (vlib_buffer_t *) next buffer, or NULL
405 always_inline vlib_buffer_t *
406 vlib_get_next_buffer (vlib_main_t * vm, vlib_buffer_t * b)
408 return (b->flags & VLIB_BUFFER_NEXT_PRESENT
409 ? vlib_get_buffer (vm, b->next_buffer) : 0);
412 uword vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
413 vlib_buffer_t * b_first);
415 /** \brief Get length in bytes of the buffer chain
417 @param vm - (vlib_main_t *) vlib main data structure pointer
418 @param b - (void *) buffer pointer
419 @return - (uword) length of buffer chain
422 vlib_buffer_length_in_chain (vlib_main_t * vm, vlib_buffer_t * b)
424 uword len = b->current_length;
426 if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) == 0))
429 if (PREDICT_TRUE (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID))
430 return len + b->total_length_not_including_first_buffer;
432 return vlib_buffer_length_in_chain_slow_path (vm, b);
435 /** \brief Get length in bytes of the buffer index buffer chain
437 @param vm - (vlib_main_t *) vlib main data structure pointer
438 @param bi - (u32) buffer index
439 @return - (uword) length of buffer chain
442 vlib_buffer_index_length_in_chain (vlib_main_t * vm, u32 bi)
444 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
445 return vlib_buffer_length_in_chain (vm, b);
448 /** \brief Copy buffer contents to memory
450 @param vm - (vlib_main_t *) vlib main data structure pointer
451 @param buffer_index - (u32) buffer index
452 @param contents - (u8 *) memory, <strong>must be large enough</strong>
453 @return - (uword) length of buffer chain
456 vlib_buffer_contents (vlib_main_t * vm, u32 buffer_index, u8 * contents)
458 uword content_len = 0;
464 b = vlib_get_buffer (vm, buffer_index);
465 l = b->current_length;
466 clib_memcpy_fast (contents + content_len, b->data + b->current_data, l);
468 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
470 buffer_index = b->next_buffer;
477 vlib_buffer_get_pa (vlib_main_t * vm, vlib_buffer_t * b)
479 return vlib_physmem_get_pa (vm, b->data);
483 vlib_buffer_get_current_pa (vlib_main_t * vm, vlib_buffer_t * b)
485 return vlib_buffer_get_pa (vm, b) + b->current_data;
488 /** \brief Prefetch buffer metadata by buffer index
489 The first 64 bytes of buffer contains most header information
491 @param vm - (vlib_main_t *) vlib main data structure pointer
492 @param bi - (u32) buffer index
493 @param type - LOAD, STORE. In most cases, STORE is the right answer
495 /* Prefetch buffer header given index. */
496 #define vlib_prefetch_buffer_with_index(vm,bi,type) \
498 vlib_buffer_t * _b = vlib_get_buffer (vm, bi); \
499 vlib_prefetch_buffer_header (_b, type); \
504 /* Index is unknown. */
507 /* Index is known and free/allocated. */
508 VLIB_BUFFER_KNOWN_FREE,
509 VLIB_BUFFER_KNOWN_ALLOCATED,
510 } vlib_buffer_known_state_t;
512 void vlib_buffer_validate_alloc_free (vlib_main_t * vm, u32 * buffers,
514 vlib_buffer_known_state_t
517 always_inline vlib_buffer_known_state_t
518 vlib_buffer_is_known (vlib_main_t * vm, u32 buffer_index)
520 vlib_buffer_main_t *bm = vm->buffer_main;
522 clib_spinlock_lock (&bm->buffer_known_hash_lockp);
523 uword *p = hash_get (bm->buffer_known_hash, buffer_index);
524 clib_spinlock_unlock (&bm->buffer_known_hash_lockp);
525 return p ? p[0] : VLIB_BUFFER_UNKNOWN;
528 /* Validates sanity of a single buffer.
529 Returns format'ed vector with error message if any. */
530 u8 *vlib_validate_buffer (vlib_main_t * vm, u32 buffer_index,
533 u8 *vlib_validate_buffers (vlib_main_t * vm,
535 uword next_buffer_stride,
537 vlib_buffer_known_state_t known_state,
538 uword follow_buffer_next);
540 static_always_inline vlib_buffer_pool_t *
541 vlib_get_buffer_pool (vlib_main_t * vm, u8 buffer_pool_index)
543 vlib_buffer_main_t *bm = vm->buffer_main;
544 return vec_elt_at_index (bm->buffer_pools, buffer_pool_index);
547 static_always_inline __clib_warn_unused_result uword
548 vlib_buffer_pool_get (vlib_main_t * vm, u8 buffer_pool_index, u32 * buffers,
551 vlib_buffer_pool_t *bp = vlib_get_buffer_pool (vm, buffer_pool_index);
554 ASSERT (bp->buffers);
556 clib_spinlock_lock (&bp->lock);
558 if (PREDICT_TRUE (n_buffers < len))
561 vlib_buffer_copy_indices (buffers, bp->buffers + len, n_buffers);
563 clib_spinlock_unlock (&bp->lock);
568 vlib_buffer_copy_indices (buffers, bp->buffers, len);
570 clib_spinlock_unlock (&bp->lock);
576 /** \brief Allocate buffers from specific pool into supplied array
578 @param vm - (vlib_main_t *) vlib main data structure pointer
579 @param buffers - (u32 * ) buffer index array
580 @param n_buffers - (u32) number of buffers requested
581 @return - (u32) number of buffers actually allocated, may be
582 less than the number requested or zero
585 always_inline __clib_warn_unused_result u32
586 vlib_buffer_alloc_from_pool (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
587 u8 buffer_pool_index)
589 vlib_buffer_main_t *bm = vm->buffer_main;
590 vlib_buffer_pool_t *bp;
591 vlib_buffer_pool_thread_t *bpt;
592 u32 *src, *dst, len, n_left;
594 /* If buffer allocation fault injection is configured */
595 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR > 0)
597 u32 vlib_buffer_alloc_may_fail (vlib_main_t *, u32);
599 /* See how many buffers we're willing to allocate */
600 n_buffers = vlib_buffer_alloc_may_fail (vm, n_buffers);
605 bp = vec_elt_at_index (bm->buffer_pools, buffer_pool_index);
606 bpt = vec_elt_at_index (bp->threads, vm->thread_index);
612 /* per-thread cache contains enough buffers */
613 if (len >= n_buffers)
615 src = bpt->cached_buffers + len - n_buffers;
616 vlib_buffer_copy_indices (dst, src, n_buffers);
617 bpt->n_cached -= n_buffers;
620 vlib_buffer_validate_alloc_free (vm, buffers, n_buffers,
621 VLIB_BUFFER_KNOWN_FREE);
625 /* alloc bigger than cache - take buffers directly from main pool */
626 if (n_buffers >= VLIB_BUFFER_POOL_PER_THREAD_CACHE_SZ)
628 n_buffers = vlib_buffer_pool_get (vm, buffer_pool_index, buffers,
632 vlib_buffer_validate_alloc_free (vm, buffers, n_buffers,
633 VLIB_BUFFER_KNOWN_FREE);
637 /* take everything available in the cache */
640 vlib_buffer_copy_indices (dst, bpt->cached_buffers, len);
646 len = round_pow2 (n_left, 32);
647 len = vlib_buffer_pool_get (vm, buffer_pool_index, bpt->cached_buffers,
653 u32 n_copy = clib_min (len, n_left);
654 src = bpt->cached_buffers + len - n_copy;
655 vlib_buffer_copy_indices (dst, src, n_copy);
656 bpt->n_cached -= n_copy;
662 /* Verify that buffers are known free. */
664 vlib_buffer_validate_alloc_free (vm, buffers, n_buffers,
665 VLIB_BUFFER_KNOWN_FREE);
670 /** \brief Allocate buffers from specific numa node into supplied array
672 @param vm - (vlib_main_t *) vlib main data structure pointer
673 @param buffers - (u32 * ) buffer index array
674 @param n_buffers - (u32) number of buffers requested
675 @param numa_node - (u32) numa node
676 @return - (u32) number of buffers actually allocated, may be
677 less than the number requested or zero
679 always_inline __clib_warn_unused_result u32
680 vlib_buffer_alloc_on_numa (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
683 u8 index = vlib_buffer_pool_get_default_for_numa (vm, numa_node);
684 return vlib_buffer_alloc_from_pool (vm, buffers, n_buffers, index);
687 /** \brief Allocate buffers into supplied array
689 @param vm - (vlib_main_t *) vlib main data structure pointer
690 @param buffers - (u32 * ) buffer index array
691 @param n_buffers - (u32) number of buffers requested
692 @return - (u32) number of buffers actually allocated, may be
693 less than the number requested or zero
696 always_inline __clib_warn_unused_result u32
697 vlib_buffer_alloc (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
699 return vlib_buffer_alloc_on_numa (vm, buffers, n_buffers, vm->numa_node);
702 /** \brief Allocate buffers into ring
704 @param vm - (vlib_main_t *) vlib main data structure pointer
705 @param buffers - (u32 * ) buffer index ring
706 @param start - (u32) first slot in the ring
707 @param ring_size - (u32) ring size
708 @param n_buffers - (u32) number of buffers requested
709 @return - (u32) number of buffers actually allocated, may be
710 less than the number requested or zero
712 always_inline __clib_warn_unused_result u32
713 vlib_buffer_alloc_to_ring (vlib_main_t * vm, u32 * ring, u32 start,
714 u32 ring_size, u32 n_buffers)
718 ASSERT (n_buffers <= ring_size);
720 if (PREDICT_TRUE (start + n_buffers <= ring_size))
721 return vlib_buffer_alloc (vm, ring + start, n_buffers);
723 n_alloc = vlib_buffer_alloc (vm, ring + start, ring_size - start);
725 if (PREDICT_TRUE (n_alloc == ring_size - start))
726 n_alloc += vlib_buffer_alloc (vm, ring, n_buffers - n_alloc);
731 /** \brief Allocate buffers into ring from specific buffer pool
733 @param vm - (vlib_main_t *) vlib main data structure pointer
734 @param buffers - (u32 * ) buffer index ring
735 @param start - (u32) first slot in the ring
736 @param ring_size - (u32) ring size
737 @param n_buffers - (u32) number of buffers requested
738 @return - (u32) number of buffers actually allocated, may be
739 less than the number requested or zero
741 always_inline __clib_warn_unused_result u32
742 vlib_buffer_alloc_to_ring_from_pool (vlib_main_t * vm, u32 * ring, u32 start,
743 u32 ring_size, u32 n_buffers,
744 u8 buffer_pool_index)
748 ASSERT (n_buffers <= ring_size);
750 if (PREDICT_TRUE (start + n_buffers <= ring_size))
751 return vlib_buffer_alloc_from_pool (vm, ring + start, n_buffers,
754 n_alloc = vlib_buffer_alloc_from_pool (vm, ring + start, ring_size - start,
757 if (PREDICT_TRUE (n_alloc == ring_size - start))
758 n_alloc += vlib_buffer_alloc_from_pool (vm, ring, n_buffers - n_alloc,
764 static_always_inline void
765 vlib_buffer_pool_put (vlib_main_t * vm, u8 buffer_pool_index,
766 u32 * buffers, u32 n_buffers)
768 vlib_buffer_pool_t *bp = vlib_get_buffer_pool (vm, buffer_pool_index);
769 vlib_buffer_pool_thread_t *bpt = vec_elt_at_index (bp->threads,
771 u32 n_cached, n_empty;
774 vlib_buffer_validate_alloc_free (vm, buffers, n_buffers,
775 VLIB_BUFFER_KNOWN_ALLOCATED);
777 n_cached = bpt->n_cached;
778 n_empty = VLIB_BUFFER_POOL_PER_THREAD_CACHE_SZ - n_cached;
779 if (n_buffers <= n_empty)
781 vlib_buffer_copy_indices (bpt->cached_buffers + n_cached,
783 bpt->n_cached = n_cached + n_buffers;
787 vlib_buffer_copy_indices (bpt->cached_buffers + n_cached,
788 buffers + n_buffers - n_empty, n_empty);
789 bpt->n_cached = VLIB_BUFFER_POOL_PER_THREAD_CACHE_SZ;
791 clib_spinlock_lock (&bp->lock);
792 vlib_buffer_copy_indices (bp->buffers + bp->n_avail, buffers,
793 n_buffers - n_empty);
794 bp->n_avail += n_buffers - n_empty;
795 clib_spinlock_unlock (&bp->lock);
798 static_always_inline void
799 vlib_buffer_free_inline (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
802 const int queue_size = 128;
803 vlib_buffer_pool_t *bp = 0;
804 u8 buffer_pool_index = ~0;
805 u32 n_queue = 0, queue[queue_size + 4];
806 vlib_buffer_t bt = { };
807 #if defined(CLIB_HAVE_VEC128)
808 vlib_buffer_t bpi_mask = {.buffer_pool_index = ~0 };
809 vlib_buffer_t bpi_vec = {};
810 vlib_buffer_t flags_refs_mask = {
811 .flags = VLIB_BUFFER_NEXT_PRESENT,
816 if (PREDICT_FALSE (n_buffers == 0))
819 vlib_buffer_t *b = vlib_get_buffer (vm, buffers[0]);
820 buffer_pool_index = b->buffer_pool_index;
821 bp = vlib_get_buffer_pool (vm, buffer_pool_index);
822 vlib_buffer_copy_template (&bt, &bp->buffer_template);
823 #if defined(CLIB_HAVE_VEC128)
824 bpi_vec.buffer_pool_index = buffer_pool_index;
830 u32 bi, sum = 0, flags, next;
835 vlib_get_buffers (vm, buffers, b, 4);
839 vlib_get_buffers (vm, buffers + 8, b + 4, 4);
840 vlib_prefetch_buffer_header (b[4], LOAD);
841 vlib_prefetch_buffer_header (b[5], LOAD);
842 vlib_prefetch_buffer_header (b[6], LOAD);
843 vlib_prefetch_buffer_header (b[7], LOAD);
846 #if defined(CLIB_HAVE_VEC128)
847 u8x16 p0, p1, p2, p3, r;
848 p0 = u8x16_load_unaligned (b[0]);
849 p1 = u8x16_load_unaligned (b[1]);
850 p2 = u8x16_load_unaligned (b[2]);
851 p3 = u8x16_load_unaligned (b[3]);
853 r = p0 ^ bpi_vec.as_u8x16[0];
854 r |= p1 ^ bpi_vec.as_u8x16[0];
855 r |= p2 ^ bpi_vec.as_u8x16[0];
856 r |= p3 ^ bpi_vec.as_u8x16[0];
857 r &= bpi_mask.as_u8x16[0];
858 r |= (p0 | p1 | p2 | p3) & flags_refs_mask.as_u8x16[0];
860 sum = !u8x16_is_all_zero (r);
866 sum &= VLIB_BUFFER_NEXT_PRESENT;
867 sum += b[0]->ref_count - 1;
868 sum += b[1]->ref_count - 1;
869 sum += b[2]->ref_count - 1;
870 sum += b[3]->ref_count - 1;
871 sum |= b[0]->buffer_pool_index ^ buffer_pool_index;
872 sum |= b[1]->buffer_pool_index ^ buffer_pool_index;
873 sum |= b[2]->buffer_pool_index ^ buffer_pool_index;
874 sum |= b[3]->buffer_pool_index ^ buffer_pool_index;
880 vlib_buffer_copy_indices (queue + n_queue, buffers, 4);
881 vlib_buffer_copy_template (b[0], &bt);
882 vlib_buffer_copy_template (b[1], &bt);
883 vlib_buffer_copy_template (b[2], &bt);
884 vlib_buffer_copy_template (b[3], &bt);
887 vlib_buffer_validate (vm, b[0]);
888 vlib_buffer_validate (vm, b[1]);
889 vlib_buffer_validate (vm, b[2]);
890 vlib_buffer_validate (vm, b[3]);
892 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
893 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[1]);
894 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[2]);
895 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[3]);
897 if (n_queue >= queue_size)
899 vlib_buffer_pool_put (vm, buffer_pool_index, queue, n_queue);
910 b[0] = vlib_get_buffer (vm, bi);
912 next = b[0]->next_buffer;
914 if (PREDICT_FALSE (buffer_pool_index != b[0]->buffer_pool_index))
919 vlib_buffer_pool_put (vm, buffer_pool_index, queue, n_queue);
923 buffer_pool_index = b[0]->buffer_pool_index;
924 #if defined(CLIB_HAVE_VEC128)
925 bpi_vec.buffer_pool_index = buffer_pool_index;
927 bp = vlib_get_buffer_pool (vm, buffer_pool_index);
928 vlib_buffer_copy_template (&bt, &bp->buffer_template);
931 vlib_buffer_validate (vm, b[0]);
933 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
935 if (clib_atomic_sub_fetch (&b[0]->ref_count, 1) == 0)
937 vlib_buffer_copy_template (b[0], &bt);
938 queue[n_queue++] = bi;
941 if (n_queue == queue_size)
943 vlib_buffer_pool_put (vm, buffer_pool_index, queue, queue_size);
947 if (maybe_next && (flags & VLIB_BUFFER_NEXT_PRESENT))
958 vlib_buffer_pool_put (vm, buffer_pool_index, queue, n_queue);
962 /** \brief Free buffers
963 Frees the entire buffer chain for each buffer
965 @param vm - (vlib_main_t *) vlib main data structure pointer
966 @param buffers - (u32 * ) buffer index array
967 @param n_buffers - (u32) number of buffers to free
971 vlib_buffer_free (vlib_main_t * vm,
972 /* pointer to first buffer */
974 /* number of buffers to free */
977 vlib_buffer_free_inline (vm, buffers, n_buffers, /* maybe next */ 1);
980 /** \brief Free buffers, does not free the buffer chain for each buffer
982 @param vm - (vlib_main_t *) vlib main data structure pointer
983 @param buffers - (u32 * ) buffer index array
984 @param n_buffers - (u32) number of buffers to free
988 vlib_buffer_free_no_next (vlib_main_t * vm,
989 /* pointer to first buffer */
991 /* number of buffers to free */
994 vlib_buffer_free_inline (vm, buffers, n_buffers, /* maybe next */ 0);
997 /** \brief Free one buffer
998 Shorthand to free a single buffer chain.
1000 @param vm - (vlib_main_t *) vlib main data structure pointer
1001 @param buffer_index - (u32) buffer index to free
1004 vlib_buffer_free_one (vlib_main_t * vm, u32 buffer_index)
1006 vlib_buffer_free_inline (vm, &buffer_index, 1, /* maybe next */ 1);
1009 /** \brief Free buffers from ring
1011 @param vm - (vlib_main_t *) vlib main data structure pointer
1012 @param buffers - (u32 * ) buffer index ring
1013 @param start - (u32) first slot in the ring
1014 @param ring_size - (u32) ring size
1015 @param n_buffers - (u32) number of buffers
1018 vlib_buffer_free_from_ring (vlib_main_t * vm, u32 * ring, u32 start,
1019 u32 ring_size, u32 n_buffers)
1021 ASSERT (n_buffers <= ring_size);
1023 if (PREDICT_TRUE (start + n_buffers <= ring_size))
1025 vlib_buffer_free (vm, ring + start, n_buffers);
1029 vlib_buffer_free (vm, ring + start, ring_size - start);
1030 vlib_buffer_free (vm, ring, n_buffers - (ring_size - start));
1034 /** \brief Free buffers from ring without freeing tail buffers
1036 @param vm - (vlib_main_t *) vlib main data structure pointer
1037 @param buffers - (u32 * ) buffer index ring
1038 @param start - (u32) first slot in the ring
1039 @param ring_size - (u32) ring size
1040 @param n_buffers - (u32) number of buffers
1043 vlib_buffer_free_from_ring_no_next (vlib_main_t * vm, u32 * ring, u32 start,
1044 u32 ring_size, u32 n_buffers)
1046 ASSERT (n_buffers <= ring_size);
1048 if (PREDICT_TRUE (start + n_buffers <= ring_size))
1050 vlib_buffer_free_no_next (vm, ring + start, n_buffers);
1054 vlib_buffer_free_no_next (vm, ring + start, ring_size - start);
1055 vlib_buffer_free_no_next (vm, ring, n_buffers - (ring_size - start));
1059 /* Append given data to end of buffer, possibly allocating new buffers. */
1060 int vlib_buffer_add_data (vlib_main_t * vm, u32 * buffer_index, void *data,
1063 /* Define vlib_buffer and vnet_buffer flags bits preserved for copy/clone */
1064 #define VLIB_BUFFER_COPY_CLONE_FLAGS_MASK \
1065 (VLIB_BUFFER_NEXT_PRESENT | VLIB_BUFFER_TOTAL_LENGTH_VALID | \
1066 VLIB_BUFFER_IS_TRACED | ~VLIB_BUFFER_FLAGS_ALL)
1068 /* duplicate all buffers in chain */
1069 always_inline vlib_buffer_t *
1070 vlib_buffer_copy (vlib_main_t * vm, vlib_buffer_t * b)
1072 vlib_buffer_t *s, *d, *fd;
1073 uword n_alloc, n_buffers = 1;
1074 u32 flag_mask = VLIB_BUFFER_COPY_CLONE_FLAGS_MASK;
1078 while (s->flags & VLIB_BUFFER_NEXT_PRESENT)
1081 s = vlib_get_buffer (vm, s->next_buffer);
1083 u32 new_buffers[n_buffers];
1085 n_alloc = vlib_buffer_alloc (vm, new_buffers, n_buffers);
1087 /* No guarantee that we'll get all the buffers we asked for */
1088 if (PREDICT_FALSE (n_alloc < n_buffers))
1091 vlib_buffer_free (vm, new_buffers, n_alloc);
1097 fd = d = vlib_get_buffer (vm, new_buffers[0]);
1098 d->current_data = s->current_data;
1099 d->current_length = s->current_length;
1100 d->flags = s->flags & flag_mask;
1101 d->trace_handle = s->trace_handle;
1102 d->total_length_not_including_first_buffer =
1103 s->total_length_not_including_first_buffer;
1104 clib_memcpy_fast (d->opaque, s->opaque, sizeof (s->opaque));
1105 clib_memcpy_fast (d->opaque2, s->opaque2, sizeof (s->opaque2));
1106 clib_memcpy_fast (vlib_buffer_get_current (d),
1107 vlib_buffer_get_current (s), s->current_length);
1110 for (i = 1; i < n_buffers; i++)
1113 d->next_buffer = new_buffers[i];
1115 s = vlib_get_buffer (vm, s->next_buffer);
1116 d = vlib_get_buffer (vm, new_buffers[i]);
1117 d->current_data = s->current_data;
1118 d->current_length = s->current_length;
1119 clib_memcpy_fast (vlib_buffer_get_current (d),
1120 vlib_buffer_get_current (s), s->current_length);
1121 d->flags = s->flags & flag_mask;
1127 /* duplicate first buffer in chain */
1128 always_inline vlib_buffer_t *
1129 vlib_buffer_copy_no_chain (vlib_main_t * vm, vlib_buffer_t * b, u32 * di)
1133 if ((vlib_buffer_alloc (vm, di, 1)) != 1)
1136 d = vlib_get_buffer (vm, *di);
1138 d->current_data = b->current_data;
1139 d->current_length = b->current_length;
1140 clib_memcpy_fast (d->opaque, b->opaque, sizeof (b->opaque));
1141 clib_memcpy_fast (d->opaque2, b->opaque2, sizeof (b->opaque2));
1142 clib_memcpy_fast (vlib_buffer_get_current (d),
1143 vlib_buffer_get_current (b), b->current_length);
1148 /* \brief Move packet from current position to offset position in buffer.
1149 Only work for small packet using one buffer with room to fit the move
1150 @param vm - (vlib_main_t *) vlib main data structure pointer
1151 @param b - (vlib_buffer_t *) pointer to buffer
1152 @param offset - (i16) position to move the packet in buffer
1155 vlib_buffer_move (vlib_main_t * vm, vlib_buffer_t * b, i16 offset)
1157 ASSERT ((b->flags & VLIB_BUFFER_NEXT_PRESENT) == 0);
1158 ASSERT (offset + VLIB_BUFFER_PRE_DATA_SIZE >= 0);
1159 ASSERT (offset + b->current_length <
1160 vlib_buffer_get_default_data_size (vm));
1162 u8 *source = vlib_buffer_get_current (b);
1163 b->current_data = offset;
1164 u8 *destination = vlib_buffer_get_current (b);
1165 u16 length = b->current_length;
1167 if (source + length <= destination) /* no overlap */
1168 clib_memcpy_fast (destination, source, length);
1170 memmove (destination, source, length);
1173 /** \brief Create a maximum of 256 clones of buffer and store them
1174 in the supplied array
1176 @param vm - (vlib_main_t *) vlib main data structure pointer
1177 @param src_buffer - (u32) source buffer index
1178 @param buffers - (u32 * ) buffer index array
1179 @param n_buffers - (u16) number of buffer clones requested (<=256)
1180 @param head_end_offset - (u16) offset relative to current position
1181 where packet head ends
1182 @param offset - (i16) copy packet head at current position if 0,
1183 else at offset position to change headroom space as specified
1184 @return - (u16) number of buffers actually cloned, may be
1185 less than the number requested or zero
1188 vlib_buffer_clone_256 (vlib_main_t * vm, u32 src_buffer, u32 * buffers,
1189 u16 n_buffers, u16 head_end_offset, i16 offset)
1192 vlib_buffer_t *s = vlib_get_buffer (vm, src_buffer);
1194 ASSERT (s->ref_count == 1);
1196 ASSERT (n_buffers <= 256);
1197 ASSERT (offset + VLIB_BUFFER_PRE_DATA_SIZE >= 0);
1198 ASSERT ((offset + head_end_offset) <
1199 vlib_buffer_get_default_data_size (vm));
1201 if (s->current_length <= head_end_offset + CLIB_CACHE_LINE_BYTES * 2)
1203 buffers[0] = src_buffer;
1205 vlib_buffer_move (vm, s, offset);
1207 for (i = 1; i < n_buffers; i++)
1210 d = vlib_buffer_copy (vm, s);
1213 buffers[i] = vlib_get_buffer_index (vm, d);
1219 if (PREDICT_FALSE ((n_buffers == 1) && (offset == 0)))
1221 buffers[0] = src_buffer;
1225 n_buffers = vlib_buffer_alloc_from_pool (vm, buffers, n_buffers,
1226 s->buffer_pool_index);
1228 for (i = 0; i < n_buffers; i++)
1230 vlib_buffer_t *d = vlib_get_buffer (vm, buffers[i]);
1232 d->current_data = offset;
1234 d->current_data = s->current_data;
1236 d->current_length = head_end_offset;
1237 ASSERT (d->buffer_pool_index == s->buffer_pool_index);
1239 d->total_length_not_including_first_buffer = s->current_length -
1241 if (PREDICT_FALSE (s->flags & VLIB_BUFFER_NEXT_PRESENT))
1243 d->total_length_not_including_first_buffer +=
1244 s->total_length_not_including_first_buffer;
1246 d->flags = (s->flags & VLIB_BUFFER_COPY_CLONE_FLAGS_MASK) |
1247 VLIB_BUFFER_NEXT_PRESENT;
1248 d->trace_handle = s->trace_handle;
1249 clib_memcpy_fast (d->opaque, s->opaque, sizeof (s->opaque));
1250 clib_memcpy_fast (d->opaque2, s->opaque2, sizeof (s->opaque2));
1251 clib_memcpy_fast (vlib_buffer_get_current (d),
1252 vlib_buffer_get_current (s), head_end_offset);
1253 d->next_buffer = src_buffer;
1255 vlib_buffer_advance (s, head_end_offset);
1256 s->ref_count = n_buffers ? n_buffers : s->ref_count;
1257 while (s->flags & VLIB_BUFFER_NEXT_PRESENT)
1259 s = vlib_get_buffer (vm, s->next_buffer);
1260 s->ref_count = n_buffers ? n_buffers : s->ref_count;
1266 /** \brief Create multiple clones of buffer and store them
1267 in the supplied array
1269 @param vm - (vlib_main_t *) vlib main data structure pointer
1270 @param src_buffer - (u32) source buffer index
1271 @param buffers - (u32 * ) buffer index array
1272 @param n_buffers - (u16) number of buffer clones requested (<=256)
1273 @param head_end_offset - (u16) offset relative to current position
1274 where packet head ends
1275 @param offset - (i16) copy packet head at current position if 0,
1276 else at offset position to change headroom space as specified
1277 @return - (u16) number of buffers actually cloned, may be
1278 less than the number requested or zero
1281 vlib_buffer_clone_at_offset (vlib_main_t * vm, u32 src_buffer, u32 * buffers,
1282 u16 n_buffers, u16 head_end_offset, i16 offset)
1284 vlib_buffer_t *s = vlib_get_buffer (vm, src_buffer);
1287 while (n_buffers > 256)
1289 vlib_buffer_t *copy;
1290 copy = vlib_buffer_copy (vm, s);
1291 n_cloned += vlib_buffer_clone_256 (vm,
1292 vlib_get_buffer_index (vm, copy),
1293 (buffers + n_cloned),
1294 256, head_end_offset, offset);
1297 n_cloned += vlib_buffer_clone_256 (vm, src_buffer,
1299 n_buffers, head_end_offset, offset);
1304 /** \brief Create multiple clones of buffer and store them
1305 in the supplied array
1307 @param vm - (vlib_main_t *) vlib main data structure pointer
1308 @param src_buffer - (u32) source buffer index
1309 @param buffers - (u32 * ) buffer index array
1310 @param n_buffers - (u16) number of buffer clones requested (<=256)
1311 @param head_end_offset - (u16) offset relative to current position
1312 where packet head ends
1313 @return - (u16) number of buffers actually cloned, may be
1314 less than the number requested or zero
1317 vlib_buffer_clone (vlib_main_t * vm, u32 src_buffer, u32 * buffers,
1318 u16 n_buffers, u16 head_end_offset)
1320 return vlib_buffer_clone_at_offset (vm, src_buffer, buffers, n_buffers,
1321 head_end_offset, 0);
1324 /** \brief Attach cloned tail to the buffer
1326 @param vm - (vlib_main_t *) vlib main data structure pointer
1327 @param head - (vlib_buffer_t *) head buffer
1328 @param tail - (Vlib buffer_t *) tail buffer to clone and attach to head
1332 vlib_buffer_attach_clone (vlib_main_t * vm, vlib_buffer_t * head,
1333 vlib_buffer_t * tail)
1335 ASSERT ((head->flags & VLIB_BUFFER_NEXT_PRESENT) == 0);
1336 ASSERT (head->buffer_pool_index == tail->buffer_pool_index);
1338 head->flags |= VLIB_BUFFER_NEXT_PRESENT;
1339 head->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
1340 head->flags &= ~VLIB_BUFFER_EXT_HDR_VALID;
1341 head->flags |= (tail->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID);
1342 head->next_buffer = vlib_get_buffer_index (vm, tail);
1343 head->total_length_not_including_first_buffer = tail->current_length +
1344 tail->total_length_not_including_first_buffer;
1347 clib_atomic_add_fetch (&tail->ref_count, 1);
1349 if (tail->flags & VLIB_BUFFER_NEXT_PRESENT)
1351 tail = vlib_get_buffer (vm, tail->next_buffer);
1356 /* Initializes the buffer as an empty packet with no chained buffers. */
1358 vlib_buffer_chain_init (vlib_buffer_t * first)
1360 first->total_length_not_including_first_buffer = 0;
1361 first->current_length = 0;
1362 first->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
1363 first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
1366 /* The provided next_bi buffer index is appended to the end of the packet. */
1367 always_inline vlib_buffer_t *
1368 vlib_buffer_chain_buffer (vlib_main_t * vm, vlib_buffer_t * last, u32 next_bi)
1370 vlib_buffer_t *next_buffer = vlib_get_buffer (vm, next_bi);
1371 last->next_buffer = next_bi;
1372 last->flags |= VLIB_BUFFER_NEXT_PRESENT;
1373 next_buffer->current_length = 0;
1374 next_buffer->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
1378 /* Increases or decreases the packet length.
1379 * It does not allocate or deallocate new buffers.
1380 * Therefore, the added length must be compatible
1381 * with the last buffer. */
1383 vlib_buffer_chain_increase_length (vlib_buffer_t * first,
1384 vlib_buffer_t * last, i32 len)
1386 last->current_length += len;
1388 first->total_length_not_including_first_buffer += len;
1391 /* Copy data to the end of the packet and increases its length.
1392 * It does not allocate new buffers.
1393 * Returns the number of copied bytes. */
1395 vlib_buffer_chain_append_data (vlib_main_t * vm,
1396 vlib_buffer_t * first,
1397 vlib_buffer_t * last, void *data, u16 data_len)
1399 u32 n_buffer_bytes = vlib_buffer_get_default_data_size (vm);
1400 ASSERT (n_buffer_bytes >= last->current_length + last->current_data);
1401 u16 len = clib_min (data_len,
1402 n_buffer_bytes - last->current_length -
1403 last->current_data);
1404 clib_memcpy_fast (vlib_buffer_get_current (last) + last->current_length,
1406 vlib_buffer_chain_increase_length (first, last, len);
1410 /* Copy data to the end of the packet and increases its length.
1411 * Allocates additional buffers from the free list if necessary.
1412 * Returns the number of copied bytes.
1413 * 'last' value is modified whenever new buffers are allocated and
1414 * chained and points to the last buffer in the chain. */
1416 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
1417 vlib_buffer_t * first,
1418 vlib_buffer_t ** last, void *data,
1420 void vlib_buffer_chain_validate (vlib_main_t * vm, vlib_buffer_t * first);
1422 format_function_t format_vlib_buffer, format_vlib_buffer_and_data,
1423 format_vlib_buffer_contents, format_vlib_buffer_no_chain;
1427 /* Vector of packet data. */
1430 /* Number of buffers to allocate in each call to allocator. */
1431 u32 min_n_buffers_each_alloc;
1434 } vlib_packet_template_t;
1436 void vlib_packet_template_init (vlib_main_t * vm,
1437 vlib_packet_template_t * t,
1439 uword n_packet_data_bytes,
1440 uword min_n_buffers_each_alloc,
1443 void *vlib_packet_template_get_packet (vlib_main_t * vm,
1444 vlib_packet_template_t * t,
1448 vlib_packet_template_free (vlib_main_t * vm, vlib_packet_template_t * t)
1450 vec_free (t->packet_data);
1454 vlib_buffer_space_left_at_end (vlib_main_t * vm, vlib_buffer_t * b)
1456 return b->data + vlib_buffer_get_default_data_size (vm) -
1457 ((u8 *) vlib_buffer_get_current (b) + b->current_length);
1461 vlib_buffer_chain_linearize (vlib_main_t * vm, vlib_buffer_t * b)
1463 vlib_buffer_t *db = b, *sb, *first = b;
1465 u32 bytes_left = 0, data_size;
1466 u16 src_left, dst_left, n_buffers = 1;
1470 if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) == 0))
1473 data_size = vlib_buffer_get_default_data_size (vm);
1475 dst_left = vlib_buffer_space_left_at_end (vm, b);
1477 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1479 b = vlib_get_buffer (vm, b->next_buffer);
1480 if (b->ref_count > 1)
1482 bytes_left += b->current_length;
1486 /* if buffer is cloned, create completely new chain - unless everything fits
1487 * into one buffer */
1488 if (is_cloned && bytes_left >= dst_left)
1491 u32 space_needed = bytes_left - dst_left;
1494 if (vlib_buffer_alloc (vm, &tail, 1) == 0)
1499 b = vlib_get_buffer (vm, tail);
1501 while (len < space_needed)
1504 if (vlib_buffer_alloc (vm, &bi, 1) == 0)
1506 vlib_buffer_free_one (vm, tail);
1509 b->flags = VLIB_BUFFER_NEXT_PRESENT;
1510 b->next_buffer = bi;
1511 b = vlib_get_buffer (vm, bi);
1515 sb = vlib_get_buffer (vm, first->next_buffer);
1516 to_free = first->next_buffer;
1517 first->next_buffer = tail;
1520 sb = vlib_get_buffer (vm, first->next_buffer);
1522 src_left = sb->current_length;
1523 sp = vlib_buffer_get_current (sb);
1524 dp = vlib_buffer_get_tail (db);
1532 db->current_length = dp - (u8 *) vlib_buffer_get_current (db);
1533 ASSERT (db->flags & VLIB_BUFFER_NEXT_PRESENT);
1534 db = vlib_get_buffer (vm, db->next_buffer);
1535 dst_left = data_size;
1536 if (db->current_data > 0)
1538 db->current_data = 0;
1542 dst_left += -db->current_data;
1544 dp = vlib_buffer_get_current (db);
1547 while (src_left == 0)
1549 ASSERT (sb->flags & VLIB_BUFFER_NEXT_PRESENT);
1550 sb = vlib_get_buffer (vm, sb->next_buffer);
1551 src_left = sb->current_length;
1552 sp = vlib_buffer_get_current (sb);
1555 bytes_to_copy = clib_min (dst_left, src_left);
1560 bytes_to_copy = clib_min (bytes_to_copy, sp - dp);
1562 clib_memcpy_fast (dp, sp, bytes_to_copy);
1565 src_left -= bytes_to_copy;
1566 dst_left -= bytes_to_copy;
1567 dp += bytes_to_copy;
1568 sp += bytes_to_copy;
1569 bytes_left -= bytes_to_copy;
1572 db->current_data = 0;
1573 db->current_length = dp - (u8 *) vlib_buffer_get_current (db);
1575 if (is_cloned && to_free)
1576 vlib_buffer_free_one (vm, to_free);
1579 if (db->flags & VLIB_BUFFER_NEXT_PRESENT)
1580 vlib_buffer_free_one (vm, db->next_buffer);
1581 db->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
1584 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1586 b = vlib_get_buffer (vm, b->next_buffer);
1591 first->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
1596 #endif /* included_vlib_buffer_funcs_h */
1599 * fd.io coding-style-patch-verification: ON
1602 * eval: (c-set-style "gnu")