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 (vlib_main_t * vm, u32 buffer_index)
227 vlib_buffer_main_t *bm = vm->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 (vlib_main_t * vm,
238 vlib_buffer_known_state_t state)
240 vlib_buffer_main_t *bm = vm->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 Free buffers
348 Frees the entire buffer chain for each buffer
350 @param vm - (vlib_main_t *) vlib main data structure pointer
351 @param buffers - (u32 * ) buffer index array
352 @param n_buffers - (u32) number of buffers to free
356 vlib_buffer_free (vlib_main_t * vm,
357 /* pointer to first buffer */
359 /* number of buffers to free */
362 vlib_buffer_main_t *bm = vm->buffer_main;
364 ASSERT (bm->cb.vlib_buffer_free_cb);
366 return bm->cb.vlib_buffer_free_cb (vm, buffers, n_buffers);
369 /** \brief Free buffers, does not free the buffer chain for each buffer
371 @param vm - (vlib_main_t *) vlib main data structure pointer
372 @param buffers - (u32 * ) buffer index array
373 @param n_buffers - (u32) number of buffers to free
377 vlib_buffer_free_no_next (vlib_main_t * vm,
378 /* pointer to first buffer */
380 /* number of buffers to free */
383 vlib_buffer_main_t *bm = vm->buffer_main;
385 ASSERT (bm->cb.vlib_buffer_free_no_next_cb);
387 return bm->cb.vlib_buffer_free_no_next_cb (vm, buffers, n_buffers);
390 /** \brief Free one buffer
391 Shorthand to free a single buffer chain.
393 @param vm - (vlib_main_t *) vlib main data structure pointer
394 @param buffer_index - (u32) buffer index to free
397 vlib_buffer_free_one (vlib_main_t * vm, u32 buffer_index)
399 vlib_buffer_free (vm, &buffer_index, /* n_buffers */ 1);
402 /* Add/delete buffer free lists. */
403 u32 vlib_buffer_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
406 vlib_buffer_delete_free_list (vlib_main_t * vm, u32 free_list_index)
408 vlib_buffer_main_t *bm = vm->buffer_main;
410 ASSERT (bm->cb.vlib_buffer_delete_free_list_cb);
412 bm->cb.vlib_buffer_delete_free_list_cb (vm, free_list_index);
415 /* Find already existing public free list with given size or create one. */
416 u32 vlib_buffer_get_or_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
419 /* Merge two free lists */
420 void vlib_buffer_merge_free_lists (vlib_buffer_free_list_t * dst,
421 vlib_buffer_free_list_t * src);
423 /* Make sure we have at least given number of unaligned buffers. */
424 void vlib_buffer_free_list_fill_unaligned (vlib_main_t * vm,
425 vlib_buffer_free_list_t *
427 uword n_unaligned_buffers);
430 vlib_buffer_get_free_list_with_size (vlib_main_t * vm, u32 size)
432 vlib_buffer_main_t *bm = vm->buffer_main;
434 size = vlib_buffer_round_size (size);
435 uword *p = hash_get (bm->free_list_by_size, size);
436 return p ? p[0] : ~0;
439 always_inline vlib_buffer_free_list_t *
440 vlib_buffer_get_buffer_free_list (vlib_main_t * vm, vlib_buffer_t * b,
443 vlib_buffer_main_t *bm = vm->buffer_main;
446 *index = i = vlib_buffer_get_free_list_index (b);
447 return pool_elt_at_index (bm->buffer_free_list_pool, i);
450 always_inline vlib_buffer_free_list_t *
451 vlib_buffer_get_free_list (vlib_main_t * vm, u32 free_list_index)
453 vlib_buffer_main_t *bm = vm->buffer_main;
454 vlib_buffer_free_list_t *f;
456 f = pool_elt_at_index (bm->buffer_free_list_pool, free_list_index);
458 /* Sanity: indices must match. */
459 ASSERT (f->index == free_list_index);
465 vlib_buffer_free_list_buffer_size (vlib_main_t * vm, u32 free_list_index)
467 vlib_buffer_free_list_t *f =
468 vlib_buffer_get_free_list (vm, free_list_index);
469 return f->n_data_bytes;
472 void vlib_aligned_memcpy (void *_dst, void *_src, int n_bytes);
474 /* Reasonably fast buffer copy routine. */
476 vlib_copy_buffers (u32 * dst, u32 * src, u32 n)
497 /* Append given data to end of buffer, possibly allocating new buffers. */
498 u32 vlib_buffer_add_data (vlib_main_t * vm,
500 u32 buffer_index, void *data, u32 n_data_bytes);
502 /* duplicate all buffers in chain */
503 always_inline vlib_buffer_t *
504 vlib_buffer_copy (vlib_main_t * vm, vlib_buffer_t * b)
506 vlib_buffer_t *s, *d, *fd;
507 uword n_alloc, n_buffers = 1;
508 u32 flag_mask = VLIB_BUFFER_NEXT_PRESENT | VLIB_BUFFER_TOTAL_LENGTH_VALID;
512 while (s->flags & VLIB_BUFFER_NEXT_PRESENT)
515 s = vlib_get_buffer (vm, s->next_buffer);
517 u32 new_buffers[n_buffers];
519 n_alloc = vlib_buffer_alloc (vm, new_buffers, n_buffers);
521 /* No guarantee that we'll get all the buffers we asked for */
522 if (PREDICT_FALSE (n_alloc < n_buffers))
525 vlib_buffer_free (vm, new_buffers, n_alloc);
531 fd = d = vlib_get_buffer (vm, new_buffers[0]);
532 d->current_data = s->current_data;
533 d->current_length = s->current_length;
534 d->flags = s->flags & flag_mask;
535 d->total_length_not_including_first_buffer =
536 s->total_length_not_including_first_buffer;
537 clib_memcpy (d->opaque, s->opaque, sizeof (s->opaque));
538 clib_memcpy (vlib_buffer_get_current (d),
539 vlib_buffer_get_current (s), s->current_length);
542 for (i = 1; i < n_buffers; i++)
545 d->next_buffer = new_buffers[i];
547 s = vlib_get_buffer (vm, s->next_buffer);
548 d = vlib_get_buffer (vm, new_buffers[i]);
549 d->current_data = s->current_data;
550 d->current_length = s->current_length;
551 clib_memcpy (vlib_buffer_get_current (d),
552 vlib_buffer_get_current (s), s->current_length);
553 d->flags = s->flags & flag_mask;
559 /** \brief Create multiple clones of buffer and store them in the supplied array
561 @param vm - (vlib_main_t *) vlib main data structure pointer
562 @param src_buffer - (u32) source buffer index
563 @param buffers - (u32 * ) buffer index array
564 @param n_buffers - (u8) number of buffer clones requested
565 @param head_end_offset - (u16) offset relative to current position
566 where packet head ends
567 @return - (u8) number of buffers actually cloned, may be
568 less than the number requested or zero
572 vlib_buffer_clone (vlib_main_t * vm, u32 src_buffer, u32 * buffers,
573 u8 n_buffers, u16 head_end_offset)
576 vlib_buffer_t *s = vlib_get_buffer (vm, src_buffer);
578 ASSERT (s->n_add_refs == 0);
581 if (s->current_length <= head_end_offset + CLIB_CACHE_LINE_BYTES * 2)
583 buffers[0] = src_buffer;
584 for (i = 1; i < n_buffers; i++)
587 d = vlib_buffer_copy (vm, s);
590 buffers[i] = vlib_get_buffer_index (vm, d);
596 n_buffers = vlib_buffer_alloc_from_free_list (vm, buffers, n_buffers,
597 vlib_buffer_get_free_list_index
599 if (PREDICT_FALSE (n_buffers == 0))
601 buffers[0] = src_buffer;
605 for (i = 0; i < n_buffers; i++)
607 vlib_buffer_t *d = vlib_get_buffer (vm, buffers[i]);
608 d->current_data = s->current_data;
609 d->current_length = head_end_offset;
610 vlib_buffer_set_free_list_index (d,
611 vlib_buffer_get_free_list_index (s));
612 d->total_length_not_including_first_buffer =
613 s->total_length_not_including_first_buffer + s->current_length -
615 d->flags = s->flags | VLIB_BUFFER_NEXT_PRESENT;
616 d->flags &= ~VLIB_BUFFER_EXT_HDR_VALID;
617 clib_memcpy (d->opaque, s->opaque, sizeof (s->opaque));
618 clib_memcpy (vlib_buffer_get_current (d), vlib_buffer_get_current (s),
620 d->next_buffer = src_buffer;
622 vlib_buffer_advance (s, head_end_offset);
623 s->n_add_refs = n_buffers - 1;
624 while (s->flags & VLIB_BUFFER_NEXT_PRESENT)
626 s = vlib_get_buffer (vm, s->next_buffer);
627 s->n_add_refs = n_buffers - 1;
633 /** \brief Attach cloned tail to the buffer
635 @param vm - (vlib_main_t *) vlib main data structure pointer
636 @param head - (vlib_buffer_t *) head buffer
637 @param tail - (Vlib buffer_t *) tail buffer to clone and attach to head
641 vlib_buffer_attach_clone (vlib_main_t * vm, vlib_buffer_t * head,
642 vlib_buffer_t * tail)
644 ASSERT ((head->flags & VLIB_BUFFER_NEXT_PRESENT) == 0);
645 ASSERT (vlib_buffer_get_free_list_index (head) ==
646 vlib_buffer_get_free_list_index (tail));
648 head->flags |= VLIB_BUFFER_NEXT_PRESENT;
649 head->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
650 head->flags &= ~VLIB_BUFFER_EXT_HDR_VALID;
651 head->flags |= (tail->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID);
652 head->next_buffer = vlib_get_buffer_index (vm, tail);
653 head->total_length_not_including_first_buffer = tail->current_length +
654 tail->total_length_not_including_first_buffer;
657 __sync_add_and_fetch (&tail->n_add_refs, 1);
659 if (tail->flags & VLIB_BUFFER_NEXT_PRESENT)
661 tail = vlib_get_buffer (vm, tail->next_buffer);
666 /* Initializes the buffer as an empty packet with no chained buffers. */
668 vlib_buffer_chain_init (vlib_buffer_t * first)
670 first->total_length_not_including_first_buffer = 0;
671 first->current_length = 0;
672 first->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
673 first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
676 /* The provided next_bi buffer index is appended to the end of the packet. */
677 always_inline vlib_buffer_t *
678 vlib_buffer_chain_buffer (vlib_main_t * vm,
679 vlib_buffer_t * first,
680 vlib_buffer_t * last, u32 next_bi)
682 vlib_buffer_t *next_buffer = vlib_get_buffer (vm, next_bi);
683 last->next_buffer = next_bi;
684 last->flags |= VLIB_BUFFER_NEXT_PRESENT;
685 next_buffer->current_length = 0;
686 next_buffer->flags &= ~VLIB_BUFFER_NEXT_PRESENT;
690 /* Increases or decreases the packet length.
691 * It does not allocate or deallocate new buffers.
692 * Therefore, the added length must be compatible
693 * with the last buffer. */
695 vlib_buffer_chain_increase_length (vlib_buffer_t * first,
696 vlib_buffer_t * last, i32 len)
698 last->current_length += len;
700 first->total_length_not_including_first_buffer += len;
703 /* Copy data to the end of the packet and increases its length.
704 * It does not allocate new buffers.
705 * Returns the number of copied bytes. */
707 vlib_buffer_chain_append_data (vlib_main_t * vm,
709 vlib_buffer_t * first,
710 vlib_buffer_t * last, void *data, u16 data_len)
713 vlib_buffer_free_list_buffer_size (vm, free_list_index);
714 ASSERT (n_buffer_bytes >= last->current_length + last->current_data);
715 u16 len = clib_min (data_len,
716 n_buffer_bytes - last->current_length -
718 clib_memcpy (vlib_buffer_get_current (last) + last->current_length, data,
720 vlib_buffer_chain_increase_length (first, last, len);
724 /* Copy data to the end of the packet and increases its length.
725 * Allocates additional buffers from the free list if necessary.
726 * Returns the number of copied bytes.
727 * 'last' value is modified whenever new buffers are allocated and
728 * chained and points to the last buffer in the chain. */
730 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
732 vlib_buffer_t * first,
733 vlib_buffer_t ** last,
734 void *data, u16 data_len);
735 void vlib_buffer_chain_validate (vlib_main_t * vm, vlib_buffer_t * first);
737 format_function_t format_vlib_buffer, format_vlib_buffer_and_data,
738 format_vlib_buffer_contents;
742 /* Vector of packet data. */
745 /* Number of buffers to allocate in each call to physmem
747 u32 min_n_buffers_each_physmem_alloc;
749 /* Buffer free list for this template. */
753 } vlib_packet_template_t;
755 void vlib_packet_template_get_packet_helper (vlib_main_t * vm,
756 vlib_packet_template_t * t);
758 void vlib_packet_template_init (vlib_main_t * vm,
759 vlib_packet_template_t * t,
761 uword n_packet_data_bytes,
762 uword min_n_buffers_each_physmem_alloc,
765 void *vlib_packet_template_get_packet (vlib_main_t * vm,
766 vlib_packet_template_t * t,
770 vlib_packet_template_free (vlib_main_t * vm, vlib_packet_template_t * t)
772 vec_free (t->packet_data);
776 unserialize_vlib_buffer_n_bytes (serialize_main_t * m)
778 serialize_stream_t *s = &m->stream;
779 vlib_serialize_buffer_main_t *sm
780 = uword_to_pointer (m->stream.data_function_opaque,
781 vlib_serialize_buffer_main_t *);
782 vlib_main_t *vm = sm->vlib_main;
785 n = s->n_buffer_bytes - s->current_buffer_index;
786 if (sm->last_buffer != ~0)
788 vlib_buffer_t *b = vlib_get_buffer (vm, sm->last_buffer);
789 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
791 b = vlib_get_buffer (vm, b->next_buffer);
792 n += b->current_length;
797 clib_fifo_foreach (f, sm->rx.buffer_fifo, ({
798 n += vlib_buffer_index_length_in_chain (vm, f[0]);
805 /* Set a buffer quickly into "uninitialized" state. We want this to
806 be extremely cheap and arrange for all fields that need to be
807 initialized to be in the first 128 bits of the buffer. */
809 vlib_buffer_init_for_free_list (vlib_buffer_t * dst,
810 vlib_buffer_free_list_t * fl)
812 vlib_buffer_t *src = &fl->buffer_init_template;
814 /* Make sure vlib_buffer_t is cacheline aligned and sized */
815 ASSERT (STRUCT_OFFSET_OF (vlib_buffer_t, cacheline0) == 0);
816 ASSERT (STRUCT_OFFSET_OF (vlib_buffer_t, cacheline1) ==
817 CLIB_CACHE_LINE_BYTES);
818 ASSERT (STRUCT_OFFSET_OF (vlib_buffer_t, cacheline2) ==
819 CLIB_CACHE_LINE_BYTES * 2);
821 /* Make sure buffer template is sane. */
822 ASSERT (fl->index == vlib_buffer_get_free_list_index (src));
824 clib_memcpy (STRUCT_MARK_PTR (dst, template_start),
825 STRUCT_MARK_PTR (src, template_start),
826 STRUCT_OFFSET_OF (vlib_buffer_t, template_end) -
827 STRUCT_OFFSET_OF (vlib_buffer_t, template_start));
829 /* Not in the first 16 octets. */
830 dst->n_add_refs = src->n_add_refs;
832 /* Make sure it really worked. */
833 #define _(f) ASSERT (dst->f == src->f);
838 /* ASSERT (dst->total_length_not_including_first_buffer == 0); */
839 /* total_length_not_including_first_buffer is not in the template anymore
840 * so it may actually not zeroed for some buffers. One option is to
841 * uncomment the line lower (comes at a cost), the other, is to just not
843 /* dst->total_length_not_including_first_buffer = 0; */
844 ASSERT (dst->n_add_refs == 0);
848 vlib_buffer_add_to_free_list (vlib_main_t * vm,
849 vlib_buffer_free_list_t * f,
850 u32 buffer_index, u8 do_init)
853 b = vlib_get_buffer (vm, buffer_index);
854 if (PREDICT_TRUE (do_init))
855 vlib_buffer_init_for_free_list (b, f);
856 vec_add1_aligned (f->buffers, buffer_index, CLIB_CACHE_LINE_BYTES);
858 if (vec_len (f->buffers) > 4 * VLIB_FRAME_SIZE)
860 vlib_buffer_free_list_t *mf;
861 mf = vlib_buffer_get_free_list (vlib_mains[0], f->index);
862 clib_spinlock_lock (&mf->global_buffers_lock);
863 /* keep last stored buffers, as they are more likely hot in the cache */
864 vec_add_aligned (mf->global_buffers, f->buffers, VLIB_FRAME_SIZE,
865 CLIB_CACHE_LINE_BYTES);
866 vec_delete (f->buffers, VLIB_FRAME_SIZE, 0);
867 f->n_alloc -= VLIB_FRAME_SIZE;
868 clib_spinlock_unlock (&mf->global_buffers_lock);
873 vlib_buffer_init_two_for_free_list (vlib_buffer_t * dst0,
874 vlib_buffer_t * dst1,
875 vlib_buffer_free_list_t * fl)
877 vlib_buffer_t *src = &fl->buffer_init_template;
879 /* Make sure buffer template is sane. */
880 ASSERT (fl->index == vlib_buffer_get_free_list_index (src));
882 clib_memcpy (STRUCT_MARK_PTR (dst0, template_start),
883 STRUCT_MARK_PTR (src, template_start),
884 STRUCT_OFFSET_OF (vlib_buffer_t, template_end) -
885 STRUCT_OFFSET_OF (vlib_buffer_t, template_start));
887 clib_memcpy (STRUCT_MARK_PTR (dst1, template_start),
888 STRUCT_MARK_PTR (src, template_start),
889 STRUCT_OFFSET_OF (vlib_buffer_t, template_end) -
890 STRUCT_OFFSET_OF (vlib_buffer_t, template_start));
892 /* Not in the first 16 octets. */
893 dst0->n_add_refs = src->n_add_refs;
894 dst1->n_add_refs = src->n_add_refs;
896 /* Make sure it really worked. */
897 #define _(f) ASSERT (dst0->f == src->f); ASSERT( dst1->f == src->f)
903 ASSERT (dst0->total_length_not_including_first_buffer == 0);
904 ASSERT (dst1->total_length_not_including_first_buffer == 0);
905 ASSERT (dst0->n_add_refs == 0);
906 ASSERT (dst1->n_add_refs == 0);
910 extern u32 *vlib_buffer_state_validation_lock;
911 extern uword *vlib_buffer_state_validation_hash;
912 extern void *vlib_buffer_state_heap;
916 vlib_validate_buffer_in_use (vlib_buffer_t * b, u32 expected)
922 oldheap = clib_mem_set_heap (vlib_buffer_state_heap);
924 while (__sync_lock_test_and_set (vlib_buffer_state_validation_lock, 1))
927 p = hash_get (vlib_buffer_state_validation_hash, b);
929 /* If we don't know about b, declare it to be in the expected state */
932 hash_set (vlib_buffer_state_validation_hash, b, expected);
936 if (p[0] != expected)
940 vlib_main_t *vm = &vlib_global_main;
944 bi = vlib_get_buffer_index (vm, b);
946 clib_mem_set_heap (oldheap);
947 clib_warning ("%.6f buffer %llx (%d): %s, not %s",
948 vlib_time_now (vm), bi,
949 p[0] ? "busy" : "free", expected ? "busy" : "free");
953 CLIB_MEMORY_BARRIER ();
954 *vlib_buffer_state_validation_lock = 0;
955 clib_mem_set_heap (oldheap);
960 vlib_validate_buffer_set_in_use (vlib_buffer_t * b, u32 expected)
965 oldheap = clib_mem_set_heap (vlib_buffer_state_heap);
967 while (__sync_lock_test_and_set (vlib_buffer_state_validation_lock, 1))
970 hash_set (vlib_buffer_state_validation_hash, b, expected);
972 CLIB_MEMORY_BARRIER ();
973 *vlib_buffer_state_validation_lock = 0;
974 clib_mem_set_heap (oldheap);
978 #endif /* included_vlib_buffer_funcs_h */
981 * fd.io coding-style-patch-verification: ON
984 * eval: (c-set-style "gnu")