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>
46 vlib buffer access methods.
50 /** \brief Translate buffer index into buffer pointer
52 @param vm - (vlib_main_t *) vlib main data structure pointer
53 @param buffer_index - (u32) buffer index
54 @return - (vlib_buffer_t *) buffer pointer
56 always_inline vlib_buffer_t *
57 vlib_get_buffer (vlib_main_t * vm, u32 buffer_index)
59 vlib_buffer_main_t *bm = vm->buffer_main;
60 uword offset = ((uword) buffer_index) << CLIB_LOG2_CACHE_LINE_BYTES;
61 ASSERT (offset < bm->buffer_mem_size);
63 return uword_to_pointer (bm->buffer_mem_start + offset, void *);
66 /** \brief Translate buffer pointer into buffer index
68 @param vm - (vlib_main_t *) vlib main data structure pointer
69 @param p - (void *) buffer pointer
70 @return - (u32) buffer index
74 vlib_get_buffer_index (vlib_main_t * vm, void *p)
76 vlib_buffer_main_t *bm = vm->buffer_main;
77 uword offset = pointer_to_uword (p) - bm->buffer_mem_start;
78 ASSERT (pointer_to_uword (p) >= bm->buffer_mem_start);
79 ASSERT (offset < bm->buffer_mem_size);
80 ASSERT ((offset % (1 << CLIB_LOG2_CACHE_LINE_BYTES)) == 0);
81 return offset >> CLIB_LOG2_CACHE_LINE_BYTES;
84 /** \brief Get next buffer in buffer linklist, or zero for end of list.
86 @param vm - (vlib_main_t *) vlib main data structure pointer
87 @param b - (void *) buffer pointer
88 @return - (vlib_buffer_t *) next buffer, or NULL
90 always_inline vlib_buffer_t *
91 vlib_get_next_buffer (vlib_main_t * vm, vlib_buffer_t * b)
93 return (b->flags & VLIB_BUFFER_NEXT_PRESENT
94 ? vlib_get_buffer (vm, b->next_buffer) : 0);
97 uword vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
98 vlib_buffer_t * b_first);
100 /** \brief Get length in bytes of the buffer chain
102 @param vm - (vlib_main_t *) vlib main data structure pointer
103 @param b - (void *) buffer pointer
104 @return - (uword) length of buffer chain
107 vlib_buffer_length_in_chain (vlib_main_t * vm, vlib_buffer_t * b)
109 uword len = b->current_length;
111 if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_NEXT_PRESENT) == 0))
114 if (PREDICT_TRUE (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID))
115 return len + b->total_length_not_including_first_buffer;
117 return vlib_buffer_length_in_chain_slow_path (vm, b);
120 /** \brief Get length in bytes of the buffer index buffer chain
122 @param vm - (vlib_main_t *) vlib main data structure pointer
123 @param bi - (u32) buffer index
124 @return - (uword) length of buffer chain
127 vlib_buffer_index_length_in_chain (vlib_main_t * vm, u32 bi)
129 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
130 return vlib_buffer_length_in_chain (vm, b);
133 /** \brief Copy buffer contents to memory
135 @param vm - (vlib_main_t *) vlib main data structure pointer
136 @param buffer_index - (u32) buffer index
137 @param contents - (u8 *) memory, <strong>must be large enough</strong>
138 @return - (uword) length of buffer chain
141 vlib_buffer_contents (vlib_main_t * vm, u32 buffer_index, u8 * contents)
143 uword content_len = 0;
149 b = vlib_get_buffer (vm, buffer_index);
150 l = b->current_length;
151 clib_memcpy (contents + content_len, b->data + b->current_data, l);
153 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
155 buffer_index = b->next_buffer;
161 /* Return physical address of buffer->data start. */
163 vlib_get_buffer_data_physical_address (vlib_main_t * vm, u32 buffer_index)
165 vlib_buffer_main_t *bm = vm->buffer_main;
166 vlib_buffer_t *b = vlib_get_buffer (vm, buffer_index);
167 vlib_buffer_pool_t *pool = vec_elt_at_index (bm->buffer_pools,
168 b->buffer_pool_index);
170 return vlib_physmem_virtual_to_physical (vm, pool->physmem_region, b->data);
173 /** \brief Prefetch buffer metadata by buffer index
174 The first 64 bytes of buffer contains most header information
176 @param vm - (vlib_main_t *) vlib main data structure pointer
177 @param bi - (u32) buffer index
178 @param type - LOAD, STORE. In most cases, STORE is the right answer
180 /* Prefetch buffer header given index. */
181 #define vlib_prefetch_buffer_with_index(vm,bi,type) \
183 vlib_buffer_t * _b = vlib_get_buffer (vm, bi); \
184 vlib_prefetch_buffer_header (_b, type); \
188 /* Iterate over known allocated vlib bufs. You probably do not want
190 @param vm the vlib_main_t
191 @param bi found allocated buffer index
192 @param body operation to perform on buffer index
193 function executes body for each allocated buffer index
195 #define vlib_buffer_foreach_allocated(vm,bi,body) \
197 vlib_main_t * _vmain = (vm); \
198 vlib_buffer_main_t * _bmain = &_vmain->buffer_main; \
199 hash_pair_t * _vbpair; \
200 hash_foreach_pair(_vbpair, _bmain->buffer_known_hash, ({ \
201 if (VLIB_BUFFER_KNOWN_ALLOCATED == _vbpair->value[0]) { \
202 (bi) = _vbpair->key; \
211 /* Index is unknown. */
214 /* Index is known and free/allocated. */
215 VLIB_BUFFER_KNOWN_FREE,
216 VLIB_BUFFER_KNOWN_ALLOCATED,
217 } vlib_buffer_known_state_t;
219 void vlib_buffer_validate_alloc_free (vlib_main_t * vm, u32 * buffers,
221 vlib_buffer_known_state_t
224 always_inline vlib_buffer_known_state_t
225 vlib_buffer_is_known (u32 buffer_index)
227 vlib_buffer_main_t *bm = vlib_global_main.buffer_main;
229 clib_spinlock_lock (&bm->buffer_known_hash_lockp);
230 uword *p = hash_get (bm->buffer_known_hash, buffer_index);
231 clib_spinlock_unlock (&bm->buffer_known_hash_lockp);
232 return p ? p[0] : VLIB_BUFFER_UNKNOWN;
236 vlib_buffer_set_known_state (u32 buffer_index,
237 vlib_buffer_known_state_t state)
239 vlib_buffer_main_t *bm = vlib_global_main.buffer_main;
241 clib_spinlock_lock (&bm->buffer_known_hash_lockp);
242 hash_set (bm->buffer_known_hash, buffer_index, state);
243 clib_spinlock_unlock (&bm->buffer_known_hash_lockp);
246 /* Validates sanity of a single buffer.
247 Returns format'ed vector with error message if any. */
248 u8 *vlib_validate_buffer (vlib_main_t * vm, u32 buffer_index,
252 vlib_buffer_round_size (u32 size)
254 return round_pow2 (size, sizeof (vlib_buffer_t));
258 vlib_buffer_get_free_list_index (vlib_buffer_t * b)
260 return b->flags & VLIB_BUFFER_FREE_LIST_INDEX_MASK;
264 vlib_buffer_set_free_list_index (vlib_buffer_t * b, u32 index)
266 /* if there is an need for more free lists we should consider
267 storig data in the 2nd cacheline */
268 ASSERT (VLIB_BUFFER_FREE_LIST_INDEX_MASK & 1);
269 ASSERT (index <= VLIB_BUFFER_FREE_LIST_INDEX_MASK);
271 b->flags &= ~VLIB_BUFFER_FREE_LIST_INDEX_MASK;
272 b->flags |= index & VLIB_BUFFER_FREE_LIST_INDEX_MASK;
275 /** \brief Allocate buffers from specific freelist into supplied array
277 @param vm - (vlib_main_t *) vlib main data structure pointer
278 @param buffers - (u32 * ) buffer index array
279 @param n_buffers - (u32) number of buffers requested
280 @return - (u32) number of buffers actually allocated, may be
281 less than the number requested or zero
284 vlib_buffer_alloc_from_free_list (vlib_main_t * vm,
286 u32 n_buffers, u32 free_list_index)
288 vlib_buffer_main_t *bm = vm->buffer_main;
289 vlib_buffer_free_list_t *fl;
293 ASSERT (bm->cb.vlib_buffer_fill_free_list_cb);
295 fl = pool_elt_at_index (bm->buffer_free_list_pool, free_list_index);
297 len = vec_len (fl->buffers);
299 if (PREDICT_FALSE (len < n_buffers))
301 bm->cb.vlib_buffer_fill_free_list_cb (vm, fl, n_buffers);
302 len = vec_len (fl->buffers);
304 /* even if fill free list didn't manage to refill free list
305 we should give what we have */
306 n_buffers = clib_min (len, n_buffers);
308 /* following code is intentionaly duplicated to allow compiler
309 to optimize fast path when n_buffers is constant value */
310 src = fl->buffers + len - n_buffers;
311 clib_memcpy (buffers, src, n_buffers * sizeof (u32));
312 _vec_len (fl->buffers) -= n_buffers;
314 /* Verify that buffers are known free. */
315 vlib_buffer_validate_alloc_free (vm, buffers, n_buffers,
316 VLIB_BUFFER_KNOWN_FREE);
321 src = fl->buffers + len - n_buffers;
322 clib_memcpy (buffers, src, n_buffers * sizeof (u32));
323 _vec_len (fl->buffers) -= n_buffers;
325 /* Verify that buffers are known free. */
326 vlib_buffer_validate_alloc_free (vm, buffers, n_buffers,
327 VLIB_BUFFER_KNOWN_FREE);
332 /** \brief Allocate buffers into supplied array
334 @param vm - (vlib_main_t *) vlib main data structure pointer
335 @param buffers - (u32 * ) buffer index array
336 @param n_buffers - (u32) number of buffers requested
337 @return - (u32) number of buffers actually allocated, may be
338 less than the number requested or zero
341 vlib_buffer_alloc (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
343 return vlib_buffer_alloc_from_free_list (vm, buffers, n_buffers,
344 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
347 /** \brief Allocate buffers into ring
349 @param vm - (vlib_main_t *) vlib main data structure pointer
350 @param buffers - (u32 * ) buffer index ring
351 @param start - (u32) first slot in the ring
352 @param ring_size - (u32) ring size
353 @param n_buffers - (u32) number of buffers requested
354 @return - (u32) number of buffers actually allocated, may be
355 less than the number requested or zero
358 vlib_buffer_alloc_to_ring (vlib_main_t * vm, u32 * ring, u32 start,
359 u32 ring_size, u32 n_buffers)
363 ASSERT (n_buffers <= ring_size);
365 if (PREDICT_TRUE (start + n_buffers <= ring_size))
366 return vlib_buffer_alloc (vm, ring + start, n_buffers);
368 n_alloc = vlib_buffer_alloc (vm, ring + start, ring_size - start);
370 if (PREDICT_TRUE (n_alloc == ring_size - start))
371 n_alloc += vlib_buffer_alloc (vm, ring, n_buffers - n_alloc);
376 /** \brief Free buffers
377 Frees the entire buffer chain for each buffer
379 @param vm - (vlib_main_t *) vlib main data structure pointer
380 @param buffers - (u32 * ) buffer index array
381 @param n_buffers - (u32) number of buffers to free
385 vlib_buffer_free (vlib_main_t * vm,
386 /* pointer to first buffer */
388 /* number of buffers to free */
391 vlib_buffer_main_t *bm = vm->buffer_main;
393 ASSERT (bm->cb.vlib_buffer_free_cb);
395 return bm->cb.vlib_buffer_free_cb (vm, buffers, n_buffers);
398 /** \brief Free buffers, does not free the buffer chain for each buffer
400 @param vm - (vlib_main_t *) vlib main data structure pointer
401 @param buffers - (u32 * ) buffer index array
402 @param n_buffers - (u32) number of buffers to free
406 vlib_buffer_free_no_next (vlib_main_t * vm,
407 /* pointer to first buffer */
409 /* number of buffers to free */
412 vlib_buffer_main_t *bm = vm->buffer_main;
414 ASSERT (bm->cb.vlib_buffer_free_no_next_cb);
416 return bm->cb.vlib_buffer_free_no_next_cb (vm, buffers, n_buffers);
419 /** \brief Free one buffer
420 Shorthand to free a single buffer chain.
422 @param vm - (vlib_main_t *) vlib main data structure pointer
423 @param buffer_index - (u32) buffer index to free
426 vlib_buffer_free_one (vlib_main_t * vm, u32 buffer_index)
428 vlib_buffer_free (vm, &buffer_index, /* n_buffers */ 1);
431 /* Add/delete buffer free lists. */
432 u32 vlib_buffer_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
435 vlib_buffer_delete_free_list (vlib_main_t * vm, u32 free_list_index)
437 vlib_buffer_main_t *bm = vm->buffer_main;
439 ASSERT (bm->cb.vlib_buffer_delete_free_list_cb);
441 bm->cb.vlib_buffer_delete_free_list_cb (vm, free_list_index);
444 /* Find already existing public free list with given size or create one. */
445 u32 vlib_buffer_get_or_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
448 /* Merge two free lists */
449 void vlib_buffer_merge_free_lists (vlib_buffer_free_list_t * dst,
450 vlib_buffer_free_list_t * src);
452 /* Make sure we have at least given number of unaligned buffers. */
453 void vlib_buffer_free_list_fill_unaligned (vlib_main_t * vm,
454 vlib_buffer_free_list_t *
456 uword n_unaligned_buffers);
459 vlib_buffer_get_free_list_with_size (vlib_main_t * vm, u32 size)
461 vlib_buffer_main_t *bm = vm->buffer_main;
463 size = vlib_buffer_round_size (size);
464 uword *p = hash_get (bm->free_list_by_size, size);
465 return p ? p[0] : ~0;
468 always_inline vlib_buffer_free_list_t *
469 vlib_buffer_get_buffer_free_list (vlib_main_t * vm, vlib_buffer_t * b,
472 vlib_buffer_main_t *bm = vm->buffer_main;
475 *index = i = vlib_buffer_get_free_list_index (b);
476 return pool_elt_at_index (bm->buffer_free_list_pool, i);
479 always_inline vlib_buffer_free_list_t *
480 vlib_buffer_get_free_list (vlib_main_t * vm, u32 free_list_index)
482 vlib_buffer_main_t *bm = vm->buffer_main;
483 vlib_buffer_free_list_t *f;
485 f = pool_elt_at_index (bm->buffer_free_list_pool, free_list_index);
487 /* Sanity: indices must match. */
488 ASSERT (f->index == free_list_index);
494 vlib_buffer_free_list_buffer_size (vlib_main_t * vm, u32 free_list_index)
496 vlib_buffer_free_list_t *f =
497 vlib_buffer_get_free_list (vm, free_list_index);
498 return f->n_data_bytes;
501 void vlib_aligned_memcpy (void *_dst, void *_src, int n_bytes);
503 /* Reasonably fast buffer copy routine. */
505 vlib_copy_buffers (u32 * dst, u32 * src, u32 n)
526 /* Append given data to end of buffer, possibly allocating new buffers. */
527 u32 vlib_buffer_add_data (vlib_main_t * vm,
529 u32 buffer_index, void *data, u32 n_data_bytes);
531 /* duplicate all buffers in chain */
532 always_inline vlib_buffer_t *
533 vlib_buffer_copy (vlib_main_t * vm, vlib_buffer_t * b)
535 vlib_buffer_t *s, *d, *fd;
536 uword n_alloc, n_buffers = 1;
537 u32 flag_mask = VLIB_BUFFER_NEXT_PRESENT | VLIB_BUFFER_TOTAL_LENGTH_VALID;
541 while (s->flags & VLIB_BUFFER_NEXT_PRESENT)
544 s = vlib_get_buffer (vm, s->next_buffer);
546 u32 new_buffers[n_buffers];
548 n_alloc = vlib_buffer_alloc (vm, new_buffers, n_buffers);
550 /* No guarantee that we'll get all the buffers we asked for */
551 if (PREDICT_FALSE (n_alloc < n_buffers))
554 vlib_buffer_free (vm, new_buffers, n_alloc);
560 fd = d = vlib_get_buffer (vm, new_buffers[0]);
561 d->current_data = s->current_data;
562 d->current_length = s->current_length;
563 d->flags = s->flags & flag_mask;
564 d->total_length_not_including_first_buffer =
565 s->total_length_not_including_first_buffer;
566 clib_memcpy (d->opaque, s->opaque, sizeof (s->opaque));
567 clib_memcpy (vlib_buffer_get_current (d),
568 vlib_buffer_get_current (s), s->current_length);
571 for (i = 1; i < n_buffers; i++)
574 d->next_buffer = new_buffers[i];
576 s = vlib_get_buffer (vm, s->next_buffer);
577 d = vlib_get_buffer (vm, new_buffers[i]);
578 d->current_data = s->current_data;
579 d->current_length = s->current_length;
580 clib_memcpy (vlib_buffer_get_current (d),
581 vlib_buffer_get_current (s), s->current_length);
582 d->flags = s->flags & flag_mask;
588 /** \brief Create multiple clones of buffer and store them in the supplied array
590 @param vm - (vlib_main_t *) vlib main data structure pointer
591 @param src_buffer - (u32) source buffer index
592 @param buffers - (u32 * ) buffer index array
593 @param n_buffers - (u8) number of buffer clones requested
594 @param head_end_offset - (u16) offset relative to current position
595 where packet head ends
596 @return - (u8) number of buffers actually cloned, may be
597 less than the number requested or zero
601 vlib_buffer_clone (vlib_main_t * vm, u32 src_buffer, u32 * buffers,
602 u8 n_buffers, u16 head_end_offset)
605 vlib_buffer_t *s = vlib_get_buffer (vm, src_buffer);
607 ASSERT (s->n_add_refs == 0);
610 if (s->current_length <= head_end_offset + CLIB_CACHE_LINE_BYTES * 2)
612 buffers[0] = src_buffer;
613 for (i = 1; i < n_buffers; i++)
616 d = vlib_buffer_copy (vm, s);
619 buffers[i] = vlib_get_buffer_index (vm, d);
625 n_buffers = vlib_buffer_alloc_from_free_list (vm, buffers, n_buffers,
626 vlib_buffer_get_free_list_index
628 if (PREDICT_FALSE (n_buffers == 0))
630 buffers[0] = src_buffer;
634 for (i = 0; i < n_buffers; i++)
636 vlib_buffer_t *d = vlib_get_buffer (vm, buffers[i]);
637 d->current_data = s->current_data;
638 d->current_length = head_end_offset;
639 vlib_buffer_set_free_list_index (d,
640 vlib_buffer_get_free_list_index (s));
641 d->total_length_not_including_first_buffer =
642 s->total_length_not_including_first_buffer + s->current_length -
644 d->flags = s->flags | VLIB_BUFFER_NEXT_PRESENT;
645 d->flags &= ~VLIB_BUFFER_EXT_HDR_VALID;
646 clib_memcpy (d->opaque, s->opaque, sizeof (s->opaque));
647 clib_memcpy (vlib_buffer_get_current (d), vlib_buffer_get_current (s),
649 d->next_buffer = src_buffer;
651 vlib_buffer_advance (s, head_end_offset);
652 s->n_add_refs = n_buffers - 1;
653 while (s->flags & VLIB_BUFFER_NEXT_PRESENT)
655 s = vlib_get_buffer (vm, s->next_buffer);
656 s->n_add_refs = n_buffers - 1;
662 /** \brief Attach cloned tail to the buffer
664 @param vm - (vlib_main_t *) vlib main data structure pointer
665 @param head - (vlib_buffer_t *) head buffer
666 @param tail - (Vlib buffer_t *) tail buffer to clone and attach to head
670 vlib_buffer_attach_clone (vlib_main_t * vm, vlib_buffer_t * head,
671 vlib_buffer_t * tail)
673 ASSERT ((head->flags & VLIB_BUFFER_NEXT_PRESENT) == 0);
674 ASSERT (vlib_buffer_get_free_list_index (head) ==
675 vlib_buffer_get_free_list_index (tail));
677 head->flags |= VLIB_BUFFER_NEXT_PRESENT;
678 head->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
679 head->flags &= ~VLIB_BUFFER_EXT_HDR_VALID;
680 head->flags |= (tail->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID);
681 head->next_buffer = vlib_get_buffer_index (vm, tail);
682 head->total_length_not_including_first_buffer = tail->current_length +
683 tail->total_length_not_including_first_buffer;
686 __sync_add_and_fetch (&tail->n_add_refs, 1);
688 if (tail->flags & VLIB_BUFFER_NEXT_PRESENT)
690 tail = vlib_get_buffer (vm, tail->next_buffer);
695 /* Initializes the buffer as an empty packet with no chained buffers. */
697 vlib_buffer_chain_init (vlib_buffer_t * first)
699 first->total_length_not_including_first_buffer = 0;
700 first->current_length = 0;
701 first->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
702 first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
705 /* The provided next_bi buffer index is appended to the end of the packet. */
706 always_inline vlib_buffer_t *
707 vlib_buffer_chain_buffer (vlib_main_t * vm,
708 vlib_buffer_t * first,
709 vlib_buffer_t * last, u32 next_bi)
711 vlib_buffer_t *next_buffer = vlib_get_buffer (vm, next_bi);
712 last->next_buffer = next_bi;
713 last->flags |= VLIB_BUFFER_NEXT_PRESENT;
714 next_buffer->current_length = 0;
715 next_buffer->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
719 /* Increases or decreases the packet length.
720 * It does not allocate or deallocate new buffers.
721 * Therefore, the added length must be compatible
722 * with the last buffer. */
724 vlib_buffer_chain_increase_length (vlib_buffer_t * first,
725 vlib_buffer_t * last, i32 len)
727 last->current_length += len;
729 first->total_length_not_including_first_buffer += len;
732 /* Copy data to the end of the packet and increases its length.
733 * It does not allocate new buffers.
734 * Returns the number of copied bytes. */
736 vlib_buffer_chain_append_data (vlib_main_t * vm,
738 vlib_buffer_t * first,
739 vlib_buffer_t * last, void *data, u16 data_len)
742 vlib_buffer_free_list_buffer_size (vm, free_list_index);
743 ASSERT (n_buffer_bytes >= last->current_length + last->current_data);
744 u16 len = clib_min (data_len,
745 n_buffer_bytes - last->current_length -
747 clib_memcpy (vlib_buffer_get_current (last) + last->current_length, data,
749 vlib_buffer_chain_increase_length (first, last, len);
753 /* Copy data to the end of the packet and increases its length.
754 * Allocates additional buffers from the free list if necessary.
755 * Returns the number of copied bytes.
756 * 'last' value is modified whenever new buffers are allocated and
757 * chained and points to the last buffer in the chain. */
759 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
761 vlib_buffer_t * first,
762 vlib_buffer_t ** last,
763 void *data, u16 data_len);
764 void vlib_buffer_chain_validate (vlib_main_t * vm, vlib_buffer_t * first);
766 format_function_t format_vlib_buffer, format_vlib_buffer_and_data,
767 format_vlib_buffer_contents;
771 /* Vector of packet data. */
774 /* Number of buffers to allocate in each call to physmem
776 u32 min_n_buffers_each_physmem_alloc;
778 /* Buffer free list for this template. */
782 } vlib_packet_template_t;
784 void vlib_packet_template_get_packet_helper (vlib_main_t * vm,
785 vlib_packet_template_t * t);
787 void vlib_packet_template_init (vlib_main_t * vm,
788 vlib_packet_template_t * t,
790 uword n_packet_data_bytes,
791 uword min_n_buffers_each_physmem_alloc,
794 void *vlib_packet_template_get_packet (vlib_main_t * vm,
795 vlib_packet_template_t * t,
799 vlib_packet_template_free (vlib_main_t * vm, vlib_packet_template_t * t)
801 vec_free (t->packet_data);
805 unserialize_vlib_buffer_n_bytes (serialize_main_t * m)
807 serialize_stream_t *s = &m->stream;
808 vlib_serialize_buffer_main_t *sm
809 = uword_to_pointer (m->stream.data_function_opaque,
810 vlib_serialize_buffer_main_t *);
811 vlib_main_t *vm = sm->vlib_main;
814 n = s->n_buffer_bytes - s->current_buffer_index;
815 if (sm->last_buffer != ~0)
817 vlib_buffer_t *b = vlib_get_buffer (vm, sm->last_buffer);
818 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
820 b = vlib_get_buffer (vm, b->next_buffer);
821 n += b->current_length;
826 clib_fifo_foreach (f, sm->rx.buffer_fifo, ({
827 n += vlib_buffer_index_length_in_chain (vm, f[0]);
834 /* Set a buffer quickly into "uninitialized" state. We want this to
835 be extremely cheap and arrange for all fields that need to be
836 initialized to be in the first 128 bits of the buffer. */
838 vlib_buffer_init_for_free_list (vlib_buffer_t * dst,
839 vlib_buffer_free_list_t * fl)
841 vlib_buffer_t *src = &fl->buffer_init_template;
843 /* Make sure vlib_buffer_t is cacheline aligned and sized */
844 ASSERT (STRUCT_OFFSET_OF (vlib_buffer_t, cacheline0) == 0);
845 ASSERT (STRUCT_OFFSET_OF (vlib_buffer_t, cacheline1) ==
846 CLIB_CACHE_LINE_BYTES);
847 ASSERT (STRUCT_OFFSET_OF (vlib_buffer_t, cacheline2) ==
848 CLIB_CACHE_LINE_BYTES * 2);
850 /* Make sure buffer template is sane. */
851 ASSERT (fl->index == vlib_buffer_get_free_list_index (src));
853 clib_memcpy (STRUCT_MARK_PTR (dst, template_start),
854 STRUCT_MARK_PTR (src, template_start),
855 STRUCT_OFFSET_OF (vlib_buffer_t, template_end) -
856 STRUCT_OFFSET_OF (vlib_buffer_t, template_start));
858 /* Not in the first 16 octets. */
859 dst->n_add_refs = src->n_add_refs;
861 /* Make sure it really worked. */
862 #define _(f) ASSERT (dst->f == src->f);
867 /* ASSERT (dst->total_length_not_including_first_buffer == 0); */
868 /* total_length_not_including_first_buffer is not in the template anymore
869 * so it may actually not zeroed for some buffers. One option is to
870 * uncomment the line lower (comes at a cost), the other, is to just not
872 /* dst->total_length_not_including_first_buffer = 0; */
873 ASSERT (dst->n_add_refs == 0);
877 vlib_buffer_add_to_free_list (vlib_main_t * vm,
878 vlib_buffer_free_list_t * f,
879 u32 buffer_index, u8 do_init)
882 b = vlib_get_buffer (vm, buffer_index);
883 if (PREDICT_TRUE (do_init))
884 vlib_buffer_init_for_free_list (b, f);
885 vec_add1_aligned (f->buffers, buffer_index, CLIB_CACHE_LINE_BYTES);
887 if (vec_len (f->buffers) > 4 * VLIB_FRAME_SIZE)
889 vlib_buffer_free_list_t *mf;
890 mf = vlib_buffer_get_free_list (vlib_mains[0], f->index);
891 clib_spinlock_lock (&mf->global_buffers_lock);
892 /* keep last stored buffers, as they are more likely hot in the cache */
893 vec_add_aligned (mf->global_buffers, f->buffers, VLIB_FRAME_SIZE,
894 CLIB_CACHE_LINE_BYTES);
895 vec_delete (f->buffers, VLIB_FRAME_SIZE, 0);
896 f->n_alloc -= VLIB_FRAME_SIZE;
897 clib_spinlock_unlock (&mf->global_buffers_lock);
902 vlib_buffer_init_two_for_free_list (vlib_buffer_t * dst0,
903 vlib_buffer_t * dst1,
904 vlib_buffer_free_list_t * fl)
906 vlib_buffer_t *src = &fl->buffer_init_template;
908 /* Make sure buffer template is sane. */
909 ASSERT (fl->index == vlib_buffer_get_free_list_index (src));
911 clib_memcpy (STRUCT_MARK_PTR (dst0, template_start),
912 STRUCT_MARK_PTR (src, template_start),
913 STRUCT_OFFSET_OF (vlib_buffer_t, template_end) -
914 STRUCT_OFFSET_OF (vlib_buffer_t, template_start));
916 clib_memcpy (STRUCT_MARK_PTR (dst1, template_start),
917 STRUCT_MARK_PTR (src, template_start),
918 STRUCT_OFFSET_OF (vlib_buffer_t, template_end) -
919 STRUCT_OFFSET_OF (vlib_buffer_t, template_start));
921 /* Not in the first 16 octets. */
922 dst0->n_add_refs = src->n_add_refs;
923 dst1->n_add_refs = src->n_add_refs;
925 /* Make sure it really worked. */
926 #define _(f) ASSERT (dst0->f == src->f); ASSERT( dst1->f == src->f)
932 ASSERT (dst0->total_length_not_including_first_buffer == 0);
933 ASSERT (dst1->total_length_not_including_first_buffer == 0);
934 ASSERT (dst0->n_add_refs == 0);
935 ASSERT (dst1->n_add_refs == 0);
939 extern u32 *vlib_buffer_state_validation_lock;
940 extern uword *vlib_buffer_state_validation_hash;
941 extern void *vlib_buffer_state_heap;
945 vlib_validate_buffer_in_use (vlib_buffer_t * b, u32 expected)
951 oldheap = clib_mem_set_heap (vlib_buffer_state_heap);
953 while (__sync_lock_test_and_set (vlib_buffer_state_validation_lock, 1))
956 p = hash_get (vlib_buffer_state_validation_hash, b);
958 /* If we don't know about b, declare it to be in the expected state */
961 hash_set (vlib_buffer_state_validation_hash, b, expected);
965 if (p[0] != expected)
969 vlib_main_t *vm = &vlib_global_main;
973 bi = vlib_get_buffer_index (vm, b);
975 clib_mem_set_heap (oldheap);
976 clib_warning ("%.6f buffer %llx (%d): %s, not %s",
977 vlib_time_now (vm), bi,
978 p[0] ? "busy" : "free", expected ? "busy" : "free");
982 CLIB_MEMORY_BARRIER ();
983 *vlib_buffer_state_validation_lock = 0;
984 clib_mem_set_heap (oldheap);
989 vlib_validate_buffer_set_in_use (vlib_buffer_t * b, u32 expected)
994 oldheap = clib_mem_set_heap (vlib_buffer_state_heap);
996 while (__sync_lock_test_and_set (vlib_buffer_state_validation_lock, 1))
999 hash_set (vlib_buffer_state_validation_hash, b, expected);
1001 CLIB_MEMORY_BARRIER ();
1002 *vlib_buffer_state_validation_lock = 0;
1003 clib_mem_set_heap (oldheap);
1007 /** minimum data size of first buffer in a buffer chain */
1008 #define VLIB_BUFFER_CHAIN_MIN_FIRST_DATA_SIZE (256)
1011 * @brief compress buffer chain in a way where the first buffer is at least
1012 * VLIB_BUFFER_CHAIN_MIN_FIRST_DATA_SIZE long
1014 * @param[in] vm - vlib_main
1015 * @param[in,out] first - first buffer in chain
1016 * @param[in,out] discard_vector - vector of buffer indexes which were removed
1020 vlib_buffer_chain_compress (vlib_main_t * vm,
1021 vlib_buffer_t * first, u32 ** discard_vector)
1023 if (first->current_length >= VLIB_BUFFER_CHAIN_MIN_FIRST_DATA_SIZE ||
1024 !(first->flags & VLIB_BUFFER_NEXT_PRESENT))
1026 /* this is already big enough or not a chain */
1029 /* probe free list to find allocated buffer size to avoid overfill */
1031 vlib_buffer_free_list_t *free_list =
1032 vlib_buffer_get_buffer_free_list (vm, first, &index);
1034 u32 want_first_size = clib_min (VLIB_BUFFER_CHAIN_MIN_FIRST_DATA_SIZE,
1035 free_list->n_data_bytes -
1036 first->current_data);
1039 vlib_buffer_t *second = vlib_get_buffer (vm, first->next_buffer);
1040 u32 need = want_first_size - first->current_length;
1041 u32 amount_to_copy = clib_min (need, second->current_length);
1042 clib_memcpy (((u8 *) vlib_buffer_get_current (first)) +
1043 first->current_length,
1044 vlib_buffer_get_current (second), amount_to_copy);
1045 first->current_length += amount_to_copy;
1046 vlib_buffer_advance (second, amount_to_copy);
1047 if (first->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID)
1049 first->total_length_not_including_first_buffer -= amount_to_copy;
1051 if (!second->current_length)
1053 vec_add1 (*discard_vector, first->next_buffer);
1054 if (second->flags & VLIB_BUFFER_NEXT_PRESENT)
1056 first->next_buffer = second->next_buffer;
1060 first->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
1062 second->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
1065 while ((first->current_length < want_first_size) &&
1066 (first->flags & VLIB_BUFFER_NEXT_PRESENT));
1069 #endif /* included_vlib_buffer_funcs_h */
1072 * fd.io coding-style-patch-verification: ON
1075 * eval: (c-set-style "gnu")