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>
49 vlib_buffer_callbacks_t *vlib_buffer_callbacks = 0;
51 /* when running unpriviledged we are limited by RLIMIT_MEMLOCK which is
52 typically set to 16MB so setting default size for buffer memory to 14MB
54 static u32 vlib_buffer_physmem_sz = 14 << 20;
56 vlib_buffer_main_t buffer_main;
59 vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
60 vlib_buffer_t * b_first)
62 vlib_buffer_t *b = b_first;
63 uword l_first = b_first->current_length;
65 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
67 b = vlib_get_buffer (vm, b->next_buffer);
68 l += b->current_length;
70 b_first->total_length_not_including_first_buffer = l;
71 b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
76 format_vlib_buffer (u8 * s, va_list * args)
78 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
79 u32 indent = format_get_indent (s);
82 #define _(bit, name, v) \
83 if (v && (b->flags & VLIB_BUFFER_##name)) \
84 a = format (a, "%s ", v);
85 foreach_vlib_buffer_flag
87 s = format (s, "current data %d, length %d, free-list %d, clone-count %u",
88 b->current_data, b->current_length,
89 vlib_buffer_get_free_list_index (b), b->n_add_refs);
91 if (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID)
92 s = format (s, ", totlen-nifb %d",
93 b->total_length_not_including_first_buffer);
95 if (b->flags & VLIB_BUFFER_IS_TRACED)
96 s = format (s, ", trace 0x%x", b->trace_index);
99 s = format (s, "\n%U%v", format_white_space, indent, a);
102 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
104 vlib_main_t *vm = vlib_get_main ();
105 u32 next_buffer = b->next_buffer;
106 b = vlib_get_buffer (vm, next_buffer);
109 format (s, "\n%Unext-buffer 0x%x, segment length %d, clone-count %u",
110 format_white_space, indent, next_buffer, b->current_length,
118 format_vlib_buffer_and_data (u8 * s, va_list * args)
120 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
122 s = format (s, "%U, %U",
123 format_vlib_buffer, b,
124 format_hex_bytes, vlib_buffer_get_current (b), 64);
130 format_vlib_buffer_known_state (u8 * s, va_list * args)
132 vlib_buffer_known_state_t state = va_arg (*args, vlib_buffer_known_state_t);
137 case VLIB_BUFFER_UNKNOWN:
141 case VLIB_BUFFER_KNOWN_ALLOCATED:
142 t = "known-allocated";
145 case VLIB_BUFFER_KNOWN_FREE:
154 return format (s, "%s", t);
158 format_vlib_buffer_contents (u8 * s, va_list * va)
160 vlib_main_t *vm = va_arg (*va, vlib_main_t *);
161 vlib_buffer_t *b = va_arg (*va, vlib_buffer_t *);
165 vec_add (s, vlib_buffer_get_current (b), b->current_length);
166 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
168 b = vlib_get_buffer (vm, b->next_buffer);
175 vlib_validate_buffer_helper (vlib_main_t * vm,
177 uword follow_buffer_next, uword ** unique_hash)
179 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
180 vlib_buffer_free_list_t *fl;
182 if (pool_is_free_index
183 (vm->buffer_free_list_pool, vlib_buffer_get_free_list_index (b)))
184 return format (0, "unknown free list 0x%x",
185 vlib_buffer_get_free_list_index (b));
188 pool_elt_at_index (vm->buffer_free_list_pool,
189 vlib_buffer_get_free_list_index (b));
191 if ((signed) b->current_data < (signed) -VLIB_BUFFER_PRE_DATA_SIZE)
192 return format (0, "current data %d before pre-data", b->current_data);
194 if (b->current_data + b->current_length > fl->n_data_bytes)
195 return format (0, "%d-%d beyond end of buffer %d",
196 b->current_data, b->current_length, fl->n_data_bytes);
198 if (follow_buffer_next && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
200 vlib_buffer_known_state_t k;
203 k = vlib_buffer_is_known (b->next_buffer);
204 if (k != VLIB_BUFFER_KNOWN_ALLOCATED)
205 return format (0, "next 0x%x: %U",
206 b->next_buffer, format_vlib_buffer_known_state, k);
210 if (hash_get (*unique_hash, b->next_buffer))
211 return format (0, "duplicate buffer 0x%x", b->next_buffer);
213 hash_set1 (*unique_hash, b->next_buffer);
216 msg = vlib_validate_buffer (vm, b->next_buffer, follow_buffer_next);
219 result = format (0, "next 0x%x: %v", b->next_buffer, msg);
229 vlib_validate_buffer (vlib_main_t * vm, u32 bi, uword follow_buffer_next)
231 return vlib_validate_buffer_helper (vm, bi, follow_buffer_next,
232 /* unique_hash */ 0);
236 vlib_validate_buffers (vlib_main_t * vm,
238 uword next_buffer_stride,
240 vlib_buffer_known_state_t known_state,
241 uword follow_buffer_next)
244 u32 bi, *b = buffers;
245 vlib_buffer_known_state_t k;
246 u8 *msg = 0, *result = 0;
248 hash = hash_create (0, 0);
249 for (i = 0; i < n_buffers; i++)
252 b += next_buffer_stride;
254 /* Buffer is not unique. */
255 if (hash_get (hash, bi))
257 msg = format (0, "not unique");
261 k = vlib_buffer_is_known (bi);
262 if (k != known_state)
264 msg = format (0, "is %U; expected %U",
265 format_vlib_buffer_known_state, k,
266 format_vlib_buffer_known_state, known_state);
270 msg = vlib_validate_buffer_helper (vm, bi, follow_buffer_next, &hash);
274 hash_set1 (hash, bi);
280 result = format (0, "0x%x: %v", bi, msg);
288 * Hand-craft a static vector w/ length 1, so vec_len(vlib_mains) =1
289 * and vlib_mains[0] = &vlib_global_main from the beginning of time.
291 * The only place which should ever expand vlib_mains is start_workers()
292 * in threads.c. It knows about the bootstrap vector.
299 } __attribute__ ((packed)) __bootstrap_vlib_main_vector
300 __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES))) =
303 .vm = &vlib_global_main,
307 vlib_main_t **vlib_mains = &__bootstrap_vlib_main_vector.vm;
310 /* When dubugging validate that given buffers are either known allocated
313 vlib_buffer_validate_alloc_free (vlib_main_t * vm,
316 vlib_buffer_known_state_t expected_state)
319 uword i, bi, is_free;
324 if (vlib_buffer_callbacks)
327 is_free = expected_state == VLIB_BUFFER_KNOWN_ALLOCATED;
329 for (i = 0; i < n_buffers; i++)
331 vlib_buffer_known_state_t known;
335 known = vlib_buffer_is_known (bi);
336 if (known != expected_state)
340 (vm, "%s %U buffer 0x%x",
341 is_free ? "freeing" : "allocating",
342 format_vlib_buffer_known_state, known, bi);
345 vlib_buffer_set_known_state
346 (bi, is_free ? VLIB_BUFFER_KNOWN_FREE : VLIB_BUFFER_KNOWN_ALLOCATED);
350 /* Add buffer free list. */
351 static vlib_buffer_free_list_index_t
352 vlib_buffer_create_free_list_helper (vlib_main_t * vm,
354 u32 is_public, u32 is_default, u8 * name)
356 vlib_buffer_main_t *bm = &buffer_main;
357 vlib_buffer_free_list_t *f;
360 ASSERT (vlib_get_thread_index () == 0);
362 if (!is_default && pool_elts (vm->buffer_free_list_pool) == 0)
364 vlib_buffer_free_list_index_t default_free_free_list_index;
367 default_free_free_list_index =
368 vlib_buffer_create_free_list_helper
370 /* default buffer size */ VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
375 ASSERT (default_free_free_list_index ==
376 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
378 if (n_data_bytes == VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES && is_public)
379 return default_free_free_list_index;
382 pool_get_aligned (vm->buffer_free_list_pool, f, CLIB_CACHE_LINE_BYTES);
384 clib_memset (f, 0, sizeof (f[0]));
385 f->index = f - vm->buffer_free_list_pool;
386 f->n_data_bytes = vlib_buffer_round_size (n_data_bytes);
387 f->min_n_buffers_each_alloc = VLIB_FRAME_SIZE;
388 f->buffer_pool_index = 0;
389 f->name = clib_mem_is_vec (name) ? name : format (0, "%s", name);
391 /* Setup free buffer template. */
392 vlib_buffer_set_free_list_index (&f->buffer_init_template, f->index);
393 f->buffer_init_template.n_add_refs = 0;
397 uword *p = hash_get (bm->free_list_by_size, f->n_data_bytes);
399 hash_set (bm->free_list_by_size, f->n_data_bytes, f->index);
402 for (i = 1; i < vec_len (vlib_mains); i++)
404 vlib_main_t *wvm = vlib_mains[i];
405 vlib_buffer_free_list_t *wf;
406 pool_get_aligned (wvm->buffer_free_list_pool,
407 wf, CLIB_CACHE_LINE_BYTES);
408 ASSERT (f - vm->buffer_free_list_pool ==
409 wf - wvm->buffer_free_list_pool);
418 vlib_buffer_free_list_index_t
419 vlib_buffer_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
426 name = va_format (0, fmt, &va);
429 return vlib_buffer_create_free_list_helper (vm, n_data_bytes,
436 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
438 vlib_buffer_pool_t *bp = vlib_buffer_pool_get (f->buffer_pool_index);
440 vec_add_aligned (bp->buffers, f->buffers, vec_len (f->buffers),
441 CLIB_CACHE_LINE_BYTES);
443 vec_free (f->buffers);
446 clib_memset (f, 0xab, sizeof (f[0]));
449 /* Add buffer free list. */
451 vlib_buffer_delete_free_list_internal (vlib_main_t * vm,
452 vlib_buffer_free_list_index_t index)
454 vlib_buffer_free_list_t *f;
457 ASSERT (vlib_get_thread_index () == 0);
459 f = vlib_buffer_get_free_list (vm, index);
461 ASSERT (vec_len (f->buffers) == f->n_alloc);
463 del_free_list (vm, f);
465 pool_put (vm->buffer_free_list_pool, f);
467 for (i = 1; i < vec_len (vlib_mains); i++)
469 vlib_main_t *wvm = vlib_mains[i];
470 f = vlib_buffer_get_free_list (vlib_mains[i], index);
471 del_free_list (wvm, f);
472 pool_put (wvm->buffer_free_list_pool, f);
476 static_always_inline void *
477 vlib_buffer_pool_get_buffer (vlib_main_t * vm, vlib_buffer_pool_t * bp)
479 return vlib_physmem_alloc_from_map (vm, bp->physmem_map_index,
480 bp->buffer_size, CLIB_CACHE_LINE_BYTES);
483 /* Make sure free list has at least given number of free buffers. */
485 vlib_buffer_fill_free_list_internal (vlib_main_t * vm,
486 vlib_buffer_free_list_t * fl,
487 uword min_free_buffers)
490 vlib_buffer_pool_t *bp = vlib_buffer_pool_get (fl->buffer_pool_index);
495 /* Already have enough free buffers on free list? */
496 n = min_free_buffers - vec_len (fl->buffers);
498 return min_free_buffers;
500 if (vec_len (bp->buffers) > 0)
503 clib_spinlock_lock (&bp->lock);
504 n_copy = clib_min (vec_len (bp->buffers), n);
505 n_left = vec_len (bp->buffers) - n_copy;
506 vec_add_aligned (fl->buffers, bp->buffers + n_left, n_copy,
507 CLIB_CACHE_LINE_BYTES);
508 _vec_len (bp->buffers) = n_left;
509 clib_spinlock_unlock (&bp->lock);
510 n = min_free_buffers - vec_len (fl->buffers);
512 return min_free_buffers;
515 /* Always allocate round number of buffers. */
516 n = round_pow2 (n, CLIB_CACHE_LINE_BYTES / sizeof (u32));
518 /* Always allocate new buffers in reasonably large sized chunks. */
519 n = clib_max (n, fl->min_n_buffers_each_alloc);
521 clib_spinlock_lock (&bp->lock);
524 if ((b = vlib_buffer_pool_get_buffer (vm, bp)) == 0)
529 vec_add2_aligned (fl->buffers, bi, 1, CLIB_CACHE_LINE_BYTES);
530 bi[0] = vlib_get_buffer_index (vm, b);
533 vlib_buffer_set_known_state (bi[0], VLIB_BUFFER_KNOWN_FREE);
535 clib_memset (b, 0, sizeof (vlib_buffer_t));
536 vlib_buffer_init_for_free_list (b, fl);
538 if (fl->buffer_init_function)
539 fl->buffer_init_function (vm, fl, bi, 1);
543 clib_spinlock_unlock (&bp->lock);
544 fl->n_alloc += n_alloc;
549 vlib_set_buffer_free_callback (vlib_main_t * vm, void *fp)
551 vlib_buffer_main_t *bm = &buffer_main;
552 void *rv = bm->buffer_free_callback;
554 bm->buffer_free_callback = fp;
558 static_always_inline void
559 recycle_or_free (vlib_main_t * vm, vlib_buffer_main_t * bm, u32 bi,
560 vlib_buffer_t * b, u32 follow_buffer_next)
562 vlib_buffer_free_list_t *fl;
563 vlib_buffer_free_list_index_t fi;
566 fl = vlib_buffer_get_buffer_free_list (vm, b, &fi);
570 vlib_buffer_t *nb = vlib_get_buffer (vm, bi);
572 next = nb->next_buffer;
577 vlib_buffer_validate_alloc_free (vm, &bi, 1,
578 VLIB_BUFFER_KNOWN_ALLOCATED);
579 vlib_buffer_add_to_free_list (vm, fl, bi, 1);
583 while (follow_buffer_next && (flags & VLIB_BUFFER_NEXT_PRESENT));
586 static_always_inline void
587 vlib_buffer_free_inline (vlib_main_t * vm,
588 u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
590 vlib_buffer_main_t *bm = &buffer_main;
591 vlib_buffer_t *p, *b0, *b1, *b2, *b3;
593 u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
594 u32 follow_buffer_next);
596 cb = bm->buffer_free_callback;
598 if (PREDICT_FALSE (cb != 0))
599 n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
604 while (i + 11 < n_buffers)
606 p = vlib_get_buffer (vm, buffers[i + 8]);
607 vlib_prefetch_buffer_header (p, LOAD);
608 p = vlib_get_buffer (vm, buffers[i + 9]);
609 vlib_prefetch_buffer_header (p, LOAD);
610 p = vlib_get_buffer (vm, buffers[i + 10]);
611 vlib_prefetch_buffer_header (p, LOAD);
612 p = vlib_get_buffer (vm, buffers[i + 11]);
613 vlib_prefetch_buffer_header (p, LOAD);
615 b0 = vlib_get_buffer (vm, buffers[i]);
616 b1 = vlib_get_buffer (vm, buffers[i + 1]);
617 b2 = vlib_get_buffer (vm, buffers[i + 2]);
618 b3 = vlib_get_buffer (vm, buffers[i + 3]);
620 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
621 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
622 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b2);
623 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b3);
625 recycle_or_free (vm, bm, buffers[i], b0, follow_buffer_next);
626 recycle_or_free (vm, bm, buffers[i + 1], b1, follow_buffer_next);
627 recycle_or_free (vm, bm, buffers[i + 2], b2, follow_buffer_next);
628 recycle_or_free (vm, bm, buffers[i + 3], b3, follow_buffer_next);
633 while (i < n_buffers)
635 b0 = vlib_get_buffer (vm, buffers[i]);
636 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
637 recycle_or_free (vm, bm, buffers[i], b0, follow_buffer_next);
643 vlib_buffer_free_internal (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
645 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
650 vlib_buffer_free_no_next_internal (vlib_main_t * vm, u32 * buffers,
653 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
657 /* Copy template packet data into buffers as they are allocated. */
658 static void __attribute__ ((unused))
659 vlib_packet_template_buffer_init (vlib_main_t * vm,
660 vlib_buffer_free_list_t * fl,
661 u32 * buffers, u32 n_buffers)
663 vlib_packet_template_t *t =
664 uword_to_pointer (fl->buffer_init_function_opaque,
665 vlib_packet_template_t *);
668 for (i = 0; i < n_buffers; i++)
670 vlib_buffer_t *b = vlib_get_buffer (vm, buffers[i]);
671 ASSERT (b->current_length == vec_len (t->packet_data));
672 clib_memcpy (vlib_buffer_get_current (b), t->packet_data,
678 vlib_packet_template_init (vlib_main_t * vm,
679 vlib_packet_template_t * t,
681 uword n_packet_data_bytes,
682 uword min_n_buffers_each_alloc, char *fmt, ...)
684 vlib_buffer_main_t *bm = &buffer_main;
687 vlib_buffer_free_list_t *fl;
690 name = va_format (0, fmt, &va);
693 if (bm->cb.vlib_packet_template_init_cb)
694 bm->cb.vlib_packet_template_init_cb (vm, (void *) t, packet_data,
696 min_n_buffers_each_alloc, name);
698 vlib_worker_thread_barrier_sync (vm);
700 clib_memset (t, 0, sizeof (t[0]));
702 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
703 t->min_n_buffers_each_alloc = min_n_buffers_each_alloc;
705 t->free_list_index = vlib_buffer_create_free_list_helper
706 (vm, n_packet_data_bytes,
711 ASSERT (t->free_list_index != 0);
712 fl = vlib_buffer_get_free_list (vm, t->free_list_index);
713 fl->min_n_buffers_each_alloc = t->min_n_buffers_each_alloc;
715 fl->buffer_init_function = vlib_packet_template_buffer_init;
716 fl->buffer_init_function_opaque = pointer_to_uword (t);
718 fl->buffer_init_template.current_data = 0;
719 fl->buffer_init_template.current_length = n_packet_data_bytes;
720 fl->buffer_init_template.flags = 0;
721 fl->buffer_init_template.n_add_refs = 0;
722 vlib_worker_thread_barrier_release (vm);
726 vlib_packet_template_get_packet (vlib_main_t * vm,
727 vlib_packet_template_t * t, u32 * bi_result)
732 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
737 b = vlib_get_buffer (vm, bi);
738 clib_memcpy (vlib_buffer_get_current (b),
739 t->packet_data, vec_len (t->packet_data));
740 b->current_length = vec_len (t->packet_data);
746 vlib_packet_template_get_packet_helper (vlib_main_t * vm,
747 vlib_packet_template_t * t)
749 word n = t->min_n_buffers_each_alloc;
750 word l = vec_len (t->packet_data);
754 ASSERT (vec_len (t->free_buffers) == 0);
756 vec_validate (t->free_buffers, n - 1);
757 n_alloc = vlib_buffer_alloc_from_free_list (vm, t->free_buffers,
758 n, t->free_list_index);
759 _vec_len (t->free_buffers) = n_alloc;
762 /* Append given data to end of buffer, possibly allocating new buffers. */
764 vlib_buffer_add_data (vlib_main_t * vm,
765 vlib_buffer_free_list_index_t free_list_index,
766 u32 buffer_index, void *data, u32 n_data_bytes)
768 u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
774 && 1 != vlib_buffer_alloc_from_free_list (vm, &bi, 1, free_list_index))
778 n_left = n_data_bytes;
779 n_buffer_bytes = vlib_buffer_free_list_buffer_size (vm, free_list_index);
781 b = vlib_get_buffer (vm, bi);
782 b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
784 /* Get to the end of the chain before we try to append data... */
785 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
786 b = vlib_get_buffer (vm, b->next_buffer);
792 ASSERT (n_buffer_bytes >= b->current_length);
794 n_buffer_bytes - (b->current_data + b->current_length);
795 n = clib_min (n_left_this_buffer, n_left);
796 clib_memcpy (vlib_buffer_get_current (b) + b->current_length, d, n);
797 b->current_length += n;
804 vlib_buffer_alloc_from_free_list (vm, &b->next_buffer, 1,
808 b->flags |= VLIB_BUFFER_NEXT_PRESENT;
810 b = vlib_get_buffer (vm, b->next_buffer);
816 clib_error ("out of buffers");
821 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
822 vlib_buffer_free_list_index_t
824 vlib_buffer_t * first,
825 vlib_buffer_t ** last, void *data,
828 vlib_buffer_t *l = *last;
830 vlib_buffer_free_list_buffer_size (vm, free_list_index);
832 ASSERT (n_buffer_bytes >= l->current_length + l->current_data);
835 u16 max = n_buffer_bytes - l->current_length - l->current_data;
839 vlib_buffer_alloc_from_free_list (vm, &l->next_buffer, 1,
842 *last = l = vlib_buffer_chain_buffer (vm, first, l, l->next_buffer);
843 max = n_buffer_bytes - l->current_length - l->current_data;
846 u16 len = (data_len > max) ? max : data_len;
847 clib_memcpy (vlib_buffer_get_current (l) + l->current_length,
849 vlib_buffer_chain_increase_length (first, l, len);
857 vlib_buffer_register_physmem_map (vlib_main_t * vm, u32 physmem_map_index)
859 vlib_buffer_main_t *bm = &buffer_main;
860 vlib_buffer_pool_t *p;
861 vlib_physmem_map_t *m = vlib_physmem_get_map (vm, physmem_map_index);
862 uword start = pointer_to_uword (m->base);
863 uword size = m->n_pages << m->log2_page_size;
865 if (bm->buffer_mem_size == 0)
867 bm->buffer_mem_start = start;
868 bm->buffer_mem_size = size;
870 else if (start < bm->buffer_mem_start)
872 bm->buffer_mem_size += bm->buffer_mem_start - start;
873 bm->buffer_mem_start = start;
874 if (size > bm->buffer_mem_size)
875 bm->buffer_mem_size = size;
877 else if (start > bm->buffer_mem_start)
879 uword new_size = start - bm->buffer_mem_start + size;
880 if (new_size > bm->buffer_mem_size)
881 bm->buffer_mem_size = new_size;
884 if ((u64) bm->buffer_mem_size >
885 ((u64) 1 << (32 + CLIB_LOG2_CACHE_LINE_BYTES)))
887 clib_panic ("buffer memory size out of range!");
890 vec_add2 (bm->buffer_pools, p, 1);
893 p->physmem_map_index = physmem_map_index;
895 ASSERT (p - bm->buffer_pools < 256);
896 return p - bm->buffer_pools;
900 format_vlib_buffer_free_list (u8 * s, va_list * va)
902 vlib_buffer_free_list_t *f = va_arg (*va, vlib_buffer_free_list_t *);
903 u32 threadnum = va_arg (*va, u32);
904 uword bytes_alloc, bytes_free, n_free, size;
907 return format (s, "%=7s%=30s%=12s%=12s%=12s%=12s%=12s%=12s",
908 "Thread", "Name", "Index", "Size", "Alloc", "Free",
911 size = sizeof (vlib_buffer_t) + f->n_data_bytes;
912 n_free = vec_len (f->buffers);
913 bytes_alloc = size * f->n_alloc;
914 bytes_free = size * n_free;
916 s = format (s, "%7d%30v%12d%12d%=12U%=12U%=12d%=12d", threadnum,
917 f->name, f->index, f->n_data_bytes,
918 format_memory_size, bytes_alloc,
919 format_memory_size, bytes_free, f->n_alloc, n_free);
924 static clib_error_t *
925 show_buffers (vlib_main_t * vm,
926 unformat_input_t * input, vlib_cli_command_t * cmd)
928 vlib_buffer_free_list_t *f;
929 vlib_main_t *curr_vm;
932 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, 0, 0);
936 curr_vm = vlib_mains[vm_index];
939 pool_foreach (f, curr_vm->buffer_free_list_pool, ({
940 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, f, vm_index);
946 while (vm_index < vec_len (vlib_mains));
952 VLIB_CLI_COMMAND (show_buffers_command, static) = {
953 .path = "show buffers",
954 .short_help = "Show packet buffer allocation",
955 .function = show_buffers,
960 vlib_buffer_main_init (struct vlib_main_t * vm)
962 vlib_buffer_main_t *bm = &buffer_main;
964 u32 physmem_map_index;
967 if (vlib_buffer_callbacks)
969 /* external plugin has registered own buffer callbacks
970 so we just copy them and quit */
971 clib_memcpy (&bm->cb, vlib_buffer_callbacks,
972 sizeof (vlib_buffer_callbacks_t));
973 bm->callbacks_registered = 1;
977 bm->cb.vlib_buffer_fill_free_list_cb = &vlib_buffer_fill_free_list_internal;
978 bm->cb.vlib_buffer_free_cb = &vlib_buffer_free_internal;
979 bm->cb.vlib_buffer_free_no_next_cb = &vlib_buffer_free_no_next_internal;
980 bm->cb.vlib_buffer_delete_free_list_cb =
981 &vlib_buffer_delete_free_list_internal;
982 clib_spinlock_init (&bm->buffer_known_hash_lockp);
984 if ((error = vlib_physmem_shared_map_create (vm, "buffers",
985 vlib_buffer_physmem_sz,
986 CLIB_PMALLOC_NUMA_LOCAL,
987 &physmem_map_index)))
990 pool_index = vlib_buffer_register_physmem_map (vm, physmem_map_index);
991 vlib_buffer_pool_t *bp = vlib_buffer_pool_get (pool_index);
992 clib_spinlock_init (&bp->lock);
993 bp->buffer_size = VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES +
994 sizeof (vlib_buffer_t);
999 static clib_error_t *
1000 vlib_buffers_configure (vlib_main_t * vm, unformat_input_t * input)
1004 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1006 if (unformat (input, "memory-size-in-mb %d", &size_in_mb))
1007 vlib_buffer_physmem_sz = size_in_mb << 20;
1009 return unformat_parse_error (input);
1012 unformat_free (input);
1016 VLIB_EARLY_CONFIG_FUNCTION (vlib_buffers_configure, "buffers");
1021 * fd.io coding-style-patch-verification: ON
1024 * eval: (c-set-style "gnu")