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 static vlib_log_class_t buffer_log_default;
62 vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
63 vlib_buffer_t * b_first)
65 vlib_buffer_t *b = b_first;
66 uword l_first = b_first->current_length;
68 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
70 b = vlib_get_buffer (vm, b->next_buffer);
71 l += b->current_length;
73 b_first->total_length_not_including_first_buffer = l;
74 b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
79 format_vlib_buffer (u8 * s, va_list * args)
81 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
82 u32 indent = format_get_indent (s);
85 #define _(bit, name, v) \
86 if (v && (b->flags & VLIB_BUFFER_##name)) \
87 a = format (a, "%s ", v);
88 foreach_vlib_buffer_flag
90 s = format (s, "current data %d, length %d, free-list %d, clone-count %u",
91 b->current_data, b->current_length,
92 vlib_buffer_get_free_list_index (b), b->n_add_refs);
94 if (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID)
95 s = format (s, ", totlen-nifb %d",
96 b->total_length_not_including_first_buffer);
98 if (b->flags & VLIB_BUFFER_IS_TRACED)
99 s = format (s, ", trace 0x%x", b->trace_index);
102 s = format (s, "\n%U%v", format_white_space, indent, a);
105 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
107 vlib_main_t *vm = vlib_get_main ();
108 u32 next_buffer = b->next_buffer;
109 b = vlib_get_buffer (vm, next_buffer);
112 format (s, "\n%Unext-buffer 0x%x, segment length %d, clone-count %u",
113 format_white_space, indent, next_buffer, b->current_length,
121 format_vlib_buffer_and_data (u8 * s, va_list * args)
123 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
125 s = format (s, "%U, %U",
126 format_vlib_buffer, b,
127 format_hex_bytes, vlib_buffer_get_current (b), 64);
133 format_vlib_buffer_known_state (u8 * s, va_list * args)
135 vlib_buffer_known_state_t state = va_arg (*args, vlib_buffer_known_state_t);
140 case VLIB_BUFFER_UNKNOWN:
144 case VLIB_BUFFER_KNOWN_ALLOCATED:
145 t = "known-allocated";
148 case VLIB_BUFFER_KNOWN_FREE:
157 return format (s, "%s", t);
161 format_vlib_buffer_contents (u8 * s, va_list * va)
163 vlib_main_t *vm = va_arg (*va, vlib_main_t *);
164 vlib_buffer_t *b = va_arg (*va, vlib_buffer_t *);
168 vec_add (s, vlib_buffer_get_current (b), b->current_length);
169 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
171 b = vlib_get_buffer (vm, b->next_buffer);
178 vlib_validate_buffer_helper (vlib_main_t * vm,
180 uword follow_buffer_next, uword ** unique_hash)
182 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
183 vlib_buffer_free_list_t *fl;
185 if (pool_is_free_index
186 (vm->buffer_free_list_pool, vlib_buffer_get_free_list_index (b)))
187 return format (0, "unknown free list 0x%x",
188 vlib_buffer_get_free_list_index (b));
191 pool_elt_at_index (vm->buffer_free_list_pool,
192 vlib_buffer_get_free_list_index (b));
194 if ((signed) b->current_data < (signed) -VLIB_BUFFER_PRE_DATA_SIZE)
195 return format (0, "current data %d before pre-data", b->current_data);
197 if (b->current_data + b->current_length > fl->n_data_bytes)
198 return format (0, "%d-%d beyond end of buffer %d",
199 b->current_data, b->current_length, fl->n_data_bytes);
201 if (follow_buffer_next && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
203 vlib_buffer_known_state_t k;
206 k = vlib_buffer_is_known (b->next_buffer);
207 if (k != VLIB_BUFFER_KNOWN_ALLOCATED)
208 return format (0, "next 0x%x: %U",
209 b->next_buffer, format_vlib_buffer_known_state, k);
213 if (hash_get (*unique_hash, b->next_buffer))
214 return format (0, "duplicate buffer 0x%x", b->next_buffer);
216 hash_set1 (*unique_hash, b->next_buffer);
219 msg = vlib_validate_buffer (vm, b->next_buffer, follow_buffer_next);
222 result = format (0, "next 0x%x: %v", b->next_buffer, msg);
232 vlib_validate_buffer (vlib_main_t * vm, u32 bi, uword follow_buffer_next)
234 return vlib_validate_buffer_helper (vm, bi, follow_buffer_next,
235 /* unique_hash */ 0);
239 vlib_validate_buffers (vlib_main_t * vm,
241 uword next_buffer_stride,
243 vlib_buffer_known_state_t known_state,
244 uword follow_buffer_next)
247 u32 bi, *b = buffers;
248 vlib_buffer_known_state_t k;
249 u8 *msg = 0, *result = 0;
251 hash = hash_create (0, 0);
252 for (i = 0; i < n_buffers; i++)
255 b += next_buffer_stride;
257 /* Buffer is not unique. */
258 if (hash_get (hash, bi))
260 msg = format (0, "not unique");
264 k = vlib_buffer_is_known (bi);
265 if (k != known_state)
267 msg = format (0, "is %U; expected %U",
268 format_vlib_buffer_known_state, k,
269 format_vlib_buffer_known_state, known_state);
273 msg = vlib_validate_buffer_helper (vm, bi, follow_buffer_next, &hash);
277 hash_set1 (hash, bi);
283 result = format (0, "0x%x: %v", bi, msg);
291 * Hand-craft a static vector w/ length 1, so vec_len(vlib_mains) =1
292 * and vlib_mains[0] = &vlib_global_main from the beginning of time.
294 * The only place which should ever expand vlib_mains is start_workers()
295 * in threads.c. It knows about the bootstrap vector.
302 } __attribute__ ((packed)) __bootstrap_vlib_main_vector
303 __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES))) =
306 .vm = &vlib_global_main,
310 vlib_main_t **vlib_mains = &__bootstrap_vlib_main_vector.vm;
313 /* When dubugging validate that given buffers are either known allocated
316 vlib_buffer_validate_alloc_free (vlib_main_t * vm,
319 vlib_buffer_known_state_t expected_state)
322 uword i, bi, is_free;
327 if (vlib_buffer_callbacks)
330 is_free = expected_state == VLIB_BUFFER_KNOWN_ALLOCATED;
332 for (i = 0; i < n_buffers; i++)
334 vlib_buffer_known_state_t known;
338 known = vlib_buffer_is_known (bi);
339 if (known != expected_state)
343 (vm, "%s %U buffer 0x%x",
344 is_free ? "freeing" : "allocating",
345 format_vlib_buffer_known_state, known, bi);
348 vlib_buffer_set_known_state
349 (bi, is_free ? VLIB_BUFFER_KNOWN_FREE : VLIB_BUFFER_KNOWN_ALLOCATED);
353 /* Add buffer free list. */
354 static vlib_buffer_free_list_index_t
355 vlib_buffer_create_free_list_helper (vlib_main_t * vm,
357 u32 is_public, u32 is_default, u8 * name)
359 vlib_buffer_main_t *bm = &buffer_main;
360 vlib_buffer_free_list_t *f;
363 ASSERT (vlib_get_thread_index () == 0);
365 if (!is_default && pool_elts (vm->buffer_free_list_pool) == 0)
367 vlib_buffer_free_list_index_t default_free_free_list_index;
370 default_free_free_list_index =
371 vlib_buffer_create_free_list_helper
373 /* default buffer size */ VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
378 ASSERT (default_free_free_list_index ==
379 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
381 if (n_data_bytes == VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES && is_public)
382 return default_free_free_list_index;
385 pool_get_aligned (vm->buffer_free_list_pool, f, CLIB_CACHE_LINE_BYTES);
387 clib_memset (f, 0, sizeof (f[0]));
388 f->index = f - vm->buffer_free_list_pool;
389 f->n_data_bytes = vlib_buffer_round_size (n_data_bytes);
390 f->min_n_buffers_each_alloc = VLIB_FRAME_SIZE;
391 f->buffer_pool_index = 0;
392 f->name = clib_mem_is_vec (name) ? name : format (0, "%s", name);
394 /* Setup free buffer template. */
395 vlib_buffer_set_free_list_index (&f->buffer_init_template, f->index);
396 f->buffer_init_template.n_add_refs = 0;
400 uword *p = hash_get (bm->free_list_by_size, f->n_data_bytes);
402 hash_set (bm->free_list_by_size, f->n_data_bytes, f->index);
405 for (i = 1; i < vec_len (vlib_mains); i++)
407 vlib_main_t *wvm = vlib_mains[i];
408 vlib_buffer_free_list_t *wf;
409 pool_get_aligned (wvm->buffer_free_list_pool,
410 wf, CLIB_CACHE_LINE_BYTES);
411 ASSERT (f - vm->buffer_free_list_pool ==
412 wf - wvm->buffer_free_list_pool);
421 vlib_buffer_free_list_index_t
422 vlib_buffer_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
429 name = va_format (0, fmt, &va);
432 return vlib_buffer_create_free_list_helper (vm, n_data_bytes,
439 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
441 vlib_buffer_pool_t *bp = vlib_buffer_pool_get (f->buffer_pool_index);
443 vec_add_aligned (bp->buffers, f->buffers, vec_len (f->buffers),
444 CLIB_CACHE_LINE_BYTES);
446 vec_free (f->buffers);
449 clib_memset (f, 0xab, sizeof (f[0]));
452 /* Add buffer free list. */
454 vlib_buffer_delete_free_list_internal (vlib_main_t * vm,
455 vlib_buffer_free_list_index_t index)
457 vlib_buffer_free_list_t *f;
460 ASSERT (vlib_get_thread_index () == 0);
462 f = vlib_buffer_get_free_list (vm, index);
464 ASSERT (vec_len (f->buffers) == f->n_alloc);
466 del_free_list (vm, f);
468 pool_put (vm->buffer_free_list_pool, f);
470 for (i = 1; i < vec_len (vlib_mains); i++)
472 vlib_main_t *wvm = vlib_mains[i];
473 f = vlib_buffer_get_free_list (vlib_mains[i], index);
474 del_free_list (wvm, f);
475 pool_put (wvm->buffer_free_list_pool, f);
479 static_always_inline void *
480 vlib_buffer_pool_get_buffer (vlib_main_t * vm, vlib_buffer_pool_t * bp)
482 return vlib_physmem_alloc_from_map (vm, bp->physmem_map_index,
483 bp->buffer_size, CLIB_CACHE_LINE_BYTES);
486 /* Make sure free list has at least given number of free buffers. */
488 vlib_buffer_fill_free_list_internal (vlib_main_t * vm,
489 vlib_buffer_free_list_t * fl,
490 uword min_free_buffers)
493 vlib_buffer_pool_t *bp = vlib_buffer_pool_get (fl->buffer_pool_index);
498 /* Already have enough free buffers on free list? */
499 n = min_free_buffers - vec_len (fl->buffers);
501 return min_free_buffers;
503 if (vec_len (bp->buffers) > 0)
506 clib_spinlock_lock (&bp->lock);
507 n_copy = clib_min (vec_len (bp->buffers), n);
508 n_left = vec_len (bp->buffers) - n_copy;
509 vec_add_aligned (fl->buffers, bp->buffers + n_left, n_copy,
510 CLIB_CACHE_LINE_BYTES);
511 _vec_len (bp->buffers) = n_left;
512 clib_spinlock_unlock (&bp->lock);
513 n = min_free_buffers - vec_len (fl->buffers);
515 return min_free_buffers;
518 /* Always allocate round number of buffers. */
519 n = round_pow2 (n, CLIB_CACHE_LINE_BYTES / sizeof (u32));
521 /* Always allocate new buffers in reasonably large sized chunks. */
522 n = clib_max (n, fl->min_n_buffers_each_alloc);
524 clib_spinlock_lock (&bp->lock);
527 if ((b = vlib_buffer_pool_get_buffer (vm, bp)) == 0)
532 vec_add2_aligned (fl->buffers, bi, 1, CLIB_CACHE_LINE_BYTES);
533 bi[0] = vlib_get_buffer_index (vm, b);
536 vlib_buffer_set_known_state (bi[0], VLIB_BUFFER_KNOWN_FREE);
538 clib_memset (b, 0, sizeof (vlib_buffer_t));
539 vlib_buffer_init_for_free_list (b, fl);
541 if (fl->buffer_init_function)
542 fl->buffer_init_function (vm, fl, bi, 1);
546 clib_spinlock_unlock (&bp->lock);
547 fl->n_alloc += n_alloc;
552 vlib_set_buffer_free_callback (vlib_main_t * vm, void *fp)
554 vlib_buffer_main_t *bm = &buffer_main;
555 void *rv = bm->buffer_free_callback;
557 bm->buffer_free_callback = fp;
561 static_always_inline void
562 recycle_or_free (vlib_main_t * vm, vlib_buffer_main_t * bm, u32 bi,
563 vlib_buffer_t * b, u32 follow_buffer_next)
565 vlib_buffer_free_list_t *fl;
566 vlib_buffer_free_list_index_t fi;
569 fl = vlib_buffer_get_buffer_free_list (vm, b, &fi);
573 vlib_buffer_t *nb = vlib_get_buffer (vm, bi);
575 next = nb->next_buffer;
580 vlib_buffer_validate_alloc_free (vm, &bi, 1,
581 VLIB_BUFFER_KNOWN_ALLOCATED);
582 vlib_buffer_add_to_free_list (vm, fl, bi, 1);
586 while (follow_buffer_next && (flags & VLIB_BUFFER_NEXT_PRESENT));
589 static_always_inline void
590 vlib_buffer_free_inline (vlib_main_t * vm,
591 u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
593 vlib_buffer_main_t *bm = &buffer_main;
594 vlib_buffer_t *p, *b0, *b1, *b2, *b3;
596 u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
597 u32 follow_buffer_next);
599 cb = bm->buffer_free_callback;
601 if (PREDICT_FALSE (cb != 0))
602 n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
607 while (i + 11 < n_buffers)
609 p = vlib_get_buffer (vm, buffers[i + 8]);
610 vlib_prefetch_buffer_header (p, LOAD);
611 p = vlib_get_buffer (vm, buffers[i + 9]);
612 vlib_prefetch_buffer_header (p, LOAD);
613 p = vlib_get_buffer (vm, buffers[i + 10]);
614 vlib_prefetch_buffer_header (p, LOAD);
615 p = vlib_get_buffer (vm, buffers[i + 11]);
616 vlib_prefetch_buffer_header (p, LOAD);
618 b0 = vlib_get_buffer (vm, buffers[i]);
619 b1 = vlib_get_buffer (vm, buffers[i + 1]);
620 b2 = vlib_get_buffer (vm, buffers[i + 2]);
621 b3 = vlib_get_buffer (vm, buffers[i + 3]);
623 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
624 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
625 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b2);
626 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b3);
628 recycle_or_free (vm, bm, buffers[i], b0, follow_buffer_next);
629 recycle_or_free (vm, bm, buffers[i + 1], b1, follow_buffer_next);
630 recycle_or_free (vm, bm, buffers[i + 2], b2, follow_buffer_next);
631 recycle_or_free (vm, bm, buffers[i + 3], b3, follow_buffer_next);
636 while (i < n_buffers)
638 b0 = vlib_get_buffer (vm, buffers[i]);
639 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
640 recycle_or_free (vm, bm, buffers[i], b0, follow_buffer_next);
646 vlib_buffer_free_internal (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
648 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
653 vlib_buffer_free_no_next_internal (vlib_main_t * vm, u32 * buffers,
656 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
660 /* Copy template packet data into buffers as they are allocated. */
661 static void __attribute__ ((unused))
662 vlib_packet_template_buffer_init (vlib_main_t * vm,
663 vlib_buffer_free_list_t * fl,
664 u32 * buffers, u32 n_buffers)
666 vlib_packet_template_t *t =
667 uword_to_pointer (fl->buffer_init_function_opaque,
668 vlib_packet_template_t *);
671 for (i = 0; i < n_buffers; i++)
673 vlib_buffer_t *b = vlib_get_buffer (vm, buffers[i]);
674 ASSERT (b->current_length == vec_len (t->packet_data));
675 clib_memcpy (vlib_buffer_get_current (b), t->packet_data,
681 vlib_packet_template_init (vlib_main_t * vm,
682 vlib_packet_template_t * t,
684 uword n_packet_data_bytes,
685 uword min_n_buffers_each_alloc, char *fmt, ...)
687 vlib_buffer_main_t *bm = &buffer_main;
690 vlib_buffer_free_list_t *fl;
693 name = va_format (0, fmt, &va);
696 if (bm->cb.vlib_packet_template_init_cb)
697 bm->cb.vlib_packet_template_init_cb (vm, (void *) t, packet_data,
699 min_n_buffers_each_alloc, name);
701 vlib_worker_thread_barrier_sync (vm);
703 clib_memset (t, 0, sizeof (t[0]));
705 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
706 t->min_n_buffers_each_alloc = min_n_buffers_each_alloc;
708 t->free_list_index = vlib_buffer_create_free_list_helper
709 (vm, n_packet_data_bytes,
714 ASSERT (t->free_list_index != 0);
715 fl = vlib_buffer_get_free_list (vm, t->free_list_index);
716 fl->min_n_buffers_each_alloc = t->min_n_buffers_each_alloc;
718 fl->buffer_init_function = vlib_packet_template_buffer_init;
719 fl->buffer_init_function_opaque = pointer_to_uword (t);
721 fl->buffer_init_template.current_data = 0;
722 fl->buffer_init_template.current_length = n_packet_data_bytes;
723 fl->buffer_init_template.flags = 0;
724 fl->buffer_init_template.n_add_refs = 0;
725 vlib_worker_thread_barrier_release (vm);
729 vlib_packet_template_get_packet (vlib_main_t * vm,
730 vlib_packet_template_t * t, u32 * bi_result)
735 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
740 b = vlib_get_buffer (vm, bi);
741 clib_memcpy (vlib_buffer_get_current (b),
742 t->packet_data, vec_len (t->packet_data));
743 b->current_length = vec_len (t->packet_data);
749 vlib_packet_template_get_packet_helper (vlib_main_t * vm,
750 vlib_packet_template_t * t)
752 word n = t->min_n_buffers_each_alloc;
753 word l = vec_len (t->packet_data);
757 ASSERT (vec_len (t->free_buffers) == 0);
759 vec_validate (t->free_buffers, n - 1);
760 n_alloc = vlib_buffer_alloc_from_free_list (vm, t->free_buffers,
761 n, t->free_list_index);
762 _vec_len (t->free_buffers) = n_alloc;
765 /* Append given data to end of buffer, possibly allocating new buffers. */
767 vlib_buffer_add_data (vlib_main_t * vm,
768 vlib_buffer_free_list_index_t free_list_index,
769 u32 buffer_index, void *data, u32 n_data_bytes)
771 u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
777 && 1 != vlib_buffer_alloc_from_free_list (vm, &bi, 1, free_list_index))
781 n_left = n_data_bytes;
782 n_buffer_bytes = vlib_buffer_free_list_buffer_size (vm, free_list_index);
784 b = vlib_get_buffer (vm, bi);
785 b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
787 /* Get to the end of the chain before we try to append data... */
788 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
789 b = vlib_get_buffer (vm, b->next_buffer);
795 ASSERT (n_buffer_bytes >= b->current_length);
797 n_buffer_bytes - (b->current_data + b->current_length);
798 n = clib_min (n_left_this_buffer, n_left);
799 clib_memcpy (vlib_buffer_get_current (b) + b->current_length, d, n);
800 b->current_length += n;
807 vlib_buffer_alloc_from_free_list (vm, &b->next_buffer, 1,
811 b->flags |= VLIB_BUFFER_NEXT_PRESENT;
813 b = vlib_get_buffer (vm, b->next_buffer);
819 clib_error ("out of buffers");
824 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
825 vlib_buffer_free_list_index_t
827 vlib_buffer_t * first,
828 vlib_buffer_t ** last, void *data,
831 vlib_buffer_t *l = *last;
833 vlib_buffer_free_list_buffer_size (vm, free_list_index);
835 ASSERT (n_buffer_bytes >= l->current_length + l->current_data);
838 u16 max = n_buffer_bytes - l->current_length - l->current_data;
842 vlib_buffer_alloc_from_free_list (vm, &l->next_buffer, 1,
845 *last = l = vlib_buffer_chain_buffer (vm, first, l, l->next_buffer);
846 max = n_buffer_bytes - l->current_length - l->current_data;
849 u16 len = (data_len > max) ? max : data_len;
850 clib_memcpy (vlib_buffer_get_current (l) + l->current_length,
852 vlib_buffer_chain_increase_length (first, l, len);
860 vlib_buffer_register_physmem_map (vlib_main_t * vm, u32 physmem_map_index)
862 vlib_buffer_main_t *bm = &buffer_main;
863 vlib_buffer_pool_t *p;
864 vlib_physmem_map_t *m = vlib_physmem_get_map (vm, physmem_map_index);
865 uword start = pointer_to_uword (m->base);
866 uword size = (uword) m->n_pages << m->log2_page_size;
868 if (bm->buffer_mem_size == 0)
870 bm->buffer_mem_start = start;
871 bm->buffer_mem_size = size;
873 else if (start < bm->buffer_mem_start)
875 bm->buffer_mem_size += bm->buffer_mem_start - start;
876 bm->buffer_mem_start = start;
877 if (size > bm->buffer_mem_size)
878 bm->buffer_mem_size = size;
880 else if (start > bm->buffer_mem_start)
882 uword new_size = start - bm->buffer_mem_start + size;
883 if (new_size > bm->buffer_mem_size)
884 bm->buffer_mem_size = new_size;
887 if ((u64) bm->buffer_mem_size >
888 ((u64) 1 << (32 + CLIB_LOG2_CACHE_LINE_BYTES)))
890 clib_panic ("buffer memory size out of range!");
893 vec_add2 (bm->buffer_pools, p, 1);
896 p->physmem_map_index = physmem_map_index;
898 ASSERT (p - bm->buffer_pools < 256);
899 return p - bm->buffer_pools;
903 format_vlib_buffer_free_list (u8 * s, va_list * va)
905 vlib_buffer_free_list_t *f = va_arg (*va, vlib_buffer_free_list_t *);
906 u32 threadnum = va_arg (*va, u32);
907 uword bytes_alloc, bytes_free, n_free, size;
910 return format (s, "%=7s%=30s%=12s%=12s%=12s%=12s%=12s%=12s",
911 "Thread", "Name", "Index", "Size", "Alloc", "Free",
914 size = sizeof (vlib_buffer_t) + f->n_data_bytes;
915 n_free = vec_len (f->buffers);
916 bytes_alloc = size * f->n_alloc;
917 bytes_free = size * n_free;
919 s = format (s, "%7d%30v%12d%12d%=12U%=12U%=12d%=12d", threadnum,
920 f->name, f->index, f->n_data_bytes,
921 format_memory_size, bytes_alloc,
922 format_memory_size, bytes_free, f->n_alloc, n_free);
927 static clib_error_t *
928 show_buffers (vlib_main_t * vm,
929 unformat_input_t * input, vlib_cli_command_t * cmd)
931 vlib_buffer_free_list_t *f;
932 vlib_main_t *curr_vm;
935 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, 0, 0);
939 curr_vm = vlib_mains[vm_index];
942 pool_foreach (f, curr_vm->buffer_free_list_pool, ({
943 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, f, vm_index);
949 while (vm_index < vec_len (vlib_mains));
955 VLIB_CLI_COMMAND (show_buffers_command, static) = {
956 .path = "show buffers",
957 .short_help = "Show packet buffer allocation",
958 .function = show_buffers,
963 vlib_buffer_main_init (struct vlib_main_t * vm)
965 vlib_buffer_main_t *bm = &buffer_main;
967 u32 physmem_map_index;
969 int log2_page_size = 0;
971 buffer_log_default = vlib_log_register_class ("buffer", 0);
973 if (vlib_buffer_callbacks)
975 /* external plugin has registered own buffer callbacks
976 so we just copy them and quit */
977 clib_memcpy (&bm->cb, vlib_buffer_callbacks,
978 sizeof (vlib_buffer_callbacks_t));
979 bm->callbacks_registered = 1;
983 bm->cb.vlib_buffer_fill_free_list_cb = &vlib_buffer_fill_free_list_internal;
984 bm->cb.vlib_buffer_free_cb = &vlib_buffer_free_internal;
985 bm->cb.vlib_buffer_free_no_next_cb = &vlib_buffer_free_no_next_internal;
986 bm->cb.vlib_buffer_delete_free_list_cb =
987 &vlib_buffer_delete_free_list_internal;
988 clib_spinlock_init (&bm->buffer_known_hash_lockp);
991 error = vlib_physmem_shared_map_create (vm, "buffers",
992 vlib_buffer_physmem_sz,
994 CLIB_PMALLOC_NUMA_LOCAL,
997 if (error && log2_page_size == 0)
999 vlib_log_warn (buffer_log_default, "%U", format_clib_error, error);
1000 clib_error_free (error);
1001 vlib_log_warn (buffer_log_default, "falling back to non-hugepage "
1002 "backed buffer pool");
1003 log2_page_size = min_log2 (clib_mem_get_page_size ());
1010 pool_index = vlib_buffer_register_physmem_map (vm, physmem_map_index);
1011 vlib_buffer_pool_t *bp = vlib_buffer_pool_get (pool_index);
1012 clib_spinlock_init (&bp->lock);
1013 bp->buffer_size = VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES +
1014 sizeof (vlib_buffer_t);
1019 static clib_error_t *
1020 vlib_buffers_configure (vlib_main_t * vm, unformat_input_t * input)
1024 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1026 if (unformat (input, "memory-size-in-mb %d", &size_in_mb))
1027 vlib_buffer_physmem_sz = size_in_mb << 20;
1029 return unformat_parse_error (input);
1032 unformat_free (input);
1036 VLIB_EARLY_CONFIG_FUNCTION (vlib_buffers_configure, "buffers");
1041 * fd.io coding-style-patch-verification: ON
1044 * eval: (c-set-style "gnu")