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 clib_memcpy_u32 (dst, src, n_indices);
128 vlib_buffer_copy_indices_from_ring (u32 * dst, u32 * ring, u32 start,
129 u32 ring_size, u32 n_buffers)
131 ASSERT (n_buffers <= ring_size);
133 if (PREDICT_TRUE (start + n_buffers <= ring_size))
135 vlib_buffer_copy_indices (dst, ring + start, n_buffers);
139 u32 n = ring_size - start;
140 vlib_buffer_copy_indices (dst, ring + start, n);
141 vlib_buffer_copy_indices (dst + n, ring, n_buffers - n);
146 vlib_buffer_copy_indices_to_ring (u32 * ring, u32 * src, u32 start,
147 u32 ring_size, u32 n_buffers)
149 ASSERT (n_buffers <= ring_size);
151 if (PREDICT_TRUE (start + n_buffers <= ring_size))
153 vlib_buffer_copy_indices (ring + start, src, n_buffers);
157 u32 n = ring_size - start;
158 vlib_buffer_copy_indices (ring + start, src, n);
159 vlib_buffer_copy_indices (ring, src + n, n_buffers - n);
163 STATIC_ASSERT_OFFSET_OF (vlib_buffer_t, template_end, 64);
164 static_always_inline void
165 vlib_buffer_copy_template (vlib_buffer_t * b, vlib_buffer_t * bt)
167 #if defined CLIB_HAVE_VEC512
168 b->as_u8x64[0] = bt->as_u8x64[0];
169 #elif defined (CLIB_HAVE_VEC256)
170 b->as_u8x32[0] = bt->as_u8x32[0];
171 b->as_u8x32[1] = bt->as_u8x32[1];
172 #elif defined (CLIB_HAVE_VEC128)
173 b->as_u8x16[0] = bt->as_u8x16[0];
174 b->as_u8x16[1] = bt->as_u8x16[1];
175 b->as_u8x16[2] = bt->as_u8x16[2];
176 b->as_u8x16[3] = bt->as_u8x16[3];
178 clib_memcpy_fast (b, bt, 64);
183 vlib_buffer_pool_get_default_for_numa (vlib_main_t * vm, u32 numa_node)
185 ASSERT (numa_node < VLIB_BUFFER_MAX_NUMA_NODES);
186 return vm->buffer_main->default_buffer_pool_index_for_numa[numa_node];
189 /** \brief Translate array of buffer indices into buffer pointers with offset
191 @param vm - (vlib_main_t *) vlib main data structure pointer
192 @param bi - (u32 *) array of buffer indices
193 @param b - (void **) array to store buffer pointers
194 @param count - (uword) number of elements
195 @param offset - (i32) offset applied to each pointer
197 static_always_inline void
198 vlib_get_buffers_with_offset (vlib_main_t * vm, u32 * bi, void **b, int count,
201 uword buffer_mem_start = vm->buffer_main->buffer_mem_start;
202 #ifdef CLIB_HAVE_VEC512
203 u64x8 of8 = u64x8_splat (buffer_mem_start + offset);
204 u64x4 off = u64x8_extract_lo (of8);
205 /* if count is not const, compiler will not unroll while loop
206 se we maintain two-in-parallel variant */
209 u64x8 b0 = u64x8_from_u32x8 (u32x8_load_unaligned (bi));
210 u64x8 b1 = u64x8_from_u32x8 (u32x8_load_unaligned (bi + 8));
211 u64x8 b2 = u64x8_from_u32x8 (u32x8_load_unaligned (bi + 16));
212 u64x8 b3 = u64x8_from_u32x8 (u32x8_load_unaligned (bi + 24));
213 /* shift and add to get vlib_buffer_t pointer */
214 u64x8_store_unaligned ((b0 << CLIB_LOG2_CACHE_LINE_BYTES) + of8, b);
215 u64x8_store_unaligned ((b1 << CLIB_LOG2_CACHE_LINE_BYTES) + of8, b + 8);
216 u64x8_store_unaligned ((b2 << CLIB_LOG2_CACHE_LINE_BYTES) + of8, b + 16);
217 u64x8_store_unaligned ((b3 << CLIB_LOG2_CACHE_LINE_BYTES) + of8, b + 24);
224 u64x8 b0 = u64x8_from_u32x8 (u32x8_load_unaligned (bi));
225 /* shift and add to get vlib_buffer_t pointer */
226 u64x8_store_unaligned ((b0 << CLIB_LOG2_CACHE_LINE_BYTES) + of8, b);
231 #elif defined CLIB_HAVE_VEC256
232 u64x4 off = u64x4_splat (buffer_mem_start + offset);
233 /* if count is not const, compiler will not unroll while loop
234 se we maintain two-in-parallel variant */
237 u64x4 b0 = u64x4_from_u32x4 (u32x4_load_unaligned (bi));
238 u64x4 b1 = u64x4_from_u32x4 (u32x4_load_unaligned (bi + 4));
239 u64x4 b2 = u64x4_from_u32x4 (u32x4_load_unaligned (bi + 8));
240 u64x4 b3 = u64x4_from_u32x4 (u32x4_load_unaligned (bi + 12));
241 u64x4 b4 = u64x4_from_u32x4 (u32x4_load_unaligned (bi + 16));
242 u64x4 b5 = u64x4_from_u32x4 (u32x4_load_unaligned (bi + 20));
243 u64x4 b6 = u64x4_from_u32x4 (u32x4_load_unaligned (bi + 24));
244 u64x4 b7 = u64x4_from_u32x4 (u32x4_load_unaligned (bi + 28));
245 /* shift and add to get vlib_buffer_t pointer */
246 u64x4_store_unaligned ((b0 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b);
247 u64x4_store_unaligned ((b1 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b + 4);
248 u64x4_store_unaligned ((b2 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b + 8);
249 u64x4_store_unaligned ((b3 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b + 12);
250 u64x4_store_unaligned ((b4 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b + 16);
251 u64x4_store_unaligned ((b5 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b + 20);
252 u64x4_store_unaligned ((b6 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b + 24);
253 u64x4_store_unaligned ((b7 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b + 28);
261 #ifdef CLIB_HAVE_VEC256
262 u64x4 b0 = u64x4_from_u32x4 (u32x4_load_unaligned (bi));
263 /* shift and add to get vlib_buffer_t pointer */
264 u64x4_store_unaligned ((b0 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b);
265 #elif defined (CLIB_HAVE_VEC128)
266 u64x2 off = u64x2_splat (buffer_mem_start + offset);
267 u32x4 bi4 = u32x4_load_unaligned (bi);
268 u64x2 b0 = u64x2_from_u32x4 ((u32x4) bi4);
269 #if defined (__aarch64__)
270 u64x2 b1 = u64x2_from_u32x4_high ((u32x4) bi4);
272 bi4 = u32x4_shuffle (bi4, 2, 3, 0, 1);
273 u64x2 b1 = u64x2_from_u32x4 ((u32x4) bi4);
275 u64x2_store_unaligned ((b0 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b);
276 u64x2_store_unaligned ((b1 << CLIB_LOG2_CACHE_LINE_BYTES) + off, b + 2);
278 b[0] = vlib_buffer_ptr_from_index (buffer_mem_start, bi[0], offset);
279 b[1] = vlib_buffer_ptr_from_index (buffer_mem_start, bi[1], offset);
280 b[2] = vlib_buffer_ptr_from_index (buffer_mem_start, bi[2], offset);
281 b[3] = vlib_buffer_ptr_from_index (buffer_mem_start, bi[3], offset);
289 b[0] = vlib_buffer_ptr_from_index (buffer_mem_start, bi[0], offset);
296 /** \brief Translate array of buffer indices into buffer pointers
298 @param vm - (vlib_main_t *) vlib main data structure pointer
299 @param bi - (u32 *) array of buffer indices
300 @param b - (vlib_buffer_t **) array to store buffer pointers
301 @param count - (uword) number of elements
304 static_always_inline void
305 vlib_get_buffers (vlib_main_t * vm, u32 * bi, vlib_buffer_t ** b, int count)
307 vlib_get_buffers_with_offset (vm, bi, (void **) b, count, 0);
310 /** \brief Translate buffer pointer into buffer index
312 @param vm - (vlib_main_t *) vlib main data structure pointer
313 @param p - (void *) buffer pointer
314 @return - (u32) buffer index
318 vlib_get_buffer_index (vlib_main_t * vm, void *p)
320 vlib_buffer_main_t *bm = vm->buffer_main;
321 uword offset = pointer_to_uword (p) - bm->buffer_mem_start;
322 ASSERT (pointer_to_uword (p) >= bm->buffer_mem_start);
323 ASSERT (offset < bm->buffer_mem_size);
324 ASSERT ((offset % (1 << CLIB_LOG2_CACHE_LINE_BYTES)) == 0);
325 return offset >> CLIB_LOG2_CACHE_LINE_BYTES;
328 /** \brief Translate array of buffer pointers into buffer indices with offset
330 @param vm - (vlib_main_t *) vlib main data structure pointer
331 @param b - (void **) array of buffer pointers
332 @param bi - (u32 *) array to store buffer indices
333 @param count - (uword) number of elements
334 @param offset - (i32) offset applied to each pointer
336 static_always_inline void
337 vlib_get_buffer_indices_with_offset (vlib_main_t * vm, void **b, u32 * bi,
338 uword count, i32 offset)
340 #ifdef CLIB_HAVE_VEC256
341 u32x8 mask = { 0, 2, 4, 6, 1, 3, 5, 7 };
342 u64x4 off4 = u64x4_splat (vm->buffer_main->buffer_mem_start - offset);
346 /* load 4 pointers into 256-bit register */
347 u64x4 v0 = u64x4_load_unaligned (b);
348 u64x4 v1 = u64x4_load_unaligned (b + 4);
354 v0 >>= CLIB_LOG2_CACHE_LINE_BYTES;
355 v1 >>= CLIB_LOG2_CACHE_LINE_BYTES;
357 /* permute 256-bit register so lower u32s of each buffer index are
358 * placed into lower 128-bits */
359 v2 = u32x8_permute ((u32x8) v0, mask);
360 v3 = u32x8_permute ((u32x8) v1, mask);
362 /* extract lower 128-bits and save them to the array of buffer indices */
363 u32x4_store_unaligned (u32x8_extract_lo (v2), bi);
364 u32x4_store_unaligned (u32x8_extract_lo (v3), bi + 4);
372 /* equivalent non-nector implementation */
373 bi[0] = vlib_get_buffer_index (vm, ((u8 *) b[0]) + offset);
374 bi[1] = vlib_get_buffer_index (vm, ((u8 *) b[1]) + offset);
375 bi[2] = vlib_get_buffer_index (vm, ((u8 *) b[2]) + offset);
376 bi[3] = vlib_get_buffer_index (vm, ((u8 *) b[3]) + offset);
383 bi[0] = vlib_get_buffer_index (vm, ((u8 *) b[0]) + offset);
390 /** \brief Translate array of buffer pointers into buffer indices
392 @param vm - (vlib_main_t *) vlib main data structure pointer
393 @param b - (vlib_buffer_t **) array of buffer pointers
394 @param bi - (u32 *) array to store buffer indices
395 @param count - (uword) number of elements
397 static_always_inline void
398 vlib_get_buffer_indices (vlib_main_t * vm, vlib_buffer_t ** b, u32 * bi,
401 vlib_get_buffer_indices_with_offset (vm, (void **) b, bi, count, 0);
404 /** \brief Get next buffer in buffer linklist, or zero for end of list.
406 @param vm - (vlib_main_t *) vlib main data structure pointer
407 @param b - (void *) buffer pointer
408 @return - (vlib_buffer_t *) next buffer, or NULL
410 always_inline vlib_buffer_t *
411 vlib_get_next_buffer (vlib_main_t * vm, vlib_buffer_t * b)
413 return (b->flags & VLIB_BUFFER_NEXT_PRESENT
414 ? vlib_get_buffer (vm, b->next_buffer) : 0);
417 uword vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
418 vlib_buffer_t * b_first);
420 /** \brief Get length in bytes of the buffer chain
422 @param vm - (vlib_main_t *) vlib main data structure pointer
423 @param b - (void *) buffer pointer
424 @return - (uword) length of buffer chain
427 vlib_buffer_length_in_chain (vlib_main_t * vm, vlib_buffer_t * b)
429 uword len = b->current_length;
431 if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) == 0))
434 if (PREDICT_TRUE (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID))
435 return len + b->total_length_not_including_first_buffer;
437 return vlib_buffer_length_in_chain_slow_path (vm, b);
440 /** \brief Get length in bytes of the buffer index buffer chain
442 @param vm - (vlib_main_t *) vlib main data structure pointer
443 @param bi - (u32) buffer index
444 @return - (uword) length of buffer chain
447 vlib_buffer_index_length_in_chain (vlib_main_t * vm, u32 bi)
449 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
450 return vlib_buffer_length_in_chain (vm, b);
453 /** \brief Copy buffer contents to memory
455 @param vm - (vlib_main_t *) vlib main data structure pointer
456 @param buffer_index - (u32) buffer index
457 @param contents - (u8 *) memory, <strong>must be large enough</strong>
458 @return - (uword) length of buffer chain
461 vlib_buffer_contents (vlib_main_t * vm, u32 buffer_index, u8 * contents)
463 uword content_len = 0;
469 b = vlib_get_buffer (vm, buffer_index);
470 l = b->current_length;
471 clib_memcpy_fast (contents + content_len, b->data + b->current_data, l);
473 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
475 buffer_index = b->next_buffer;
482 vlib_buffer_get_pa (vlib_main_t * vm, vlib_buffer_t * b)
484 return vlib_physmem_get_pa (vm, b->data);
488 vlib_buffer_get_current_pa (vlib_main_t * vm, vlib_buffer_t * b)
490 return vlib_buffer_get_pa (vm, b) + b->current_data;
493 /** \brief Prefetch buffer metadata by buffer index
494 The first 64 bytes of buffer contains most header information
496 @param vm - (vlib_main_t *) vlib main data structure pointer
497 @param bi - (u32) buffer index
498 @param type - LOAD, STORE. In most cases, STORE is the right answer
500 /* Prefetch buffer header given index. */
501 #define vlib_prefetch_buffer_with_index(vm,bi,type) \
503 vlib_buffer_t * _b = vlib_get_buffer (vm, bi); \
504 vlib_prefetch_buffer_header (_b, type); \
509 /* Index is unknown. */
512 /* Index is known and free/allocated. */
513 VLIB_BUFFER_KNOWN_FREE,
514 VLIB_BUFFER_KNOWN_ALLOCATED,
515 } vlib_buffer_known_state_t;
517 void vlib_buffer_validate_alloc_free (vlib_main_t * vm, u32 * buffers,
519 vlib_buffer_known_state_t
522 always_inline vlib_buffer_known_state_t
523 vlib_buffer_is_known (vlib_main_t * vm, u32 buffer_index)
525 vlib_buffer_main_t *bm = vm->buffer_main;
527 clib_spinlock_lock (&bm->buffer_known_hash_lockp);
528 uword *p = hash_get (bm->buffer_known_hash, buffer_index);
529 clib_spinlock_unlock (&bm->buffer_known_hash_lockp);
530 return p ? p[0] : VLIB_BUFFER_UNKNOWN;
533 /* Validates sanity of a single buffer.
534 Returns format'ed vector with error message if any. */
535 u8 *vlib_validate_buffer (vlib_main_t * vm, u32 buffer_index,
538 u8 *vlib_validate_buffers (vlib_main_t * vm,
540 uword next_buffer_stride,
542 vlib_buffer_known_state_t known_state,
543 uword follow_buffer_next);
545 static_always_inline vlib_buffer_pool_t *
546 vlib_get_buffer_pool (vlib_main_t * vm, u8 buffer_pool_index)
548 vlib_buffer_main_t *bm = vm->buffer_main;
549 return vec_elt_at_index (bm->buffer_pools, buffer_pool_index);
552 static_always_inline __clib_warn_unused_result uword
553 vlib_buffer_pool_get (vlib_main_t * vm, u8 buffer_pool_index, u32 * buffers,
556 vlib_buffer_pool_t *bp = vlib_get_buffer_pool (vm, buffer_pool_index);
559 ASSERT (bp->buffers);
561 clib_spinlock_lock (&bp->lock);
563 if (PREDICT_TRUE (n_buffers < len))
566 vlib_buffer_copy_indices (buffers, bp->buffers + len, n_buffers);
568 clib_spinlock_unlock (&bp->lock);
573 vlib_buffer_copy_indices (buffers, bp->buffers, len);
575 clib_spinlock_unlock (&bp->lock);
581 /** \brief Allocate buffers from specific pool into supplied array
583 @param vm - (vlib_main_t *) vlib main data structure pointer
584 @param buffers - (u32 * ) buffer index array
585 @param n_buffers - (u32) number of buffers requested
586 @return - (u32) number of buffers actually allocated, may be
587 less than the number requested or zero
590 always_inline __clib_warn_unused_result u32
591 vlib_buffer_alloc_from_pool (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
592 u8 buffer_pool_index)
594 vlib_buffer_main_t *bm = vm->buffer_main;
595 vlib_buffer_pool_t *bp;
596 vlib_buffer_pool_thread_t *bpt;
597 u32 *src, *dst, len, n_left;
599 /* If buffer allocation fault injection is configured */
600 if (VLIB_BUFFER_ALLOC_FAULT_INJECTOR > 0)
602 u32 vlib_buffer_alloc_may_fail (vlib_main_t *, u32);
604 /* See how many buffers we're willing to allocate */
605 n_buffers = vlib_buffer_alloc_may_fail (vm, n_buffers);
610 bp = vec_elt_at_index (bm->buffer_pools, buffer_pool_index);
611 bpt = vec_elt_at_index (bp->threads, vm->thread_index);
617 /* per-thread cache contains enough buffers */
618 if (len >= n_buffers)
620 src = bpt->cached_buffers + len - n_buffers;
621 vlib_buffer_copy_indices (dst, src, n_buffers);
622 bpt->n_cached -= n_buffers;
625 vlib_buffer_validate_alloc_free (vm, buffers, n_buffers,
626 VLIB_BUFFER_KNOWN_FREE);
630 /* alloc bigger than cache - take buffers directly from main pool */
631 if (n_buffers >= VLIB_BUFFER_POOL_PER_THREAD_CACHE_SZ)
633 n_buffers = vlib_buffer_pool_get (vm, buffer_pool_index, buffers,
637 vlib_buffer_validate_alloc_free (vm, buffers, n_buffers,
638 VLIB_BUFFER_KNOWN_FREE);
642 /* take everything available in the cache */
645 vlib_buffer_copy_indices (dst, bpt->cached_buffers, len);
651 len = round_pow2 (n_left, 32);
652 len = vlib_buffer_pool_get (vm, buffer_pool_index, bpt->cached_buffers,
658 u32 n_copy = clib_min (len, n_left);
659 src = bpt->cached_buffers + len - n_copy;
660 vlib_buffer_copy_indices (dst, src, n_copy);
661 bpt->n_cached -= n_copy;
667 /* Verify that buffers are known free. */
669 vlib_buffer_validate_alloc_free (vm, buffers, n_buffers,
670 VLIB_BUFFER_KNOWN_FREE);
675 /** \brief Allocate buffers from specific numa node into supplied array
677 @param vm - (vlib_main_t *) vlib main data structure pointer
678 @param buffers - (u32 * ) buffer index array
679 @param n_buffers - (u32) number of buffers requested
680 @param numa_node - (u32) numa node
681 @return - (u32) number of buffers actually allocated, may be
682 less than the number requested or zero
684 always_inline __clib_warn_unused_result u32
685 vlib_buffer_alloc_on_numa (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
688 u8 index = vlib_buffer_pool_get_default_for_numa (vm, numa_node);
689 return vlib_buffer_alloc_from_pool (vm, buffers, n_buffers, index);
692 /** \brief Allocate buffers into supplied array
694 @param vm - (vlib_main_t *) vlib main data structure pointer
695 @param buffers - (u32 * ) buffer index array
696 @param n_buffers - (u32) number of buffers requested
697 @return - (u32) number of buffers actually allocated, may be
698 less than the number requested or zero
701 always_inline __clib_warn_unused_result u32
702 vlib_buffer_alloc (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
704 return vlib_buffer_alloc_on_numa (vm, buffers, n_buffers, vm->numa_node);
707 /** \brief Allocate buffers into ring
709 @param vm - (vlib_main_t *) vlib main data structure pointer
710 @param buffers - (u32 * ) buffer index ring
711 @param start - (u32) first slot in the ring
712 @param ring_size - (u32) ring size
713 @param n_buffers - (u32) number of buffers requested
714 @return - (u32) number of buffers actually allocated, may be
715 less than the number requested or zero
717 always_inline __clib_warn_unused_result u32
718 vlib_buffer_alloc_to_ring (vlib_main_t * vm, u32 * ring, u32 start,
719 u32 ring_size, u32 n_buffers)
723 ASSERT (n_buffers <= ring_size);
725 if (PREDICT_TRUE (start + n_buffers <= ring_size))
726 return vlib_buffer_alloc (vm, ring + start, n_buffers);
728 n_alloc = vlib_buffer_alloc (vm, ring + start, ring_size - start);
730 if (PREDICT_TRUE (n_alloc == ring_size - start))
731 n_alloc += vlib_buffer_alloc (vm, ring, n_buffers - n_alloc);
736 /** \brief Allocate buffers into ring from specific buffer pool
738 @param vm - (vlib_main_t *) vlib main data structure pointer
739 @param buffers - (u32 * ) buffer index ring
740 @param start - (u32) first slot in the ring
741 @param ring_size - (u32) ring size
742 @param n_buffers - (u32) number of buffers requested
743 @return - (u32) number of buffers actually allocated, may be
744 less than the number requested or zero
746 always_inline __clib_warn_unused_result u32
747 vlib_buffer_alloc_to_ring_from_pool (vlib_main_t * vm, u32 * ring, u32 start,
748 u32 ring_size, u32 n_buffers,
749 u8 buffer_pool_index)
753 ASSERT (n_buffers <= ring_size);
755 if (PREDICT_TRUE (start + n_buffers <= ring_size))
756 return vlib_buffer_alloc_from_pool (vm, ring + start, n_buffers,
759 n_alloc = vlib_buffer_alloc_from_pool (vm, ring + start, ring_size - start,
762 if (PREDICT_TRUE (n_alloc == ring_size - start))
763 n_alloc += vlib_buffer_alloc_from_pool (vm, ring, n_buffers - n_alloc,
769 static_always_inline void
770 vlib_buffer_pool_put (vlib_main_t * vm, u8 buffer_pool_index,
771 u32 * buffers, u32 n_buffers)
773 vlib_buffer_pool_t *bp = vlib_get_buffer_pool (vm, buffer_pool_index);
774 vlib_buffer_pool_thread_t *bpt = vec_elt_at_index (bp->threads,
776 u32 n_cached, n_empty;
779 vlib_buffer_validate_alloc_free (vm, buffers, n_buffers,
780 VLIB_BUFFER_KNOWN_ALLOCATED);
782 n_cached = bpt->n_cached;
783 n_empty = VLIB_BUFFER_POOL_PER_THREAD_CACHE_SZ - n_cached;
784 if (n_buffers <= n_empty)
786 vlib_buffer_copy_indices (bpt->cached_buffers + n_cached,
788 bpt->n_cached = n_cached + n_buffers;
792 vlib_buffer_copy_indices (bpt->cached_buffers + n_cached,
793 buffers + n_buffers - n_empty, n_empty);
794 bpt->n_cached = VLIB_BUFFER_POOL_PER_THREAD_CACHE_SZ;
796 clib_spinlock_lock (&bp->lock);
797 vlib_buffer_copy_indices (bp->buffers + bp->n_avail, buffers,
798 n_buffers - n_empty);
799 bp->n_avail += n_buffers - n_empty;
800 clib_spinlock_unlock (&bp->lock);
803 static_always_inline void
804 vlib_buffer_free_inline (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
807 const int queue_size = 128;
808 vlib_buffer_pool_t *bp = 0;
809 u8 buffer_pool_index = ~0;
810 u32 n_queue = 0, queue[queue_size + 4];
811 vlib_buffer_t bt = { };
812 #if defined(CLIB_HAVE_VEC128)
813 vlib_buffer_t bpi_mask = {.buffer_pool_index = ~0 };
814 vlib_buffer_t bpi_vec = {};
815 vlib_buffer_t flags_refs_mask = {
816 .flags = VLIB_BUFFER_NEXT_PRESENT,
821 if (PREDICT_FALSE (n_buffers == 0))
824 vlib_buffer_t *b = vlib_get_buffer (vm, buffers[0]);
825 buffer_pool_index = b->buffer_pool_index;
826 bp = vlib_get_buffer_pool (vm, buffer_pool_index);
827 vlib_buffer_copy_template (&bt, &bp->buffer_template);
828 #if defined(CLIB_HAVE_VEC128)
829 bpi_vec.buffer_pool_index = buffer_pool_index;
835 u32 bi, sum = 0, flags, next;
840 vlib_get_buffers (vm, buffers, b, 4);
844 vlib_get_buffers (vm, buffers + 8, b + 4, 4);
845 vlib_prefetch_buffer_header (b[4], LOAD);
846 vlib_prefetch_buffer_header (b[5], LOAD);
847 vlib_prefetch_buffer_header (b[6], LOAD);
848 vlib_prefetch_buffer_header (b[7], LOAD);
851 #if defined(CLIB_HAVE_VEC128)
852 u8x16 p0, p1, p2, p3, r;
853 p0 = u8x16_load_unaligned (b[0]);
854 p1 = u8x16_load_unaligned (b[1]);
855 p2 = u8x16_load_unaligned (b[2]);
856 p3 = u8x16_load_unaligned (b[3]);
858 r = p0 ^ bpi_vec.as_u8x16[0];
859 r |= p1 ^ bpi_vec.as_u8x16[0];
860 r |= p2 ^ bpi_vec.as_u8x16[0];
861 r |= p3 ^ bpi_vec.as_u8x16[0];
862 r &= bpi_mask.as_u8x16[0];
863 r |= (p0 | p1 | p2 | p3) & flags_refs_mask.as_u8x16[0];
865 sum = !u8x16_is_all_zero (r);
871 sum &= VLIB_BUFFER_NEXT_PRESENT;
872 sum += b[0]->ref_count - 1;
873 sum += b[1]->ref_count - 1;
874 sum += b[2]->ref_count - 1;
875 sum += b[3]->ref_count - 1;
876 sum |= b[0]->buffer_pool_index ^ buffer_pool_index;
877 sum |= b[1]->buffer_pool_index ^ buffer_pool_index;
878 sum |= b[2]->buffer_pool_index ^ buffer_pool_index;
879 sum |= b[3]->buffer_pool_index ^ buffer_pool_index;
885 vlib_buffer_copy_indices (queue + n_queue, buffers, 4);
886 vlib_buffer_copy_template (b[0], &bt);
887 vlib_buffer_copy_template (b[1], &bt);
888 vlib_buffer_copy_template (b[2], &bt);
889 vlib_buffer_copy_template (b[3], &bt);
892 vlib_buffer_validate (vm, b[0]);
893 vlib_buffer_validate (vm, b[1]);
894 vlib_buffer_validate (vm, b[2]);
895 vlib_buffer_validate (vm, b[3]);
897 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
898 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[1]);
899 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[2]);
900 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[3]);
902 if (n_queue >= queue_size)
904 vlib_buffer_pool_put (vm, buffer_pool_index, queue, n_queue);
915 b[0] = vlib_get_buffer (vm, bi);
917 next = b[0]->next_buffer;
919 if (PREDICT_FALSE (buffer_pool_index != b[0]->buffer_pool_index))
924 vlib_buffer_pool_put (vm, buffer_pool_index, queue, n_queue);
928 buffer_pool_index = b[0]->buffer_pool_index;
929 #if defined(CLIB_HAVE_VEC128)
930 bpi_vec.buffer_pool_index = buffer_pool_index;
932 bp = vlib_get_buffer_pool (vm, buffer_pool_index);
933 vlib_buffer_copy_template (&bt, &bp->buffer_template);
936 vlib_buffer_validate (vm, b[0]);
938 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b[0]);
940 if (clib_atomic_sub_fetch (&b[0]->ref_count, 1) == 0)
942 vlib_buffer_copy_template (b[0], &bt);
943 queue[n_queue++] = bi;
946 if (n_queue == queue_size)
948 vlib_buffer_pool_put (vm, buffer_pool_index, queue, queue_size);
952 if (maybe_next && (flags & VLIB_BUFFER_NEXT_PRESENT))
963 vlib_buffer_pool_put (vm, buffer_pool_index, queue, n_queue);
967 /** \brief Free buffers
968 Frees the entire buffer chain for each buffer
970 @param vm - (vlib_main_t *) vlib main data structure pointer
971 @param buffers - (u32 * ) buffer index array
972 @param n_buffers - (u32) number of buffers to free
976 vlib_buffer_free (vlib_main_t * vm,
977 /* pointer to first buffer */
979 /* number of buffers to free */
982 vlib_buffer_free_inline (vm, buffers, n_buffers, /* maybe next */ 1);
985 /** \brief Free buffers, does not free the buffer chain for each buffer
987 @param vm - (vlib_main_t *) vlib main data structure pointer
988 @param buffers - (u32 * ) buffer index array
989 @param n_buffers - (u32) number of buffers to free
993 vlib_buffer_free_no_next (vlib_main_t * vm,
994 /* pointer to first buffer */
996 /* number of buffers to free */
999 vlib_buffer_free_inline (vm, buffers, n_buffers, /* maybe next */ 0);
1002 /** \brief Free one buffer
1003 Shorthand to free a single buffer chain.
1005 @param vm - (vlib_main_t *) vlib main data structure pointer
1006 @param buffer_index - (u32) buffer index to free
1009 vlib_buffer_free_one (vlib_main_t * vm, u32 buffer_index)
1011 vlib_buffer_free_inline (vm, &buffer_index, 1, /* maybe next */ 1);
1014 /** \brief Free buffers from ring
1016 @param vm - (vlib_main_t *) vlib main data structure pointer
1017 @param buffers - (u32 * ) buffer index ring
1018 @param start - (u32) first slot in the ring
1019 @param ring_size - (u32) ring size
1020 @param n_buffers - (u32) number of buffers
1023 vlib_buffer_free_from_ring (vlib_main_t * vm, u32 * ring, u32 start,
1024 u32 ring_size, u32 n_buffers)
1026 ASSERT (n_buffers <= ring_size);
1028 if (PREDICT_TRUE (start + n_buffers <= ring_size))
1030 vlib_buffer_free (vm, ring + start, n_buffers);
1034 vlib_buffer_free (vm, ring + start, ring_size - start);
1035 vlib_buffer_free (vm, ring, n_buffers - (ring_size - start));
1039 /** \brief Free buffers from ring without freeing tail buffers
1041 @param vm - (vlib_main_t *) vlib main data structure pointer
1042 @param buffers - (u32 * ) buffer index ring
1043 @param start - (u32) first slot in the ring
1044 @param ring_size - (u32) ring size
1045 @param n_buffers - (u32) number of buffers
1048 vlib_buffer_free_from_ring_no_next (vlib_main_t * vm, u32 * ring, u32 start,
1049 u32 ring_size, u32 n_buffers)
1051 ASSERT (n_buffers <= ring_size);
1053 if (PREDICT_TRUE (start + n_buffers <= ring_size))
1055 vlib_buffer_free_no_next (vm, ring + start, n_buffers);
1059 vlib_buffer_free_no_next (vm, ring + start, ring_size - start);
1060 vlib_buffer_free_no_next (vm, ring, n_buffers - (ring_size - start));
1064 /* Append given data to end of buffer, possibly allocating new buffers. */
1065 int vlib_buffer_add_data (vlib_main_t * vm, u32 * buffer_index, void *data,
1068 /* Define vlib_buffer and vnet_buffer flags bits preserved for copy/clone */
1069 #define VLIB_BUFFER_COPY_CLONE_FLAGS_MASK \
1070 (VLIB_BUFFER_NEXT_PRESENT | VLIB_BUFFER_TOTAL_LENGTH_VALID | \
1071 VLIB_BUFFER_IS_TRACED | ~VLIB_BUFFER_FLAGS_ALL)
1073 /* duplicate all buffers in chain */
1074 always_inline vlib_buffer_t *
1075 vlib_buffer_copy (vlib_main_t * vm, vlib_buffer_t * b)
1077 vlib_buffer_t *s, *d, *fd;
1078 uword n_alloc, n_buffers = 1;
1079 u32 flag_mask = VLIB_BUFFER_COPY_CLONE_FLAGS_MASK;
1083 while (s->flags & VLIB_BUFFER_NEXT_PRESENT)
1086 s = vlib_get_buffer (vm, s->next_buffer);
1088 u32 new_buffers[n_buffers];
1090 n_alloc = vlib_buffer_alloc (vm, new_buffers, n_buffers);
1092 /* No guarantee that we'll get all the buffers we asked for */
1093 if (PREDICT_FALSE (n_alloc < n_buffers))
1096 vlib_buffer_free (vm, new_buffers, n_alloc);
1102 fd = d = vlib_get_buffer (vm, new_buffers[0]);
1103 d->current_data = s->current_data;
1104 d->current_length = s->current_length;
1105 d->flags = s->flags & flag_mask;
1106 d->trace_handle = s->trace_handle;
1107 d->total_length_not_including_first_buffer =
1108 s->total_length_not_including_first_buffer;
1109 clib_memcpy_fast (d->opaque, s->opaque, sizeof (s->opaque));
1110 clib_memcpy_fast (d->opaque2, s->opaque2, sizeof (s->opaque2));
1111 clib_memcpy_fast (vlib_buffer_get_current (d),
1112 vlib_buffer_get_current (s), s->current_length);
1115 for (i = 1; i < n_buffers; i++)
1118 d->next_buffer = new_buffers[i];
1120 s = vlib_get_buffer (vm, s->next_buffer);
1121 d = vlib_get_buffer (vm, new_buffers[i]);
1122 d->current_data = s->current_data;
1123 d->current_length = s->current_length;
1124 clib_memcpy_fast (vlib_buffer_get_current (d),
1125 vlib_buffer_get_current (s), s->current_length);
1126 d->flags = s->flags & flag_mask;
1132 /* duplicate first buffer in chain */
1133 always_inline vlib_buffer_t *
1134 vlib_buffer_copy_no_chain (vlib_main_t * vm, vlib_buffer_t * b, u32 * di)
1138 if ((vlib_buffer_alloc (vm, di, 1)) != 1)
1141 d = vlib_get_buffer (vm, *di);
1143 d->current_data = b->current_data;
1144 d->current_length = b->current_length;
1145 clib_memcpy_fast (d->opaque, b->opaque, sizeof (b->opaque));
1146 clib_memcpy_fast (d->opaque2, b->opaque2, sizeof (b->opaque2));
1147 clib_memcpy_fast (vlib_buffer_get_current (d),
1148 vlib_buffer_get_current (b), b->current_length);
1153 /* \brief Move packet from current position to offset position in buffer.
1154 Only work for small packet using one buffer with room to fit the move
1155 @param vm - (vlib_main_t *) vlib main data structure pointer
1156 @param b - (vlib_buffer_t *) pointer to buffer
1157 @param offset - (i16) position to move the packet in buffer
1160 vlib_buffer_move (vlib_main_t * vm, vlib_buffer_t * b, i16 offset)
1162 ASSERT ((b->flags & VLIB_BUFFER_NEXT_PRESENT) == 0);
1163 ASSERT (offset + VLIB_BUFFER_PRE_DATA_SIZE >= 0);
1164 ASSERT (offset + b->current_length <
1165 vlib_buffer_get_default_data_size (vm));
1167 u8 *source = vlib_buffer_get_current (b);
1168 b->current_data = offset;
1169 u8 *destination = vlib_buffer_get_current (b);
1170 u16 length = b->current_length;
1172 if (source + length <= destination) /* no overlap */
1173 clib_memcpy_fast (destination, source, length);
1175 memmove (destination, source, length);
1178 /** \brief Create a maximum of 256 clones of buffer and store them
1179 in the supplied array
1181 @param vm - (vlib_main_t *) vlib main data structure pointer
1182 @param src_buffer - (u32) source buffer index
1183 @param buffers - (u32 * ) buffer index array
1184 @param n_buffers - (u16) number of buffer clones requested (<=256)
1185 @param head_end_offset - (u16) offset relative to current position
1186 where packet head ends
1187 @param offset - (i16) copy packet head at current position if 0,
1188 else at offset position to change headroom space as specified
1189 @return - (u16) number of buffers actually cloned, may be
1190 less than the number requested or zero
1193 vlib_buffer_clone_256 (vlib_main_t * vm, u32 src_buffer, u32 * buffers,
1194 u16 n_buffers, u16 head_end_offset, i16 offset)
1197 vlib_buffer_t *s = vlib_get_buffer (vm, src_buffer);
1199 ASSERT (s->ref_count == 1);
1201 ASSERT (n_buffers <= 256);
1202 ASSERT (offset + VLIB_BUFFER_PRE_DATA_SIZE >= 0);
1203 ASSERT ((offset + head_end_offset) <
1204 vlib_buffer_get_default_data_size (vm));
1206 if (s->current_length <= head_end_offset + CLIB_CACHE_LINE_BYTES * 2)
1208 buffers[0] = src_buffer;
1210 vlib_buffer_move (vm, s, offset);
1212 for (i = 1; i < n_buffers; i++)
1215 d = vlib_buffer_copy (vm, s);
1218 buffers[i] = vlib_get_buffer_index (vm, d);
1224 if (PREDICT_FALSE ((n_buffers == 1) && (offset == 0)))
1226 buffers[0] = src_buffer;
1230 n_buffers = vlib_buffer_alloc_from_pool (vm, buffers, n_buffers,
1231 s->buffer_pool_index);
1233 for (i = 0; i < n_buffers; i++)
1235 vlib_buffer_t *d = vlib_get_buffer (vm, buffers[i]);
1237 d->current_data = offset;
1239 d->current_data = s->current_data;
1241 d->current_length = head_end_offset;
1242 ASSERT (d->buffer_pool_index == s->buffer_pool_index);
1244 d->total_length_not_including_first_buffer = s->current_length -
1246 if (PREDICT_FALSE (s->flags & VLIB_BUFFER_NEXT_PRESENT))
1248 d->total_length_not_including_first_buffer +=
1249 s->total_length_not_including_first_buffer;
1251 d->flags = (s->flags & VLIB_BUFFER_COPY_CLONE_FLAGS_MASK) |
1252 VLIB_BUFFER_NEXT_PRESENT;
1253 d->trace_handle = s->trace_handle;
1254 clib_memcpy_fast (d->opaque, s->opaque, sizeof (s->opaque));
1255 clib_memcpy_fast (d->opaque2, s->opaque2, sizeof (s->opaque2));
1256 clib_memcpy_fast (vlib_buffer_get_current (d),
1257 vlib_buffer_get_current (s), head_end_offset);
1258 d->next_buffer = src_buffer;
1260 vlib_buffer_advance (s, head_end_offset);
1261 s->ref_count = n_buffers ? n_buffers : s->ref_count;
1262 while (s->flags & VLIB_BUFFER_NEXT_PRESENT)
1264 s = vlib_get_buffer (vm, s->next_buffer);
1265 s->ref_count = n_buffers ? n_buffers : s->ref_count;
1271 /** \brief Create multiple clones of buffer and store them
1272 in the supplied array
1274 @param vm - (vlib_main_t *) vlib main data structure pointer
1275 @param src_buffer - (u32) source buffer index
1276 @param buffers - (u32 * ) buffer index array
1277 @param n_buffers - (u16) number of buffer clones requested (<=256)
1278 @param head_end_offset - (u16) offset relative to current position
1279 where packet head ends
1280 @param offset - (i16) copy packet head at current position if 0,
1281 else at offset position to change headroom space as specified
1282 @return - (u16) number of buffers actually cloned, may be
1283 less than the number requested or zero
1286 vlib_buffer_clone_at_offset (vlib_main_t * vm, u32 src_buffer, u32 * buffers,
1287 u16 n_buffers, u16 head_end_offset, i16 offset)
1289 vlib_buffer_t *s = vlib_get_buffer (vm, src_buffer);
1292 while (n_buffers > 256)
1294 vlib_buffer_t *copy;
1295 copy = vlib_buffer_copy (vm, s);
1296 n_cloned += vlib_buffer_clone_256 (vm,
1297 vlib_get_buffer_index (vm, copy),
1298 (buffers + n_cloned),
1299 256, head_end_offset, offset);
1302 n_cloned += vlib_buffer_clone_256 (vm, src_buffer,
1304 n_buffers, head_end_offset, offset);
1309 /** \brief Create multiple clones of buffer and store them
1310 in the supplied array
1312 @param vm - (vlib_main_t *) vlib main data structure pointer
1313 @param src_buffer - (u32) source buffer index
1314 @param buffers - (u32 * ) buffer index array
1315 @param n_buffers - (u16) number of buffer clones requested (<=256)
1316 @param head_end_offset - (u16) offset relative to current position
1317 where packet head ends
1318 @return - (u16) number of buffers actually cloned, may be
1319 less than the number requested or zero
1322 vlib_buffer_clone (vlib_main_t * vm, u32 src_buffer, u32 * buffers,
1323 u16 n_buffers, u16 head_end_offset)
1325 return vlib_buffer_clone_at_offset (vm, src_buffer, buffers, n_buffers,
1326 head_end_offset, 0);
1329 /** \brief Attach cloned tail to the buffer
1331 @param vm - (vlib_main_t *) vlib main data structure pointer
1332 @param head - (vlib_buffer_t *) head buffer
1333 @param tail - (Vlib buffer_t *) tail buffer to clone and attach to head
1337 vlib_buffer_attach_clone (vlib_main_t * vm, vlib_buffer_t * head,
1338 vlib_buffer_t * tail)
1340 ASSERT ((head->flags & VLIB_BUFFER_NEXT_PRESENT) == 0);
1341 ASSERT (head->buffer_pool_index == tail->buffer_pool_index);
1343 head->flags |= VLIB_BUFFER_NEXT_PRESENT;
1344 head->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
1345 head->flags &= ~VLIB_BUFFER_EXT_HDR_VALID;
1346 head->flags |= (tail->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID);
1347 head->next_buffer = vlib_get_buffer_index (vm, tail);
1348 head->total_length_not_including_first_buffer = tail->current_length +
1349 tail->total_length_not_including_first_buffer;
1352 clib_atomic_add_fetch (&tail->ref_count, 1);
1354 if (tail->flags & VLIB_BUFFER_NEXT_PRESENT)
1356 tail = vlib_get_buffer (vm, tail->next_buffer);
1361 /* Initializes the buffer as an empty packet with no chained buffers. */
1363 vlib_buffer_chain_init (vlib_buffer_t * first)
1365 first->total_length_not_including_first_buffer = 0;
1366 first->current_length = 0;
1367 first->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
1368 first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
1371 /* The provided next_bi buffer index is appended to the end of the packet. */
1372 always_inline vlib_buffer_t *
1373 vlib_buffer_chain_buffer (vlib_main_t * vm, vlib_buffer_t * last, u32 next_bi)
1375 vlib_buffer_t *next_buffer = vlib_get_buffer (vm, next_bi);
1376 last->next_buffer = next_bi;
1377 last->flags |= VLIB_BUFFER_NEXT_PRESENT;
1378 next_buffer->current_length = 0;
1379 next_buffer->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
1383 /* Increases or decreases the packet length.
1384 * It does not allocate or deallocate new buffers.
1385 * Therefore, the added length must be compatible
1386 * with the last buffer. */
1388 vlib_buffer_chain_increase_length (vlib_buffer_t * first,
1389 vlib_buffer_t * last, i32 len)
1391 last->current_length += len;
1393 first->total_length_not_including_first_buffer += len;
1396 /* Copy data to the end of the packet and increases its length.
1397 * It does not allocate new buffers.
1398 * Returns the number of copied bytes. */
1400 vlib_buffer_chain_append_data (vlib_main_t * vm,
1401 vlib_buffer_t * first,
1402 vlib_buffer_t * last, void *data, u16 data_len)
1404 u32 n_buffer_bytes = vlib_buffer_get_default_data_size (vm);
1405 ASSERT (n_buffer_bytes >= last->current_length + last->current_data);
1406 u16 len = clib_min (data_len,
1407 n_buffer_bytes - last->current_length -
1408 last->current_data);
1409 clib_memcpy_fast (vlib_buffer_get_current (last) + last->current_length,
1411 vlib_buffer_chain_increase_length (first, last, len);
1415 /* Copy data to the end of the packet and increases its length.
1416 * Allocates additional buffers from the free list if necessary.
1417 * Returns the number of copied bytes.
1418 * 'last' value is modified whenever new buffers are allocated and
1419 * chained and points to the last buffer in the chain. */
1421 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
1422 vlib_buffer_t * first,
1423 vlib_buffer_t ** last, void *data,
1425 void vlib_buffer_chain_validate (vlib_main_t * vm, vlib_buffer_t * first);
1427 format_function_t format_vlib_buffer, format_vlib_buffer_and_data,
1428 format_vlib_buffer_contents, format_vlib_buffer_no_chain;
1432 /* Vector of packet data. */
1435 /* Number of buffers to allocate in each call to allocator. */
1436 u32 min_n_buffers_each_alloc;
1439 } vlib_packet_template_t;
1441 void vlib_packet_template_init (vlib_main_t * vm,
1442 vlib_packet_template_t * t,
1444 uword n_packet_data_bytes,
1445 uword min_n_buffers_each_alloc,
1448 void *vlib_packet_template_get_packet (vlib_main_t * vm,
1449 vlib_packet_template_t * t,
1453 vlib_packet_template_free (vlib_main_t * vm, vlib_packet_template_t * t)
1455 vec_free (t->packet_data);
1459 vlib_buffer_space_left_at_end (vlib_main_t * vm, vlib_buffer_t * b)
1461 return b->data + vlib_buffer_get_default_data_size (vm) -
1462 ((u8 *) vlib_buffer_get_current (b) + b->current_length);
1466 vlib_buffer_chain_linearize (vlib_main_t * vm, vlib_buffer_t * b)
1468 vlib_buffer_t *db = b, *sb, *first = b;
1470 u32 bytes_left = 0, data_size;
1471 u16 src_left, dst_left, n_buffers = 1;
1475 if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) == 0))
1478 data_size = vlib_buffer_get_default_data_size (vm);
1480 dst_left = vlib_buffer_space_left_at_end (vm, b);
1482 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1484 b = vlib_get_buffer (vm, b->next_buffer);
1485 if (b->ref_count > 1)
1487 bytes_left += b->current_length;
1491 /* if buffer is cloned, create completely new chain - unless everything fits
1492 * into one buffer */
1493 if (is_cloned && bytes_left >= dst_left)
1496 u32 space_needed = bytes_left - dst_left;
1499 if (vlib_buffer_alloc (vm, &tail, 1) == 0)
1504 b = vlib_get_buffer (vm, tail);
1506 while (len < space_needed)
1509 if (vlib_buffer_alloc (vm, &bi, 1) == 0)
1511 vlib_buffer_free_one (vm, tail);
1514 b->flags = VLIB_BUFFER_NEXT_PRESENT;
1515 b->next_buffer = bi;
1516 b = vlib_get_buffer (vm, bi);
1520 sb = vlib_get_buffer (vm, first->next_buffer);
1521 to_free = first->next_buffer;
1522 first->next_buffer = tail;
1525 sb = vlib_get_buffer (vm, first->next_buffer);
1527 src_left = sb->current_length;
1528 sp = vlib_buffer_get_current (sb);
1529 dp = vlib_buffer_get_tail (db);
1537 db->current_length = dp - (u8 *) vlib_buffer_get_current (db);
1538 ASSERT (db->flags & VLIB_BUFFER_NEXT_PRESENT);
1539 db = vlib_get_buffer (vm, db->next_buffer);
1540 dst_left = data_size;
1541 if (db->current_data > 0)
1543 db->current_data = 0;
1547 dst_left += -db->current_data;
1549 dp = vlib_buffer_get_current (db);
1552 while (src_left == 0)
1554 ASSERT (sb->flags & VLIB_BUFFER_NEXT_PRESENT);
1555 sb = vlib_get_buffer (vm, sb->next_buffer);
1556 src_left = sb->current_length;
1557 sp = vlib_buffer_get_current (sb);
1560 bytes_to_copy = clib_min (dst_left, src_left);
1565 bytes_to_copy = clib_min (bytes_to_copy, sp - dp);
1567 clib_memcpy_fast (dp, sp, bytes_to_copy);
1570 src_left -= bytes_to_copy;
1571 dst_left -= bytes_to_copy;
1572 dp += bytes_to_copy;
1573 sp += bytes_to_copy;
1574 bytes_left -= bytes_to_copy;
1577 db->current_data = 0;
1578 db->current_length = dp - (u8 *) vlib_buffer_get_current (db);
1580 if (is_cloned && to_free)
1581 vlib_buffer_free_one (vm, to_free);
1584 if (db->flags & VLIB_BUFFER_NEXT_PRESENT)
1585 vlib_buffer_free_one (vm, db->next_buffer);
1586 db->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
1589 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
1591 b = vlib_get_buffer (vm, b->next_buffer);
1596 first->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
1601 #endif /* included_vlib_buffer_funcs_h */
1604 * fd.io coding-style-patch-verification: ON
1607 * eval: (c-set-style "gnu")