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.c: allocate/free network buffers.
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.
43 * Allocate/free network buffers.
46 #include <vlib/vlib.h>
47 #include <vlib/unix/unix.h>
50 vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
51 vlib_buffer_t * b_first)
53 vlib_buffer_t *b = b_first;
54 uword l_first = b_first->current_length;
56 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
58 b = vlib_get_buffer (vm, b->next_buffer);
59 l += b->current_length;
61 b_first->total_length_not_including_first_buffer = l;
62 b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
67 format_vlib_buffer (u8 * s, va_list * args)
69 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
70 uword indent = format_get_indent (s);
72 s = format (s, "current data %d, length %d, free-list %d, clone-count %u",
73 b->current_data, b->current_length, b->free_list_index,
76 if (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID)
77 s = format (s, ", totlen-nifb %d",
78 b->total_length_not_including_first_buffer);
80 if (b->flags & VLIB_BUFFER_IS_TRACED)
81 s = format (s, ", trace 0x%x", b->trace_index);
83 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
85 vlib_main_t *vm = vlib_get_main ();
86 u32 next_buffer = b->next_buffer;
87 b = vlib_get_buffer (vm, next_buffer);
90 format (s, "\n%Unext-buffer 0x%x, segment length %d, clone-count %u",
91 format_white_space, indent, next_buffer, b->current_length,
99 format_vlib_buffer_and_data (u8 * s, va_list * args)
101 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
103 s = format (s, "%U, %U",
104 format_vlib_buffer, b,
105 format_hex_bytes, vlib_buffer_get_current (b), 64);
111 format_vlib_buffer_known_state (u8 * s, va_list * args)
113 vlib_buffer_known_state_t state = va_arg (*args, vlib_buffer_known_state_t);
118 case VLIB_BUFFER_UNKNOWN:
122 case VLIB_BUFFER_KNOWN_ALLOCATED:
123 t = "known-allocated";
126 case VLIB_BUFFER_KNOWN_FREE:
135 return format (s, "%s", t);
139 format_vlib_buffer_contents (u8 * s, va_list * va)
141 vlib_main_t *vm = va_arg (*va, vlib_main_t *);
142 vlib_buffer_t *b = va_arg (*va, vlib_buffer_t *);
146 vec_add (s, vlib_buffer_get_current (b), b->current_length);
147 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
149 b = vlib_get_buffer (vm, b->next_buffer);
156 vlib_validate_buffer_helper (vlib_main_t * vm,
158 uword follow_buffer_next, uword ** unique_hash)
160 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
161 vlib_buffer_main_t *bm = vm->buffer_main;
162 vlib_buffer_free_list_t *fl;
164 if (pool_is_free_index (bm->buffer_free_list_pool, b->free_list_index))
165 return format (0, "unknown free list 0x%x", b->free_list_index);
167 fl = pool_elt_at_index (bm->buffer_free_list_pool, b->free_list_index);
169 if ((signed) b->current_data < (signed) -VLIB_BUFFER_PRE_DATA_SIZE)
170 return format (0, "current data %d before pre-data", b->current_data);
172 if (b->current_data + b->current_length > fl->n_data_bytes)
173 return format (0, "%d-%d beyond end of buffer %d",
174 b->current_data, b->current_length, fl->n_data_bytes);
176 if (follow_buffer_next && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
178 vlib_buffer_known_state_t k;
181 k = vlib_buffer_is_known (vm, b->next_buffer);
182 if (k != VLIB_BUFFER_KNOWN_ALLOCATED)
183 return format (0, "next 0x%x: %U",
184 b->next_buffer, format_vlib_buffer_known_state, k);
188 if (hash_get (*unique_hash, b->next_buffer))
189 return format (0, "duplicate buffer 0x%x", b->next_buffer);
191 hash_set1 (*unique_hash, b->next_buffer);
194 msg = vlib_validate_buffer (vm, b->next_buffer, follow_buffer_next);
197 result = format (0, "next 0x%x: %v", b->next_buffer, msg);
207 vlib_validate_buffer (vlib_main_t * vm, u32 bi, uword follow_buffer_next)
209 return vlib_validate_buffer_helper (vm, bi, follow_buffer_next,
210 /* unique_hash */ 0);
214 vlib_validate_buffers (vlib_main_t * vm,
216 uword next_buffer_stride,
218 vlib_buffer_known_state_t known_state,
219 uword follow_buffer_next)
222 u32 bi, *b = buffers;
223 vlib_buffer_known_state_t k;
224 u8 *msg = 0, *result = 0;
226 hash = hash_create (0, 0);
227 for (i = 0; i < n_buffers; i++)
230 b += next_buffer_stride;
232 /* Buffer is not unique. */
233 if (hash_get (hash, bi))
235 msg = format (0, "not unique");
239 k = vlib_buffer_is_known (vm, bi);
240 if (k != known_state)
242 msg = format (0, "is %U; expected %U",
243 format_vlib_buffer_known_state, k,
244 format_vlib_buffer_known_state, known_state);
248 msg = vlib_validate_buffer_helper (vm, bi, follow_buffer_next, &hash);
252 hash_set1 (hash, bi);
258 result = format (0, "0x%x: %v", bi, msg);
266 * Hand-craft a static vector w/ length 1, so vec_len(vlib_mains) =1
267 * and vlib_mains[0] = &vlib_global_main from the beginning of time.
269 * The only place which should ever expand vlib_mains is start_workers()
270 * in threads.c. It knows about the bootstrap vector.
277 } __attribute__ ((packed)) __bootstrap_vlib_main_vector
278 __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES))) =
281 .vm = &vlib_global_main,
285 vlib_main_t **vlib_mains = &__bootstrap_vlib_main_vector.vm;
288 /* When dubugging validate that given buffers are either known allocated
291 vlib_buffer_validate_alloc_free (vlib_main_t * vm,
294 vlib_buffer_known_state_t expected_state)
297 uword i, bi, is_free;
302 ASSERT (os_get_cpu_number () == 0);
304 /* smp disaster check */
305 if (vec_len (vlib_mains) > 1)
306 ASSERT (vm == vlib_mains[0]);
308 is_free = expected_state == VLIB_BUFFER_KNOWN_ALLOCATED;
310 for (i = 0; i < n_buffers; i++)
312 vlib_buffer_known_state_t known;
316 known = vlib_buffer_is_known (vm, bi);
317 if (known != expected_state)
321 (vm, "%s %U buffer 0x%x",
322 is_free ? "freeing" : "allocating",
323 format_vlib_buffer_known_state, known, bi);
326 vlib_buffer_set_known_state
328 is_free ? VLIB_BUFFER_KNOWN_FREE : VLIB_BUFFER_KNOWN_ALLOCATED);
333 vlib_buffer_merge_free_lists (vlib_buffer_free_list_t * dst,
334 vlib_buffer_free_list_t * src)
339 l = vec_len (src->buffers);
342 vec_add2_aligned (dst->buffers, d, l, CLIB_CACHE_LINE_BYTES);
343 clib_memcpy (d, src->buffers, l * sizeof (d[0]));
344 vec_free (src->buffers);
348 /* Add buffer free list. */
350 vlib_buffer_create_free_list_helper (vlib_main_t * vm,
352 u32 is_public, u32 is_default, u8 * name)
354 vlib_buffer_main_t *bm = vm->buffer_main;
355 vlib_buffer_free_list_t *f;
358 ASSERT (os_get_cpu_number () == 0);
360 if (!is_default && pool_elts (bm->buffer_free_list_pool) == 0)
362 u32 default_free_free_list_index;
365 default_free_free_list_index =
366 vlib_buffer_create_free_list_helper
368 /* default buffer size */ VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
373 ASSERT (default_free_free_list_index ==
374 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
376 if (n_data_bytes == VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES && is_public)
377 return default_free_free_list_index;
380 pool_get_aligned (bm->buffer_free_list_pool, f, CLIB_CACHE_LINE_BYTES);
382 memset (f, 0, sizeof (f[0]));
383 f->index = f - bm->buffer_free_list_pool;
384 f->n_data_bytes = vlib_buffer_round_size (n_data_bytes);
385 f->min_n_buffers_each_physmem_alloc = VLIB_FRAME_SIZE;
386 f->name = clib_mem_is_heap_object (name) ? name : format (0, "%s", name);
388 /* Setup free buffer template. */
389 f->buffer_init_template.free_list_index = f->index;
390 f->buffer_init_template.n_add_refs = 0;
394 uword *p = hash_get (bm->free_list_by_size, f->n_data_bytes);
396 hash_set (bm->free_list_by_size, f->n_data_bytes, f->index);
399 for (i = 1; i < vec_len (vlib_mains); i++)
401 vlib_buffer_main_t *wbm = vlib_mains[i]->buffer_main;
402 vlib_buffer_free_list_t *wf;
403 pool_get_aligned (wbm->buffer_free_list_pool,
404 wf, CLIB_CACHE_LINE_BYTES);
405 ASSERT (f - bm->buffer_free_list_pool ==
406 wf - wbm->buffer_free_list_pool);
416 vlib_buffer_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
423 name = va_format (0, fmt, &va);
426 return vlib_buffer_create_free_list_helper (vm, n_data_bytes,
433 vlib_buffer_get_or_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
436 u32 i = vlib_buffer_get_free_list_with_size (vm, n_data_bytes);
444 name = va_format (0, fmt, &va);
447 i = vlib_buffer_create_free_list_helper (vm, n_data_bytes,
457 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
461 for (i = 0; i < vec_len (f->buffer_memory_allocated); i++)
462 vm->os_physmem_free (f->buffer_memory_allocated[i]);
464 vec_free (f->buffer_memory_allocated);
465 vec_free (f->buffers);
468 /* Add buffer free list. */
470 vlib_buffer_delete_free_list_internal (vlib_main_t * vm, u32 free_list_index)
472 vlib_buffer_main_t *bm = vm->buffer_main;
473 vlib_buffer_free_list_t *f;
477 ASSERT (os_get_cpu_number () == 0);
479 f = vlib_buffer_get_free_list (vm, free_list_index);
481 ASSERT (vec_len (f->buffers) == f->n_alloc);
482 merge_index = vlib_buffer_get_free_list_with_size (vm, f->n_data_bytes);
483 if (merge_index != ~0 && merge_index != free_list_index)
485 vlib_buffer_merge_free_lists (pool_elt_at_index
486 (bm->buffer_free_list_pool, merge_index),
490 del_free_list (vm, f);
493 memset (f, 0xab, sizeof (f[0]));
495 pool_put (bm->buffer_free_list_pool, f);
497 for (i = 1; i < vec_len (vlib_mains); i++)
499 bm = vlib_mains[i]->buffer_main;
500 f = vlib_buffer_get_free_list (vlib_mains[i], free_list_index);;
501 memset (f, 0xab, sizeof (f[0]));
502 pool_put (bm->buffer_free_list_pool, f);
506 /* Make sure free list has at least given number of free buffers. */
508 fill_free_list (vlib_main_t * vm,
509 vlib_buffer_free_list_t * fl, uword min_free_buffers)
511 vlib_buffer_t *buffers, *b;
514 u32 n_remaining, n_alloc, n_this_chunk;
516 /* Already have enough free buffers on free list? */
517 n = min_free_buffers - vec_len (fl->buffers);
519 return min_free_buffers;
521 /* Always allocate round number of buffers. */
522 n = round_pow2 (n, CLIB_CACHE_LINE_BYTES / sizeof (u32));
524 /* Always allocate new buffers in reasonably large sized chunks. */
525 n = clib_max (n, fl->min_n_buffers_each_physmem_alloc);
529 while (n_remaining > 0)
531 n_this_chunk = clib_min (n_remaining, 16);
533 n_bytes = n_this_chunk * (sizeof (b[0]) + fl->n_data_bytes);
535 /* drb: removed power-of-2 ASSERT */
536 buffers = vm->os_physmem_alloc_aligned (&vm->physmem_main,
538 sizeof (vlib_buffer_t));
542 /* Record chunk as being allocated so we can free it later. */
543 vec_add1 (fl->buffer_memory_allocated, buffers);
545 fl->n_alloc += n_this_chunk;
546 n_alloc += n_this_chunk;
547 n_remaining -= n_this_chunk;
550 vec_add2_aligned (fl->buffers, bi, n_this_chunk, CLIB_CACHE_LINE_BYTES);
551 for (i = 0; i < n_this_chunk; i++)
553 bi[i] = vlib_get_buffer_index (vm, b);
556 vlib_buffer_set_known_state (vm, bi[i], VLIB_BUFFER_KNOWN_FREE);
557 b = vlib_buffer_next_contiguous (b, fl->n_data_bytes);
560 memset (buffers, 0, n_bytes);
562 /* Initialize all new buffers. */
564 for (i = 0; i < n_this_chunk; i++)
566 vlib_buffer_init_for_free_list (b, fl);
567 b = vlib_buffer_next_contiguous (b, fl->n_data_bytes);
570 if (fl->buffer_init_function)
571 fl->buffer_init_function (vm, fl, bi, n_this_chunk);
577 alloc_from_free_list (vlib_main_t * vm,
578 vlib_buffer_free_list_t * free_list,
579 u32 * alloc_buffers, u32 n_alloc_buffers)
587 /* wait with buffer memory allocation as long as possible
588 in case external buffer manager takes over */
589 if (PREDICT_FALSE (vm->os_physmem_alloc_aligned == 0))
590 unix_physmem_init (vm, 0 /* fail_if_physical_memory_not_present */ );
592 n_filled = fill_free_list (vm, free_list, n_alloc_buffers);
596 len = vec_len (free_list->buffers);
597 ASSERT (len >= n_alloc_buffers);
599 src = free_list->buffers + len - n_alloc_buffers;
600 clib_memcpy (dst, src, n_alloc_buffers * sizeof (u32));
602 _vec_len (free_list->buffers) -= n_alloc_buffers;
604 /* Verify that buffers are known free. */
605 vlib_buffer_validate_alloc_free (vm, alloc_buffers,
606 n_alloc_buffers, VLIB_BUFFER_KNOWN_FREE);
608 return n_alloc_buffers;
612 /* Allocate a given number of buffers into given array.
613 Returns number actually allocated which will be either zero or
616 vlib_buffer_alloc_internal (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
618 vlib_buffer_main_t *bm = vm->buffer_main;
620 return alloc_from_free_list
622 pool_elt_at_index (bm->buffer_free_list_pool,
623 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX),
628 vlib_buffer_alloc_from_free_list_internal (vlib_main_t * vm,
630 u32 n_buffers, u32 free_list_index)
632 vlib_buffer_main_t *bm = vm->buffer_main;
633 vlib_buffer_free_list_t *f;
634 f = pool_elt_at_index (bm->buffer_free_list_pool, free_list_index);
635 return alloc_from_free_list (vm, f, buffers, n_buffers);
639 vlib_set_buffer_free_callback (vlib_main_t * vm, void *fp)
641 vlib_buffer_main_t *bm = vm->buffer_main;
642 void *rv = bm->buffer_free_callback;
644 bm->buffer_free_callback = fp;
648 static_always_inline void
649 vlib_buffer_free_inline (vlib_main_t * vm,
650 u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
652 vlib_buffer_main_t *bm = vm->buffer_main;
653 vlib_buffer_free_list_t *fl;
656 u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
657 u32 follow_buffer_next);
659 cb = bm->buffer_free_callback;
661 if (PREDICT_FALSE (cb != 0))
662 n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
667 for (i = 0; i < n_buffers; i++)
672 b = vlib_get_buffer (vm, bi);
674 fl = vlib_buffer_get_buffer_free_list (vm, b, &fi);
676 /* The only current use of this callback: multicast recycle */
677 if (PREDICT_FALSE (fl->buffers_added_to_freelist_function != 0))
681 vlib_buffer_add_to_free_list
682 (vm, fl, buffers[i], (b->flags & VLIB_BUFFER_RECYCLE) == 0);
684 for (j = 0; j < vec_len (bm->announce_list); j++)
686 if (fl == bm->announce_list[j])
687 goto already_announced;
689 vec_add1 (bm->announce_list, fl);
695 if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_RECYCLE) == 0))
701 vlib_buffer_t *nb = vlib_get_buffer (vm, bi);
703 next = nb->next_buffer;
708 vlib_buffer_validate_alloc_free (vm, &bi, 1,
709 VLIB_BUFFER_KNOWN_ALLOCATED);
710 vlib_buffer_add_to_free_list (vm, fl, bi, 1);
714 while (follow_buffer_next
715 && (flags & VLIB_BUFFER_NEXT_PRESENT));
720 if (vec_len (bm->announce_list))
722 vlib_buffer_free_list_t *fl;
723 for (i = 0; i < vec_len (bm->announce_list); i++)
725 fl = bm->announce_list[i];
726 fl->buffers_added_to_freelist_function (vm, fl);
728 _vec_len (bm->announce_list) = 0;
733 vlib_buffer_free_internal (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
735 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
740 vlib_buffer_free_no_next_internal (vlib_main_t * vm, u32 * buffers,
743 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
747 /* Copy template packet data into buffers as they are allocated. */
748 static void __attribute__ ((unused))
749 vlib_packet_template_buffer_init (vlib_main_t * vm,
750 vlib_buffer_free_list_t * fl,
751 u32 * buffers, u32 n_buffers)
753 vlib_packet_template_t *t =
754 uword_to_pointer (fl->buffer_init_function_opaque,
755 vlib_packet_template_t *);
758 for (i = 0; i < n_buffers; i++)
760 vlib_buffer_t *b = vlib_get_buffer (vm, buffers[i]);
761 ASSERT (b->current_length == vec_len (t->packet_data));
762 clib_memcpy (vlib_buffer_get_current (b), t->packet_data,
768 vlib_packet_template_init (vlib_main_t * vm,
769 vlib_packet_template_t * t,
771 uword n_packet_data_bytes,
772 uword min_n_buffers_each_physmem_alloc,
775 vlib_buffer_main_t *bm = vm->buffer_main;
777 __attribute__ ((unused)) u8 *name;
778 vlib_buffer_free_list_t *fl;
781 name = va_format (0, fmt, &va);
784 if (bm->cb.vlib_packet_template_init_cb)
785 bm->cb.vlib_packet_template_init_cb (vm, (void *) t, packet_data,
787 min_n_buffers_each_physmem_alloc,
790 vlib_worker_thread_barrier_sync (vm);
792 memset (t, 0, sizeof (t[0]));
794 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
795 t->min_n_buffers_each_physmem_alloc = min_n_buffers_each_physmem_alloc;
797 t->free_list_index = vlib_buffer_create_free_list_helper
798 (vm, n_packet_data_bytes,
803 ASSERT (t->free_list_index != 0);
804 fl = vlib_buffer_get_free_list (vm, t->free_list_index);
805 fl->min_n_buffers_each_physmem_alloc = t->min_n_buffers_each_physmem_alloc;
807 fl->buffer_init_function = vlib_packet_template_buffer_init;
808 fl->buffer_init_function_opaque = pointer_to_uword (t);
810 fl->buffer_init_template.current_data = 0;
811 fl->buffer_init_template.current_length = n_packet_data_bytes;
812 fl->buffer_init_template.flags = 0;
813 fl->buffer_init_template.n_add_refs = 0;
814 vlib_worker_thread_barrier_release (vm);
818 vlib_packet_template_get_packet (vlib_main_t * vm,
819 vlib_packet_template_t * t, u32 * bi_result)
824 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
829 b = vlib_get_buffer (vm, bi);
830 clib_memcpy (vlib_buffer_get_current (b),
831 t->packet_data, vec_len (t->packet_data));
832 b->current_length = vec_len (t->packet_data);
838 vlib_packet_template_get_packet_helper (vlib_main_t * vm,
839 vlib_packet_template_t * t)
841 word n = t->min_n_buffers_each_physmem_alloc;
842 word l = vec_len (t->packet_data);
846 ASSERT (vec_len (t->free_buffers) == 0);
848 vec_validate (t->free_buffers, n - 1);
849 n_alloc = vlib_buffer_alloc_from_free_list (vm, t->free_buffers,
850 n, t->free_list_index);
851 _vec_len (t->free_buffers) = n_alloc;
854 /* Append given data to end of buffer, possibly allocating new buffers. */
856 vlib_buffer_add_data (vlib_main_t * vm,
858 u32 buffer_index, void *data, u32 n_data_bytes)
860 u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
866 && 1 != vlib_buffer_alloc_from_free_list (vm, &bi, 1, free_list_index))
870 n_left = n_data_bytes;
871 n_buffer_bytes = vlib_buffer_free_list_buffer_size (vm, free_list_index);
873 b = vlib_get_buffer (vm, bi);
874 b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
876 /* Get to the end of the chain before we try to append data... */
877 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
878 b = vlib_get_buffer (vm, b->next_buffer);
884 ASSERT (n_buffer_bytes >= b->current_length);
886 n_buffer_bytes - (b->current_data + b->current_length);
887 n = clib_min (n_left_this_buffer, n_left);
888 clib_memcpy (vlib_buffer_get_current (b) + b->current_length, d, n);
889 b->current_length += n;
896 vlib_buffer_alloc_from_free_list (vm, &b->next_buffer, 1,
900 b->flags |= VLIB_BUFFER_NEXT_PRESENT;
902 b = vlib_get_buffer (vm, b->next_buffer);
908 clib_error ("out of buffers");
913 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
915 vlib_buffer_t * first,
916 vlib_buffer_t ** last,
917 void *data, u16 data_len)
919 vlib_buffer_t *l = *last;
921 vlib_buffer_free_list_buffer_size (vm, free_list_index);
923 ASSERT (n_buffer_bytes >= l->current_length + l->current_data);
926 u16 max = n_buffer_bytes - l->current_length - l->current_data;
930 vlib_buffer_alloc_from_free_list (vm, &l->next_buffer, 1,
933 *last = l = vlib_buffer_chain_buffer (vm, first, l, l->next_buffer);
934 max = n_buffer_bytes - l->current_length - l->current_data;
937 u16 len = (data_len > max) ? max : data_len;
938 clib_memcpy (vlib_buffer_get_current (l) + l->current_length,
940 vlib_buffer_chain_increase_length (first, l, len);
949 format_vlib_buffer_free_list (u8 * s, va_list * va)
951 vlib_buffer_free_list_t *f = va_arg (*va, vlib_buffer_free_list_t *);
952 u32 threadnum = va_arg (*va, u32);
953 uword bytes_alloc, bytes_free, n_free, size;
956 return format (s, "%=7s%=30s%=12s%=12s%=12s%=12s%=12s%=12s",
957 "Thread", "Name", "Index", "Size", "Alloc", "Free",
960 size = sizeof (vlib_buffer_t) + f->n_data_bytes;
961 n_free = vec_len (f->buffers);
962 bytes_alloc = size * f->n_alloc;
963 bytes_free = size * n_free;
965 s = format (s, "%7d%30s%12d%12d%=12U%=12U%=12d%=12d", threadnum,
966 f->name, f->index, f->n_data_bytes,
967 format_memory_size, bytes_alloc,
968 format_memory_size, bytes_free, f->n_alloc, n_free);
973 static clib_error_t *
974 show_buffers (vlib_main_t * vm,
975 unformat_input_t * input, vlib_cli_command_t * cmd)
977 vlib_buffer_main_t *bm;
978 vlib_buffer_free_list_t *f;
979 vlib_main_t *curr_vm;
982 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, 0, 0);
986 curr_vm = vlib_mains[vm_index];
987 bm = curr_vm->buffer_main;
990 pool_foreach (f, bm->buffer_free_list_pool, ({
991 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, f, vm_index);
997 while (vm_index < vec_len (vlib_mains));
1003 VLIB_CLI_COMMAND (show_buffers_command, static) = {
1004 .path = "show buffers",
1005 .short_help = "Show packet buffer allocation",
1006 .function = show_buffers,
1011 vlib_buffer_cb_init (struct vlib_main_t *vm)
1013 vlib_buffer_main_t *bm = vm->buffer_main;
1014 bm->cb.vlib_buffer_alloc_cb = &vlib_buffer_alloc_internal;
1015 bm->cb.vlib_buffer_alloc_from_free_list_cb =
1016 &vlib_buffer_alloc_from_free_list_internal;
1017 bm->cb.vlib_buffer_free_cb = &vlib_buffer_free_internal;
1018 bm->cb.vlib_buffer_free_no_next_cb = &vlib_buffer_free_no_next_internal;
1019 bm->cb.vlib_buffer_delete_free_list_cb =
1020 &vlib_buffer_delete_free_list_internal;
1021 bm->extern_buffer_mgmt = 0;
1025 vlib_buffer_cb_register (struct vlib_main_t *vm, vlib_buffer_callbacks_t * cb)
1027 vlib_buffer_main_t *bm = vm->buffer_main;
1028 if (bm->extern_buffer_mgmt)
1031 #define _(x) bm->cb.x = cb->x
1032 _(vlib_buffer_alloc_cb);
1033 _(vlib_buffer_alloc_from_free_list_cb);
1034 _(vlib_buffer_free_cb);
1035 _(vlib_buffer_free_no_next_cb);
1036 _(vlib_buffer_delete_free_list_cb);
1038 bm->extern_buffer_mgmt = 1;
1044 * fd.io coding-style-patch-verification: ON
1047 * eval: (c-set-style "gnu")