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);
66 typedef u32 (vlib_frame_queue_dequeue_fn_t) (vlib_main_t *vm,
67 vlib_frame_queue_main_t *fqm);
71 vlib_buffer_enqueue_to_next_fn_t *buffer_enqueue_to_next_fn;
72 vlib_buffer_enqueue_to_single_next_fn_t *buffer_enqueue_to_single_next_fn;
73 vlib_buffer_enqueue_to_thread_fn_t *buffer_enqueue_to_thread_fn;
74 vlib_frame_queue_dequeue_fn_t *frame_queue_dequeue_fn;
75 } vlib_buffer_func_main_t;
77 extern vlib_buffer_func_main_t vlib_buffer_func_main;
80 vlib_buffer_validate (vlib_main_t * vm, vlib_buffer_t * b)
82 vlib_buffer_main_t *bm = vm->buffer_main;
83 vlib_buffer_pool_t *bp;
85 /* reference count in allocated buffer always must be 1 or higher */
86 ASSERT (b->ref_count > 0);
88 /* verify that buffer pool index is valid */
89 bp = vec_elt_at_index (bm->buffer_pools, b->buffer_pool_index);
90 ASSERT (pointer_to_uword (b) >= bp->start);
91 ASSERT (pointer_to_uword (b) < bp->start + bp->size -
92 (bp->data_size + sizeof (vlib_buffer_t)));
96 vlib_buffer_ptr_from_index (uword buffer_mem_start, u32 buffer_index,
99 offset += ((uword) buffer_index) << CLIB_LOG2_CACHE_LINE_BYTES;
100 return uword_to_pointer (buffer_mem_start + offset, vlib_buffer_t *);
103 /** \brief Translate buffer index into buffer pointer
105 @param vm - (vlib_main_t *) vlib main data structure pointer
106 @param buffer_index - (u32) buffer index
107 @return - (vlib_buffer_t *) buffer pointer
109 always_inline vlib_buffer_t *
110 vlib_get_buffer (vlib_main_t * vm, u32 buffer_index)
112 vlib_buffer_main_t *bm = vm->buffer_main;
115 b = vlib_buffer_ptr_from_index (bm->buffer_mem_start, buffer_index, 0);
116 vlib_buffer_validate (vm, b);
120 static_always_inline u32
121 vlib_buffer_get_default_data_size (vlib_main_t * vm)
123 return vm->buffer_main->default_data_size;
126 static_always_inline void
127 vlib_buffer_copy_indices (u32 * dst, u32 * src, u32 n_indices)
129 clib_memcpy_u32 (dst, src, n_indices);
133 vlib_buffer_copy_indices_from_ring (u32 * dst, u32 * ring, u32 start,
134 u32 ring_size, u32 n_buffers)
136 ASSERT (n_buffers <= ring_size);
138 if (PREDICT_TRUE (start + n_buffers <= ring_size))
140 vlib_buffer_copy_indices (dst, ring + start, n_buffers);
144 u32 n = ring_size - start;
145 vlib_buffer_copy_indices (dst, ring + start, n);
146 vlib_buffer_copy_indices (dst + n, ring, n_buffers - n);
151 vlib_buffer_copy_indices_to_ring (u32 * ring, u32 * src, u32 start,
152 u32 ring_size, u32 n_buffers)
154 ASSERT (n_buffers <= ring_size);
156 if (PREDICT_TRUE (start + n_buffers <= ring_size))
158 vlib_buffer_copy_indices (ring + start, src, n_buffers);
162 u32 n = ring_size - start;
163 vlib_buffer_copy_indices (ring + start, src, n);
164 vlib_buffer_copy_indices (ring, src + n, n_buffers - n);
168 STATIC_ASSERT_OFFSET_OF (vlib_buffer_t, template_end, 64);
169 static_always_inline void
170 vlib_buffer_copy_template (vlib_buffer_t * b, vlib_buffer_t * bt)
172 #if defined CLIB_HAVE_VEC512
173 b->as_u8x64[0] = bt->as_u8x64[0];
174 #elif defined (CLIB_HAVE_VEC256)
175 b->as_u8x32[0] = bt->as_u8x32[0];
176 b->as_u8x32[1] = bt->as_u8x32[1];
177 #elif defined (CLIB_HAVE_VEC128)
178 b->as_u8x16[0] = bt->as_u8x16[0];
179 b->as_u8x16[1] = bt->as_u8x16[1];
180 b->as_u8x16[2] = bt->as_u8x16[2];
181 b->as_u8x16[3] = bt->as_u8x16[3];
183 clib_memcpy_fast (b, bt, 64);
188 vlib_buffer_pool_get_default_for_numa (vlib_main_t * vm, u32 numa_node)
190 ASSERT (numa_node < VLIB_BUFFER_MAX_NUMA_NODES);
191 return vm->buffer_main->default_buffer_pool_index_for_numa[numa_node];
194 /** \brief Translate array of buffer indices into buffer pointers with offset
196 @param vm - (vlib_main_t *) vlib main data structure pointer
197 @param bi - (u32 *) array of buffer indices
198 @param b - (void **) array to store buffer pointers
199 @param count - (uword) number of elements
200 @param offset - (i32) offset applied to each pointer
202 static_always_inline void
203 vlib_get_buffers_with_offset (vlib_main_t * vm, u32 * bi, void **b, int count,
206 uword buffer_mem_start = vm->buffer_main->buffer_mem_start;
207 #ifdef CLIB_HAVE_VEC512
208 u64x8 of8 = u64x8_splat (buffer_mem_start + offset);
209 u64x4 off = u64x8_extract_lo (of8);
210 /* if count is not const, compiler will not unroll while loop
211 se we maintain two-in-parallel variant */
214 u64x8 b0 = u64x8_from_u32x8 (u32x8_load_unaligned (bi));
215 u64x8 b1 = u64x8_from_u32x8 (u32x8_load_unaligned (bi + 8));
216 u64x8 b2 = u64x8_from_u32x8 (u32x8_load_unaligned (bi + 16));
217 u64x8 b3 = u64x8_from_u32x8 (u32x8_load_unaligned (bi + 24));
218 /* shift and add to get vlib_buffer_t pointer */
219 u64x8_store_unaligned ((b0 << CLIB_LOG2_CACHE_LINE_BYTES) + of8, b);
220 u64x8_store_unaligned ((b1 << CLIB_LOG2_CACHE_LINE_BYTES) + of8, b + 8);
221 u64x8_store_unaligned ((b2 << CLIB_LOG2_CACHE_LINE_BYTES) + of8, b + 16);
222 u64x8_store_unaligned ((b3 << CLIB_LOG2_CACHE_LINE_BYTES) + of8, b + 24);
229 u64x8 b0 = u64x8_from_u32x8 (u32x8_load_unaligned (bi));
230 /* shift and add to get vlib_buffer_t pointer */
231 u64x8_store_unaligned ((b0 << CLIB_LOG2_CACHE_LINE_BYTES) + of8, b);
236 #elif defined CLIB_HAVE_VEC256
237 u64x4 off = u64x4_splat (buffer_mem_start + offset);
238 /* if count is not const, compiler will not unroll while loop
239 se we maintain two-in-parallel variant */
242 u64x4 b0 = u64x4_from_u32x4 (u32x4_load_unaligned (bi));
243 u64x4 b1 = u64x4_from_u32x4 (u32x4_load_unaligned (bi + 4));
244 u64x4 b2 = u64x4_from_u32x4 (u32x4_load_unaligned (bi + 8));
245 u64x4 b3 = u64x4_from_u32x4 (u32x4_load_unaligned (bi + 12));
246 u64x4 b4 = u64x4_from_u32x4 (u32x4_load_unaligned (bi + 16));
247 u64x4 b5 = u64x4_from_u32x4 (u32x4_load_unaligned (bi + 20));
248 u64x4 b6 = u64x4_from_u32x4 (u32x4_load_unaligned (bi + 24));
249 u64x4 b7 = u64x4_from_u32x4 (u32x4_load_unaligned (bi + 28));
250 /* shift and add to get vlib_buffer_t pointer */
251 u64x4_store_unaligned ((b0 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b);
252 u64x4_store_unaligned ((b1 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b + 4);
253 u64x4_store_unaligned ((b2 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b + 8);
254 u64x4_store_unaligned ((b3 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b + 12);
255 u64x4_store_unaligned ((b4 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b + 16);
256 u64x4_store_unaligned ((b5 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b + 20);
257 u64x4_store_unaligned ((b6 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b + 24);
258 u64x4_store_unaligned ((b7 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b + 28);
266 #ifdef CLIB_HAVE_VEC256
267 u64x4 b0 = u64x4_from_u32x4 (u32x4_load_unaligned (bi));
268 /* shift and add to get vlib_buffer_t pointer */
269 u64x4_store_unaligned ((b0 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b);
270 #elif defined (CLIB_HAVE_VEC128)
271 u64x2 off = u64x2_splat (buffer_mem_start + offset);
272 u32x4 bi4 = u32x4_load_unaligned (bi);
273 u64x2 b0 = u64x2_from_u32x4 ((u32x4) bi4);
274 #if defined (__aarch64__)
275 u64x2 b1 = u64x2_from_u32x4_high ((u32x4) bi4);
277 bi4 = u32x4_shuffle (bi4, 2, 3, 0, 1);
278 u64x2 b1 = u64x2_from_u32x4 ((u32x4) bi4);
280 u64x2_store_unaligned ((b0 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b);
281 u64x2_store_unaligned ((b1 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b + 2);
283 b[0] = vlib_buffer_ptr_from_index (buffer_mem_start, bi[0], offset);
284 b[1] = vlib_buffer_ptr_from_index (buffer_mem_start, bi[1], offset);
285 b[2] = vlib_buffer_ptr_from_index (buffer_mem_start, bi[2], offset);
286 b[3] = vlib_buffer_ptr_from_index (buffer_mem_start, bi[3], offset);
294 b[0] = vlib_buffer_ptr_from_index (buffer_mem_start, bi[0], offset);
301 /** \brief Translate array of buffer indices into buffer pointers
303 @param vm - (vlib_main_t *) vlib main data structure pointer
304 @param bi - (u32 *) array of buffer indices
305 @param b - (vlib_buffer_t **) array to store buffer pointers
306 @param count - (uword) number of elements
309 static_always_inline void
310 vlib_get_buffers (vlib_main_t * vm, u32 * bi, vlib_buffer_t ** b, int count)
312 vlib_get_buffers_with_offset (vm, bi, (void **) b, count, 0);
315 /** \brief Translate buffer pointer into buffer index
317 @param vm - (vlib_main_t *) vlib main data structure pointer
318 @param p - (void *) buffer pointer
319 @return - (u32) buffer index
323 vlib_get_buffer_index (vlib_main_t * vm, void *p)
325 vlib_buffer_main_t *bm = vm->buffer_main;
326 uword offset = pointer_to_uword (p) - bm->buffer_mem_start;
327 ASSERT (pointer_to_uword (p) >= bm->buffer_mem_start);
328 ASSERT (offset < bm->buffer_mem_size);
329 ASSERT ((offset % (1 << CLIB_LOG2_CACHE_LINE_BYTES)) == 0);
330 return offset >> CLIB_LOG2_CACHE_LINE_BYTES;
333 /** \brief Translate array of buffer pointers into buffer indices with offset
335 @param vm - (vlib_main_t *) vlib main data structure pointer
336 @param b - (void **) array of buffer pointers
337 @param bi - (u32 *) array to store buffer indices
338 @param count - (uword) number of elements
339 @param offset - (i32) offset applied to each pointer
341 static_always_inline void
342 vlib_get_buffer_indices_with_offset (vlib_main_t * vm, void **b, u32 * bi,
343 uword count, i32 offset)
345 #ifdef CLIB_HAVE_VEC256
346 u32x8 mask = { 0, 2, 4, 6, 1, 3, 5, 7 };
347 u64x4 off4 = u64x4_splat (vm->buffer_main->buffer_mem_start - offset);
351 /* load 4 pointers into 256-bit register */
352 u64x4 v0 = u64x4_load_unaligned (b);
353 u64x4 v1 = u64x4_load_unaligned (b + 4);
359 v0 >>= CLIB_LOG2_CACHE_LINE_BYTES;
360 v1 >>= CLIB_LOG2_CACHE_LINE_BYTES;
362 /* permute 256-bit register so lower u32s of each buffer index are
363 * placed into lower 128-bits */
364 v2 = u32x8_permute ((u32x8) v0, mask);
365 v3 = u32x8_permute ((u32x8) v1, mask);
367 /* extract lower 128-bits and save them to the array of buffer indices */
368 u32x4_store_unaligned (u32x8_extract_lo (v2), bi);
369 u32x4_store_unaligned (u32x8_extract_lo (v3), bi + 4);
377 /* equivalent non-nector implementation */
378 bi[0] = vlib_get_buffer_index (vm, ((u8 *) b[0]) + offset);
379 bi[1] = vlib_get_buffer_index (vm, ((u8 *) b[1]) + offset);
380 bi[2] = vlib_get_buffer_index (vm, ((u8 *) b[2]) + offset);
381 bi[3] = vlib_get_buffer_index (vm, ((u8 *) b[3]) + offset);
388 bi[0] = vlib_get_buffer_index (vm, ((u8 *) b[0]) + offset);
395 /** \brief Translate array of buffer pointers into buffer indices
397 @param vm - (vlib_main_t *) vlib main data structure pointer
398 @param b - (vlib_buffer_t **) array of buffer pointers
399 @param bi - (u32 *) array to store buffer indices
400 @param count - (uword) number of elements
402 static_always_inline void
403 vlib_get_buffer_indices (vlib_main_t * vm, vlib_buffer_t ** b, u32 * bi,
406 vlib_get_buffer_indices_with_offset (vm, (void **) b, bi, count, 0);
409 /** \brief Get next buffer in buffer linklist, or zero for end of list.
411 @param vm - (vlib_main_t *) vlib main data structure pointer
412 @param b - (void *) buffer pointer
413 @return - (vlib_buffer_t *) next buffer, or NULL
415 always_inline vlib_buffer_t *
416 vlib_get_next_buffer (vlib_main_t * vm, vlib_buffer_t * b)
418 return (b->flags & VLIB_BUFFER_NEXT_PRESENT
419 ? vlib_get_buffer (vm, b->next_buffer) : 0);
422 uword vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
423 vlib_buffer_t * b_first);
425 /** \brief Get length in bytes of the buffer chain
427 @param vm - (vlib_main_t *) vlib main data structure pointer
428 @param b - (void *) buffer pointer
429 @return - (uword) length of buffer chain
432 vlib_buffer_length_in_chain (vlib_main_t * vm, vlib_buffer_t * b)
434 uword len = b->current_length;
436 if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) == 0))
439 if (PREDICT_TRUE (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID))
440 return len + b->total_length_not_including_first_buffer;
442 return vlib_buffer_length_in_chain_slow_path (vm, b);
445 /** \brief Get length in bytes of the buffer index buffer chain
447 @param vm - (vlib_main_t *) vlib main data structure pointer
448 @param bi - (u32) buffer index
449 @return - (uword) length of buffer chain
452 vlib_buffer_index_length_in_chain (vlib_main_t * vm, u32 bi)
454 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
455 return vlib_buffer_length_in_chain (vm, b);
458 /** \brief Copy buffer contents to memory
460 @param vm - (vlib_main_t *) vlib main data structure pointer
461 @param buffer_index - (u32) buffer index
462 @param contents - (u8 *) memory, <strong>must be large enough</strong>
463 @return - (uword) length of buffer chain
466 vlib_buffer_contents (vlib_main_t * vm, u32 buffer_index, u8 * contents)
468 uword content_len = 0;
474 b = vlib_get_buffer (vm, buffer_index);
475 l = b->current_length;
476 clib_memcpy_fast (contents + content_len, b->data + b->current_data, l);
478 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
480 buffer_index = b->next_buffer;
487 vlib_buffer_get_pa (vlib_main_t * vm, vlib_buffer_t * b)
489 return vlib_physmem_get_pa (vm, b->data);
493 vlib_buffer_get_current_pa (vlib_main_t * vm, vlib_buffer_t * b)
495 return vlib_buffer_get_pa (vm, b) + b->current_data;
498 /** \brief Prefetch buffer metadata by buffer index
499 The first 64 bytes of buffer contains most header information
501 @param vm - (vlib_main_t *) vlib main data structure pointer
502 @param bi - (u32) buffer index
503 @param type - LOAD, STORE. In most cases, STORE is the right answer
505 /* Prefetch buffer header given index. */
506 #define vlib_prefetch_buffer_with_index(vm,bi,type) \
508 vlib_buffer_t * _b = vlib_get_buffer (vm, bi); \
509 vlib_prefetch_buffer_header (_b, type); \
514 /* Index is unknown. */
517 /* Index is known and free/allocated. */
518 VLIB_BUFFER_KNOWN_FREE,
519 VLIB_BUFFER_KNOWN_ALLOCATED,
520 } vlib_buffer_known_state_t;
522 void vlib_buffer_validate_alloc_free (vlib_main_t * vm, u32 * buffers,
524 vlib_buffer_known_state_t
527 always_inline vlib_buffer_known_state_t
528 vlib_buffer_is_known (vlib_main_t * vm, u32 buffer_index)
530 vlib_buffer_main_t *bm = vm->buffer_main;
532 clib_spinlock_lock (&bm->buffer_known_hash_lockp);
533 uword *p = hash_get (bm->buffer_known_hash, buffer_index);
534 clib_spinlock_unlock (&bm->buffer_known_hash_lockp);
535 return p ? p[0] : VLIB_BUFFER_UNKNOWN;
538 /* Validates sanity of a single buffer.
539 Returns format'ed vector with error message if any. */
540 u8 *vlib_validate_buffer (vlib_main_t * vm, u32 buffer_index,
543 u8 *vlib_validate_buffers (vlib_main_t * vm,
545 uword next_buffer_stride,
547 vlib_buffer_known_state_t known_state,
548 uword follow_buffer_next);
550 static_always_inline vlib_buffer_pool_t *
551 vlib_get_buffer_pool (vlib_main_t * vm, u8 buffer_pool_index)
553 vlib_buffer_main_t *bm = vm->buffer_main;
554 return vec_elt_at_index (bm->buffer_pools, buffer_pool_index);
557 static_always_inline __clib_warn_unused_result uword
558 vlib_buffer_pool_get (vlib_main_t * vm, u8 buffer_pool_index, u32 * buffers,
561 vlib_buffer_pool_t *bp = vlib_get_buffer_pool (vm, buffer_pool_index);
564 ASSERT (bp->buffers);
566 clib_spinlock_lock (&bp->lock);
568 if (PREDICT_TRUE (n_buffers < len))
571 vlib_buffer_copy_indices (buffers, bp->buffers + len, n_buffers);
573 clib_spinlock_unlock (&bp->lock);
578 vlib_buffer_copy_indices (buffers, bp->buffers, len);
580 clib_spinlock_unlock (&bp->lock);
586 /** \brief Allocate buffers from specific pool into supplied array
588 @param vm - (vlib_main_t *) vlib main data structure pointer
589 @param buffers - (u32 * ) buffer index array
590 @param n_buffers - (u32) number of buffers requested
591 @return - (u32) number of buffers actually allocated, may be
592 less than the number requested or zero
595 always_inline __clib_warn_unused_result u32
596 vlib_buffer_alloc_from_pool (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
597 u8 buffer_pool_index)
599 vlib_buffer_main_t *bm = vm->buffer_main;
600 vlib_buffer_pool_t *bp;
601 vlib_buffer_pool_thread_t *bpt;
602 u32 *src, *dst, len, n_left;
604 /* If buffer allocation fault injection is configured */
605 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR > 0)
607 u32 vlib_buffer_alloc_may_fail (vlib_main_t *, u32);
609 /* See how many buffers we're willing to allocate */
610 n_buffers = vlib_buffer_alloc_may_fail (vm, n_buffers);
615 bp = vec_elt_at_index (bm->buffer_pools, buffer_pool_index);
616 bpt = vec_elt_at_index (bp->threads, vm->thread_index);
622 /* per-thread cache contains enough buffers */
623 if (len >= n_buffers)
625 src = bpt->cached_buffers + len - n_buffers;
626 vlib_buffer_copy_indices (dst, src, n_buffers);
627 bpt->n_cached -= n_buffers;
630 vlib_buffer_validate_alloc_free (vm, buffers, n_buffers,
631 VLIB_BUFFER_KNOWN_FREE);
635 /* alloc bigger than cache - take buffers directly from main pool */
636 if (n_buffers >= VLIB_BUFFER_POOL_PER_THREAD_CACHE_SZ)
638 n_buffers = vlib_buffer_pool_get (vm, buffer_pool_index, buffers,
642 vlib_buffer_validate_alloc_free (vm, buffers, n_buffers,
643 VLIB_BUFFER_KNOWN_FREE);
647 /* take everything available in the cache */
650 vlib_buffer_copy_indices (dst, bpt->cached_buffers, len);
656 len = round_pow2 (n_left, 32);
657 len = vlib_buffer_pool_get (vm, buffer_pool_index, bpt->cached_buffers,
663 u32 n_copy = clib_min (len, n_left);
664 src = bpt->cached_buffers + len - n_copy;
665 vlib_buffer_copy_indices (dst, src, n_copy);
666 bpt->n_cached -= n_copy;
672 /* Verify that buffers are known free. */
674 vlib_buffer_validate_alloc_free (vm, buffers, n_buffers,
675 VLIB_BUFFER_KNOWN_FREE);
680 /** \brief Allocate buffers from specific numa node into supplied array
682 @param vm - (vlib_main_t *) vlib main data structure pointer
683 @param buffers - (u32 * ) buffer index array
684 @param n_buffers - (u32) number of buffers requested
685 @param numa_node - (u32) numa node
686 @return - (u32) number of buffers actually allocated, may be
687 less than the number requested or zero
689 always_inline __clib_warn_unused_result u32
690 vlib_buffer_alloc_on_numa (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
693 u8 index = vlib_buffer_pool_get_default_for_numa (vm, numa_node);
694 return vlib_buffer_alloc_from_pool (vm, buffers, n_buffers, index);
697 /** \brief Allocate buffers into supplied array
699 @param vm - (vlib_main_t *) vlib main data structure pointer
700 @param buffers - (u32 * ) buffer index array
701 @param n_buffers - (u32) number of buffers requested
702 @return - (u32) number of buffers actually allocated, may be
703 less than the number requested or zero
706 always_inline __clib_warn_unused_result u32
707 vlib_buffer_alloc (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
709 return vlib_buffer_alloc_on_numa (vm, buffers, n_buffers, vm->numa_node);
712 /** \brief Allocate buffers into ring
714 @param vm - (vlib_main_t *) vlib main data structure pointer
715 @param buffers - (u32 * ) buffer index ring
716 @param start - (u32) first slot in the ring
717 @param ring_size - (u32) ring size
718 @param n_buffers - (u32) number of buffers requested
719 @return - (u32) number of buffers actually allocated, may be
720 less than the number requested or zero
722 always_inline __clib_warn_unused_result u32
723 vlib_buffer_alloc_to_ring (vlib_main_t * vm, u32 * ring, u32 start,
724 u32 ring_size, u32 n_buffers)
728 ASSERT (n_buffers <= ring_size);
730 if (PREDICT_TRUE (start + n_buffers <= ring_size))
731 return vlib_buffer_alloc (vm, ring + start, n_buffers);
733 n_alloc = vlib_buffer_alloc (vm, ring + start, ring_size - start);
735 if (PREDICT_TRUE (n_alloc == ring_size - start))
736 n_alloc += vlib_buffer_alloc (vm, ring, n_buffers - n_alloc);
741 /** \brief Allocate buffers into ring from specific buffer pool
743 @param vm - (vlib_main_t *) vlib main data structure pointer
744 @param buffers - (u32 * ) buffer index ring
745 @param start - (u32) first slot in the ring
746 @param ring_size - (u32) ring size
747 @param n_buffers - (u32) number of buffers requested
748 @return - (u32) number of buffers actually allocated, may be
749 less than the number requested or zero
751 always_inline __clib_warn_unused_result u32
752 vlib_buffer_alloc_to_ring_from_pool (vlib_main_t * vm, u32 * ring, u32 start,
753 u32 ring_size, u32 n_buffers,
754 u8 buffer_pool_index)
758 ASSERT (n_buffers <= ring_size);
760 if (PREDICT_TRUE (start + n_buffers <= ring_size))
761 return vlib_buffer_alloc_from_pool (vm, ring + start, n_buffers,
764 n_alloc = vlib_buffer_alloc_from_pool (vm, ring + start, ring_size - start,
767 if (PREDICT_TRUE (n_alloc == ring_size - start))
768 n_alloc += vlib_buffer_alloc_from_pool (vm, ring, n_buffers - n_alloc,
774 static_always_inline void
775 vlib_buffer_pool_put (vlib_main_t * vm, u8 buffer_pool_index,
776 u32 * buffers, u32 n_buffers)
778 vlib_buffer_pool_t *bp = vlib_get_buffer_pool (vm, buffer_pool_index);
779 vlib_buffer_pool_thread_t *bpt = vec_elt_at_index (bp->threads,
781 u32 n_cached, n_empty;
784 vlib_buffer_validate_alloc_free (vm, buffers, n_buffers,
785 VLIB_BUFFER_KNOWN_ALLOCATED);
787 n_cached = bpt->n_cached;
788 n_empty = VLIB_BUFFER_POOL_PER_THREAD_CACHE_SZ - n_cached;
789 if (n_buffers <= n_empty)
791 vlib_buffer_copy_indices (bpt->cached_buffers + n_cached,
793 bpt->n_cached = n_cached + n_buffers;
797 vlib_buffer_copy_indices (bpt->cached_buffers + n_cached,
798 buffers + n_buffers - n_empty, n_empty);
799 bpt->n_cached = VLIB_BUFFER_POOL_PER_THREAD_CACHE_SZ;
801 clib_spinlock_lock (&bp->lock);
802 vlib_buffer_copy_indices (bp->buffers + bp->n_avail, buffers,
803 n_buffers - n_empty);
804 bp->n_avail += n_buffers - n_empty;
805 clib_spinlock_unlock (&bp->lock);
808 static_always_inline void
809 vlib_buffer_free_inline (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
812 const int queue_size = 128;
813 vlib_buffer_pool_t *bp = 0;
814 u8 buffer_pool_index = ~0;
815 u32 n_queue = 0, queue[queue_size + 4];
816 vlib_buffer_t bt = { };
817 #if defined(CLIB_HAVE_VEC128)
818 vlib_buffer_t bpi_mask = {.buffer_pool_index = ~0 };
819 vlib_buffer_t bpi_vec = {};
820 vlib_buffer_t flags_refs_mask = {
821 .flags = VLIB_BUFFER_NEXT_PRESENT,
826 if (PREDICT_FALSE (n_buffers == 0))
829 vlib_buffer_t *b = vlib_get_buffer (vm, buffers[0]);
830 buffer_pool_index = b->buffer_pool_index;
831 bp = vlib_get_buffer_pool (vm, buffer_pool_index);
832 vlib_buffer_copy_template (&bt, &bp->buffer_template);
833 #if defined(CLIB_HAVE_VEC128)
834 bpi_vec.buffer_pool_index = buffer_pool_index;
840 u32 bi, sum = 0, flags, next;
845 vlib_get_buffers (vm, buffers, b, 4);
849 vlib_get_buffers (vm, buffers + 8, b + 4, 4);
850 vlib_prefetch_buffer_header (b[4], LOAD);
851 vlib_prefetch_buffer_header (b[5], LOAD);
852 vlib_prefetch_buffer_header (b[6], LOAD);
853 vlib_prefetch_buffer_header (b[7], LOAD);
856 #if defined(CLIB_HAVE_VEC128)
857 u8x16 p0, p1, p2, p3, r;
858 p0 = u8x16_load_unaligned (b[0]);
859 p1 = u8x16_load_unaligned (b[1]);
860 p2 = u8x16_load_unaligned (b[2]);
861 p3 = u8x16_load_unaligned (b[3]);
863 r = p0 ^ bpi_vec.as_u8x16[0];
864 r |= p1 ^ bpi_vec.as_u8x16[0];
865 r |= p2 ^ bpi_vec.as_u8x16[0];
866 r |= p3 ^ bpi_vec.as_u8x16[0];
867 r &= bpi_mask.as_u8x16[0];
868 r |= (p0 | p1 | p2 | p3) & flags_refs_mask.as_u8x16[0];
870 sum = !u8x16_is_all_zero (r);
876 sum &= VLIB_BUFFER_NEXT_PRESENT;
877 sum += b[0]->ref_count - 1;
878 sum += b[1]->ref_count - 1;
879 sum += b[2]->ref_count - 1;
880 sum += b[3]->ref_count - 1;
881 sum |= b[0]->buffer_pool_index ^ buffer_pool_index;
882 sum |= b[1]->buffer_pool_index ^ buffer_pool_index;
883 sum |= b[2]->buffer_pool_index ^ buffer_pool_index;
884 sum |= b[3]->buffer_pool_index ^ buffer_pool_index;
890 vlib_buffer_copy_indices (queue + n_queue, buffers, 4);
891 vlib_buffer_copy_template (b[0], &bt);
892 vlib_buffer_copy_template (b[1], &bt);
893 vlib_buffer_copy_template (b[2], &bt);
894 vlib_buffer_copy_template (b[3], &bt);
897 vlib_buffer_validate (vm, b[0]);
898 vlib_buffer_validate (vm, b[1]);
899 vlib_buffer_validate (vm, b[2]);
900 vlib_buffer_validate (vm, b[3]);
902 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
903 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[1]);
904 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[2]);
905 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[3]);
907 if (n_queue >= queue_size)
909 vlib_buffer_pool_put (vm, buffer_pool_index, queue, n_queue);
920 b[0] = vlib_get_buffer (vm, bi);
922 next = b[0]->next_buffer;
924 if (PREDICT_FALSE (buffer_pool_index != b[0]->buffer_pool_index))
929 vlib_buffer_pool_put (vm, buffer_pool_index, queue, n_queue);
933 buffer_pool_index = b[0]->buffer_pool_index;
934 #if defined(CLIB_HAVE_VEC128)
935 bpi_vec.buffer_pool_index = buffer_pool_index;
937 bp = vlib_get_buffer_pool (vm, buffer_pool_index);
938 vlib_buffer_copy_template (&bt, &bp->buffer_template);
941 vlib_buffer_validate (vm, b[0]);
943 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
945 if (clib_atomic_sub_fetch (&b[0]->ref_count, 1) == 0)
947 vlib_buffer_copy_template (b[0], &bt);
948 queue[n_queue++] = bi;
951 if (n_queue == queue_size)
953 vlib_buffer_pool_put (vm, buffer_pool_index, queue, queue_size);
957 if (maybe_next && (flags & VLIB_BUFFER_NEXT_PRESENT))
968 vlib_buffer_pool_put (vm, buffer_pool_index, queue, n_queue);
972 /** \brief Free buffers
973 Frees the entire buffer chain for each buffer
975 @param vm - (vlib_main_t *) vlib main data structure pointer
976 @param buffers - (u32 * ) buffer index array
977 @param n_buffers - (u32) number of buffers to free
981 vlib_buffer_free (vlib_main_t * vm,
982 /* pointer to first buffer */
984 /* number of buffers to free */
987 vlib_buffer_free_inline (vm, buffers, n_buffers, /* maybe next */ 1);
990 /** \brief Free buffers, does not free the buffer chain for each buffer
992 @param vm - (vlib_main_t *) vlib main data structure pointer
993 @param buffers - (u32 * ) buffer index array
994 @param n_buffers - (u32) number of buffers to free
998 vlib_buffer_free_no_next (vlib_main_t * vm,
999 /* pointer to first buffer */
1001 /* number of buffers to free */
1004 vlib_buffer_free_inline (vm, buffers, n_buffers, /* maybe next */ 0);
1007 /** \brief Free one buffer
1008 Shorthand to free a single buffer chain.
1010 @param vm - (vlib_main_t *) vlib main data structure pointer
1011 @param buffer_index - (u32) buffer index to free
1014 vlib_buffer_free_one (vlib_main_t * vm, u32 buffer_index)
1016 vlib_buffer_free_inline (vm, &buffer_index, 1, /* maybe next */ 1);
1019 /** \brief Free buffers from ring
1021 @param vm - (vlib_main_t *) vlib main data structure pointer
1022 @param buffers - (u32 * ) buffer index ring
1023 @param start - (u32) first slot in the ring
1024 @param ring_size - (u32) ring size
1025 @param n_buffers - (u32) number of buffers
1028 vlib_buffer_free_from_ring (vlib_main_t * vm, u32 * ring, u32 start,
1029 u32 ring_size, u32 n_buffers)
1031 ASSERT (n_buffers <= ring_size);
1033 if (PREDICT_TRUE (start + n_buffers <= ring_size))
1035 vlib_buffer_free (vm, ring + start, n_buffers);
1039 vlib_buffer_free (vm, ring + start, ring_size - start);
1040 vlib_buffer_free (vm, ring, n_buffers - (ring_size - start));
1044 /** \brief Free buffers from ring without freeing tail buffers
1046 @param vm - (vlib_main_t *) vlib main data structure pointer
1047 @param buffers - (u32 * ) buffer index ring
1048 @param start - (u32) first slot in the ring
1049 @param ring_size - (u32) ring size
1050 @param n_buffers - (u32) number of buffers
1053 vlib_buffer_free_from_ring_no_next (vlib_main_t * vm, u32 * ring, u32 start,
1054 u32 ring_size, u32 n_buffers)
1056 ASSERT (n_buffers <= ring_size);
1058 if (PREDICT_TRUE (start + n_buffers <= ring_size))
1060 vlib_buffer_free_no_next (vm, ring + start, n_buffers);
1064 vlib_buffer_free_no_next (vm, ring + start, ring_size - start);
1065 vlib_buffer_free_no_next (vm, ring, n_buffers - (ring_size - start));
1069 /* Append given data to end of buffer, possibly allocating new buffers. */
1070 int vlib_buffer_add_data (vlib_main_t * vm, u32 * buffer_index, void *data,
1073 /* Define vlib_buffer and vnet_buffer flags bits preserved for copy/clone */
1074 #define VLIB_BUFFER_COPY_CLONE_FLAGS_MASK \
1075 (VLIB_BUFFER_NEXT_PRESENT | VLIB_BUFFER_TOTAL_LENGTH_VALID | \
1076 VLIB_BUFFER_IS_TRACED | ~VLIB_BUFFER_FLAGS_ALL)
1078 /* duplicate all buffers in chain */
1079 always_inline vlib_buffer_t *
1080 vlib_buffer_copy (vlib_main_t * vm, vlib_buffer_t * b)
1082 vlib_buffer_t *s, *d, *fd;
1083 uword n_alloc, n_buffers = 1;
1084 u32 flag_mask = VLIB_BUFFER_COPY_CLONE_FLAGS_MASK;
1088 while (s->flags & VLIB_BUFFER_NEXT_PRESENT)
1091 s = vlib_get_buffer (vm, s->next_buffer);
1093 u32 new_buffers[n_buffers];
1095 n_alloc = vlib_buffer_alloc (vm, new_buffers, n_buffers);
1097 /* No guarantee that we'll get all the buffers we asked for */
1098 if (PREDICT_FALSE (n_alloc < n_buffers))
1101 vlib_buffer_free (vm, new_buffers, n_alloc);
1107 fd = d = vlib_get_buffer (vm, new_buffers[0]);
1108 d->current_data = s->current_data;
1109 d->current_length = s->current_length;
1110 d->flags = s->flags & flag_mask;
1111 d->trace_handle = s->trace_handle;
1112 d->total_length_not_including_first_buffer =
1113 s->total_length_not_including_first_buffer;
1114 clib_memcpy_fast (d->opaque, s->opaque, sizeof (s->opaque));
1115 clib_memcpy_fast (d->opaque2, s->opaque2, sizeof (s->opaque2));
1116 clib_memcpy_fast (vlib_buffer_get_current (d),
1117 vlib_buffer_get_current (s), s->current_length);
1120 for (i = 1; i < n_buffers; i++)
1123 d->next_buffer = new_buffers[i];
1125 s = vlib_get_buffer (vm, s->next_buffer);
1126 d = vlib_get_buffer (vm, new_buffers[i]);
1127 d->current_data = s->current_data;
1128 d->current_length = s->current_length;
1129 clib_memcpy_fast (vlib_buffer_get_current (d),
1130 vlib_buffer_get_current (s), s->current_length);
1131 d->flags = s->flags & flag_mask;
1137 /* duplicate first buffer in chain */
1138 always_inline vlib_buffer_t *
1139 vlib_buffer_copy_no_chain (vlib_main_t * vm, vlib_buffer_t * b, u32 * di)
1143 if ((vlib_buffer_alloc (vm, di, 1)) != 1)
1146 d = vlib_get_buffer (vm, *di);
1148 d->current_data = b->current_data;
1149 d->current_length = b->current_length;
1150 clib_memcpy_fast (d->opaque, b->opaque, sizeof (b->opaque));
1151 clib_memcpy_fast (d->opaque2, b->opaque2, sizeof (b->opaque2));
1152 clib_memcpy_fast (vlib_buffer_get_current (d),
1153 vlib_buffer_get_current (b), b->current_length);
1158 /* \brief Move packet from current position to offset position in buffer.
1159 Only work for small packet using one buffer with room to fit the move
1160 @param vm - (vlib_main_t *) vlib main data structure pointer
1161 @param b - (vlib_buffer_t *) pointer to buffer
1162 @param offset - (i16) position to move the packet in buffer
1165 vlib_buffer_move (vlib_main_t * vm, vlib_buffer_t * b, i16 offset)
1167 ASSERT ((b->flags & VLIB_BUFFER_NEXT_PRESENT) == 0);
1168 ASSERT (offset + VLIB_BUFFER_PRE_DATA_SIZE >= 0);
1169 ASSERT (offset + b->current_length <
1170 vlib_buffer_get_default_data_size (vm));
1172 u8 *source = vlib_buffer_get_current (b);
1173 b->current_data = offset;
1174 u8 *destination = vlib_buffer_get_current (b);
1175 u16 length = b->current_length;
1177 if (source + length <= destination) /* no overlap */
1178 clib_memcpy_fast (destination, source, length);
1180 memmove (destination, source, length);
1183 /** \brief Create a maximum of 256 clones of buffer and store them
1184 in the supplied array
1186 @param vm - (vlib_main_t *) vlib main data structure pointer
1187 @param src_buffer - (u32) source buffer index
1188 @param buffers - (u32 * ) buffer index array
1189 @param n_buffers - (u16) number of buffer clones requested (<=256)
1190 @param head_end_offset - (u16) offset relative to current position
1191 where packet head ends
1192 @param offset - (i16) copy packet head at current position if 0,
1193 else at offset position to change headroom space as specified
1194 @return - (u16) number of buffers actually cloned, may be
1195 less than the number requested or zero
1198 vlib_buffer_clone_256 (vlib_main_t * vm, u32 src_buffer, u32 * buffers,
1199 u16 n_buffers, u16 head_end_offset, i16 offset)
1202 vlib_buffer_t *s = vlib_get_buffer (vm, src_buffer);
1204 ASSERT (s->ref_count == 1);
1206 ASSERT (n_buffers <= 256);
1207 ASSERT (offset + VLIB_BUFFER_PRE_DATA_SIZE >= 0);
1208 ASSERT ((offset + head_end_offset) <
1209 vlib_buffer_get_default_data_size (vm));
1211 if (s->current_length <= head_end_offset + CLIB_CACHE_LINE_BYTES * 2)
1213 buffers[0] = src_buffer;
1215 vlib_buffer_move (vm, s, offset);
1217 for (i = 1; i < n_buffers; i++)
1220 d = vlib_buffer_copy (vm, s);
1223 buffers[i] = vlib_get_buffer_index (vm, d);
1229 if (PREDICT_FALSE ((n_buffers == 1) && (offset == 0)))
1231 buffers[0] = src_buffer;
1235 n_buffers = vlib_buffer_alloc_from_pool (vm, buffers, n_buffers,
1236 s->buffer_pool_index);
1238 for (i = 0; i < n_buffers; i++)
1240 vlib_buffer_t *d = vlib_get_buffer (vm, buffers[i]);
1242 d->current_data = offset;
1244 d->current_data = s->current_data;
1246 d->current_length = head_end_offset;
1247 ASSERT (d->buffer_pool_index == s->buffer_pool_index);
1249 d->total_length_not_including_first_buffer = s->current_length -
1251 if (PREDICT_FALSE (s->flags & VLIB_BUFFER_NEXT_PRESENT))
1253 d->total_length_not_including_first_buffer +=
1254 s->total_length_not_including_first_buffer;
1256 d->flags = (s->flags & VLIB_BUFFER_COPY_CLONE_FLAGS_MASK) |
1257 VLIB_BUFFER_NEXT_PRESENT;
1258 d->trace_handle = s->trace_handle;
1259 clib_memcpy_fast (d->opaque, s->opaque, sizeof (s->opaque));
1260 clib_memcpy_fast (d->opaque2, s->opaque2, sizeof (s->opaque2));
1261 clib_memcpy_fast (vlib_buffer_get_current (d),
1262 vlib_buffer_get_current (s), head_end_offset);
1263 d->next_buffer = src_buffer;
1265 vlib_buffer_advance (s, head_end_offset);
1266 s->ref_count = n_buffers ? n_buffers : s->ref_count;
1267 while (s->flags & VLIB_BUFFER_NEXT_PRESENT)
1269 s = vlib_get_buffer (vm, s->next_buffer);
1270 s->ref_count = n_buffers ? n_buffers : s->ref_count;
1276 /** \brief Create multiple clones of buffer and store them
1277 in the supplied array
1279 @param vm - (vlib_main_t *) vlib main data structure pointer
1280 @param src_buffer - (u32) source buffer index
1281 @param buffers - (u32 * ) buffer index array
1282 @param n_buffers - (u16) number of buffer clones requested (<=256)
1283 @param head_end_offset - (u16) offset relative to current position
1284 where packet head ends
1285 @param offset - (i16) copy packet head at current position if 0,
1286 else at offset position to change headroom space as specified
1287 @return - (u16) number of buffers actually cloned, may be
1288 less than the number requested or zero
1291 vlib_buffer_clone_at_offset (vlib_main_t * vm, u32 src_buffer, u32 * buffers,
1292 u16 n_buffers, u16 head_end_offset, i16 offset)
1294 vlib_buffer_t *s = vlib_get_buffer (vm, src_buffer);
1297 while (n_buffers > 256)
1299 vlib_buffer_t *copy;
1300 copy = vlib_buffer_copy (vm, s);
1301 n_cloned += vlib_buffer_clone_256 (vm,
1302 vlib_get_buffer_index (vm, copy),
1303 (buffers + n_cloned),
1304 256, head_end_offset, offset);
1307 n_cloned += vlib_buffer_clone_256 (vm, src_buffer,
1309 n_buffers, head_end_offset, offset);
1314 /** \brief Create multiple clones of buffer and store them
1315 in the supplied array
1317 @param vm - (vlib_main_t *) vlib main data structure pointer
1318 @param src_buffer - (u32) source buffer index
1319 @param buffers - (u32 * ) buffer index array
1320 @param n_buffers - (u16) number of buffer clones requested (<=256)
1321 @param head_end_offset - (u16) offset relative to current position
1322 where packet head ends
1323 @return - (u16) number of buffers actually cloned, may be
1324 less than the number requested or zero
1327 vlib_buffer_clone (vlib_main_t * vm, u32 src_buffer, u32 * buffers,
1328 u16 n_buffers, u16 head_end_offset)
1330 return vlib_buffer_clone_at_offset (vm, src_buffer, buffers, n_buffers,
1331 head_end_offset, 0);
1334 /** \brief Attach cloned tail to the buffer
1336 @param vm - (vlib_main_t *) vlib main data structure pointer
1337 @param head - (vlib_buffer_t *) head buffer
1338 @param tail - (Vlib buffer_t *) tail buffer to clone and attach to head
1342 vlib_buffer_attach_clone (vlib_main_t * vm, vlib_buffer_t * head,
1343 vlib_buffer_t * tail)
1345 ASSERT ((head->flags & VLIB_BUFFER_NEXT_PRESENT) == 0);
1346 ASSERT (head->buffer_pool_index == tail->buffer_pool_index);
1348 head->flags |= VLIB_BUFFER_NEXT_PRESENT;
1349 head->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
1350 head->flags &= ~VLIB_BUFFER_EXT_HDR_VALID;
1351 head->flags |= (tail->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID);
1352 head->next_buffer = vlib_get_buffer_index (vm, tail);
1353 head->total_length_not_including_first_buffer = tail->current_length +
1354 tail->total_length_not_including_first_buffer;
1357 clib_atomic_add_fetch (&tail->ref_count, 1);
1359 if (tail->flags & VLIB_BUFFER_NEXT_PRESENT)
1361 tail = vlib_get_buffer (vm, tail->next_buffer);
1366 /* Initializes the buffer as an empty packet with no chained buffers. */
1368 vlib_buffer_chain_init (vlib_buffer_t * first)
1370 first->total_length_not_including_first_buffer = 0;
1371 first->current_length = 0;
1372 first->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
1373 first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
1376 /* The provided next_bi buffer index is appended to the end of the packet. */
1377 always_inline vlib_buffer_t *
1378 vlib_buffer_chain_buffer (vlib_main_t * vm, vlib_buffer_t * last, u32 next_bi)
1380 vlib_buffer_t *next_buffer = vlib_get_buffer (vm, next_bi);
1381 last->next_buffer = next_bi;
1382 last->flags |= VLIB_BUFFER_NEXT_PRESENT;
1383 next_buffer->current_length = 0;
1384 next_buffer->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
1388 /* Increases or decreases the packet length.
1389 * It does not allocate or deallocate new buffers.
1390 * Therefore, the added length must be compatible
1391 * with the last buffer. */
1393 vlib_buffer_chain_increase_length (vlib_buffer_t * first,
1394 vlib_buffer_t * last, i32 len)
1396 last->current_length += len;
1398 first->total_length_not_including_first_buffer += len;
1401 /* Copy data to the end of the packet and increases its length.
1402 * It does not allocate new buffers.
1403 * Returns the number of copied bytes. */
1405 vlib_buffer_chain_append_data (vlib_main_t * vm,
1406 vlib_buffer_t * first,
1407 vlib_buffer_t * last, void *data, u16 data_len)
1409 u32 n_buffer_bytes = vlib_buffer_get_default_data_size (vm);
1410 ASSERT (n_buffer_bytes >= last->current_length + last->current_data);
1411 u16 len = clib_min (data_len,
1412 n_buffer_bytes - last->current_length -
1413 last->current_data);
1414 clib_memcpy_fast (vlib_buffer_get_current (last) + last->current_length,
1416 vlib_buffer_chain_increase_length (first, last, len);
1420 /* Copy data to the end of the packet and increases its length.
1421 * Allocates additional buffers from the free list if necessary.
1422 * Returns the number of copied bytes.
1423 * 'last' value is modified whenever new buffers are allocated and
1424 * chained and points to the last buffer in the chain. */
1426 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
1427 vlib_buffer_t * first,
1428 vlib_buffer_t ** last, void *data,
1430 void vlib_buffer_chain_validate (vlib_main_t * vm, vlib_buffer_t * first);
1432 format_function_t format_vlib_buffer, format_vlib_buffer_and_data,
1433 format_vlib_buffer_contents, format_vlib_buffer_no_chain;
1437 /* Vector of packet data. */
1440 /* Number of buffers to allocate in each call to allocator. */
1441 u32 min_n_buffers_each_alloc;
1444 } vlib_packet_template_t;
1446 void vlib_packet_template_init (vlib_main_t * vm,
1447 vlib_packet_template_t * t,
1449 uword n_packet_data_bytes,
1450 uword min_n_buffers_each_alloc,
1453 void *vlib_packet_template_get_packet (vlib_main_t * vm,
1454 vlib_packet_template_t * t,
1458 vlib_packet_template_free (vlib_main_t * vm, vlib_packet_template_t * t)
1460 vec_free (t->packet_data);
1464 vlib_buffer_space_left_at_end (vlib_main_t * vm, vlib_buffer_t * b)
1466 return b->data + vlib_buffer_get_default_data_size (vm) -
1467 ((u8 *) vlib_buffer_get_current (b) + b->current_length);
1471 vlib_buffer_chain_linearize (vlib_main_t * vm, vlib_buffer_t * b)
1473 vlib_buffer_t *db = b, *sb, *first = b;
1475 u32 bytes_left = 0, data_size;
1476 u16 src_left, dst_left, n_buffers = 1;
1480 if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) == 0))
1483 data_size = vlib_buffer_get_default_data_size (vm);
1485 dst_left = vlib_buffer_space_left_at_end (vm, b);
1487 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1489 b = vlib_get_buffer (vm, b->next_buffer);
1490 if (b->ref_count > 1)
1492 bytes_left += b->current_length;
1496 /* if buffer is cloned, create completely new chain - unless everything fits
1497 * into one buffer */
1498 if (is_cloned && bytes_left >= dst_left)
1501 u32 space_needed = bytes_left - dst_left;
1504 if (vlib_buffer_alloc (vm, &tail, 1) == 0)
1509 b = vlib_get_buffer (vm, tail);
1511 while (len < space_needed)
1514 if (vlib_buffer_alloc (vm, &bi, 1) == 0)
1516 vlib_buffer_free_one (vm, tail);
1519 b->flags = VLIB_BUFFER_NEXT_PRESENT;
1520 b->next_buffer = bi;
1521 b = vlib_get_buffer (vm, bi);
1525 sb = vlib_get_buffer (vm, first->next_buffer);
1526 to_free = first->next_buffer;
1527 first->next_buffer = tail;
1530 sb = vlib_get_buffer (vm, first->next_buffer);
1532 src_left = sb->current_length;
1533 sp = vlib_buffer_get_current (sb);
1534 dp = vlib_buffer_get_tail (db);
1542 db->current_length = dp - (u8 *) vlib_buffer_get_current (db);
1543 ASSERT (db->flags & VLIB_BUFFER_NEXT_PRESENT);
1544 db = vlib_get_buffer (vm, db->next_buffer);
1545 dst_left = data_size;
1546 if (db->current_data > 0)
1548 db->current_data = 0;
1552 dst_left += -db->current_data;
1554 dp = vlib_buffer_get_current (db);
1557 while (src_left == 0)
1559 ASSERT (sb->flags & VLIB_BUFFER_NEXT_PRESENT);
1560 sb = vlib_get_buffer (vm, sb->next_buffer);
1561 src_left = sb->current_length;
1562 sp = vlib_buffer_get_current (sb);
1565 bytes_to_copy = clib_min (dst_left, src_left);
1570 bytes_to_copy = clib_min (bytes_to_copy, sp - dp);
1572 clib_memcpy_fast (dp, sp, bytes_to_copy);
1575 src_left -= bytes_to_copy;
1576 dst_left -= bytes_to_copy;
1577 dp += bytes_to_copy;
1578 sp += bytes_to_copy;
1579 bytes_left -= bytes_to_copy;
1582 db->current_data = 0;
1583 db->current_length = dp - (u8 *) vlib_buffer_get_current (db);
1585 if (is_cloned && to_free)
1586 vlib_buffer_free_one (vm, to_free);
1589 if (db->flags & VLIB_BUFFER_NEXT_PRESENT)
1590 vlib_buffer_free_one (vm, db->next_buffer);
1591 db->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
1594 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1596 b = vlib_get_buffer (vm, b->next_buffer);
1601 first->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
1606 #endif /* included_vlib_buffer_funcs_h */
1609 * fd.io coding-style-patch-verification: ON
1612 * eval: (c-set-style "gnu")