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;
50 static u32 vlib_buffer_physmem_sz = 32 << 20;
52 vlib_buffer_main_t buffer_main;
55 vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
56 vlib_buffer_t * b_first)
58 vlib_buffer_t *b = b_first;
59 uword l_first = b_first->current_length;
61 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
63 b = vlib_get_buffer (vm, b->next_buffer);
64 l += b->current_length;
66 b_first->total_length_not_including_first_buffer = l;
67 b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
72 format_vlib_buffer (u8 * s, va_list * args)
74 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
75 u32 indent = format_get_indent (s);
78 #define _(bit, name, v) \
79 if (v && (b->flags & VLIB_BUFFER_##name)) \
80 a = format (a, "%s ", v);
81 foreach_vlib_buffer_flag
83 s = format (s, "current data %d, length %d, free-list %d, clone-count %u",
84 b->current_data, b->current_length,
85 vlib_buffer_get_free_list_index (b), b->n_add_refs);
87 if (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID)
88 s = format (s, ", totlen-nifb %d",
89 b->total_length_not_including_first_buffer);
91 if (b->flags & VLIB_BUFFER_IS_TRACED)
92 s = format (s, ", trace 0x%x", b->trace_index);
95 s = format (s, "\n%U%v", format_white_space, indent, a);
98 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
100 vlib_main_t *vm = vlib_get_main ();
101 u32 next_buffer = b->next_buffer;
102 b = vlib_get_buffer (vm, next_buffer);
105 format (s, "\n%Unext-buffer 0x%x, segment length %d, clone-count %u",
106 format_white_space, indent, next_buffer, b->current_length,
114 format_vlib_buffer_and_data (u8 * s, va_list * args)
116 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
118 s = format (s, "%U, %U",
119 format_vlib_buffer, b,
120 format_hex_bytes, vlib_buffer_get_current (b), 64);
126 format_vlib_buffer_known_state (u8 * s, va_list * args)
128 vlib_buffer_known_state_t state = va_arg (*args, vlib_buffer_known_state_t);
133 case VLIB_BUFFER_UNKNOWN:
137 case VLIB_BUFFER_KNOWN_ALLOCATED:
138 t = "known-allocated";
141 case VLIB_BUFFER_KNOWN_FREE:
150 return format (s, "%s", t);
154 format_vlib_buffer_contents (u8 * s, va_list * va)
156 vlib_main_t *vm = va_arg (*va, vlib_main_t *);
157 vlib_buffer_t *b = va_arg (*va, vlib_buffer_t *);
161 vec_add (s, vlib_buffer_get_current (b), b->current_length);
162 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
164 b = vlib_get_buffer (vm, b->next_buffer);
171 vlib_validate_buffer_helper (vlib_main_t * vm,
173 uword follow_buffer_next, uword ** unique_hash)
175 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
176 vlib_buffer_free_list_t *fl;
178 if (pool_is_free_index
179 (vm->buffer_free_list_pool, vlib_buffer_get_free_list_index (b)))
180 return format (0, "unknown free list 0x%x",
181 vlib_buffer_get_free_list_index (b));
184 pool_elt_at_index (vm->buffer_free_list_pool,
185 vlib_buffer_get_free_list_index (b));
187 if ((signed) b->current_data < (signed) -VLIB_BUFFER_PRE_DATA_SIZE)
188 return format (0, "current data %d before pre-data", b->current_data);
190 if (b->current_data + b->current_length > fl->n_data_bytes)
191 return format (0, "%d-%d beyond end of buffer %d",
192 b->current_data, b->current_length, fl->n_data_bytes);
194 if (follow_buffer_next && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
196 vlib_buffer_known_state_t k;
199 k = vlib_buffer_is_known (b->next_buffer);
200 if (k != VLIB_BUFFER_KNOWN_ALLOCATED)
201 return format (0, "next 0x%x: %U",
202 b->next_buffer, format_vlib_buffer_known_state, k);
206 if (hash_get (*unique_hash, b->next_buffer))
207 return format (0, "duplicate buffer 0x%x", b->next_buffer);
209 hash_set1 (*unique_hash, b->next_buffer);
212 msg = vlib_validate_buffer (vm, b->next_buffer, follow_buffer_next);
215 result = format (0, "next 0x%x: %v", b->next_buffer, msg);
225 vlib_validate_buffer (vlib_main_t * vm, u32 bi, uword follow_buffer_next)
227 return vlib_validate_buffer_helper (vm, bi, follow_buffer_next,
228 /* unique_hash */ 0);
232 vlib_validate_buffers (vlib_main_t * vm,
234 uword next_buffer_stride,
236 vlib_buffer_known_state_t known_state,
237 uword follow_buffer_next)
240 u32 bi, *b = buffers;
241 vlib_buffer_known_state_t k;
242 u8 *msg = 0, *result = 0;
244 hash = hash_create (0, 0);
245 for (i = 0; i < n_buffers; i++)
248 b += next_buffer_stride;
250 /* Buffer is not unique. */
251 if (hash_get (hash, bi))
253 msg = format (0, "not unique");
257 k = vlib_buffer_is_known (bi);
258 if (k != known_state)
260 msg = format (0, "is %U; expected %U",
261 format_vlib_buffer_known_state, k,
262 format_vlib_buffer_known_state, known_state);
266 msg = vlib_validate_buffer_helper (vm, bi, follow_buffer_next, &hash);
270 hash_set1 (hash, bi);
276 result = format (0, "0x%x: %v", bi, msg);
284 * Hand-craft a static vector w/ length 1, so vec_len(vlib_mains) =1
285 * and vlib_mains[0] = &vlib_global_main from the beginning of time.
287 * The only place which should ever expand vlib_mains is start_workers()
288 * in threads.c. It knows about the bootstrap vector.
295 } __attribute__ ((packed)) __bootstrap_vlib_main_vector
296 __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES))) =
299 .vm = &vlib_global_main,
303 vlib_main_t **vlib_mains = &__bootstrap_vlib_main_vector.vm;
306 /* When dubugging validate that given buffers are either known allocated
309 vlib_buffer_validate_alloc_free (vlib_main_t * vm,
312 vlib_buffer_known_state_t expected_state)
315 uword i, bi, is_free;
320 if (vlib_buffer_callbacks)
323 is_free = expected_state == VLIB_BUFFER_KNOWN_ALLOCATED;
325 for (i = 0; i < n_buffers; i++)
327 vlib_buffer_known_state_t known;
331 known = vlib_buffer_is_known (bi);
332 if (known != expected_state)
336 (vm, "%s %U buffer 0x%x",
337 is_free ? "freeing" : "allocating",
338 format_vlib_buffer_known_state, known, bi);
341 vlib_buffer_set_known_state
342 (bi, is_free ? VLIB_BUFFER_KNOWN_FREE : VLIB_BUFFER_KNOWN_ALLOCATED);
346 /* Add buffer free list. */
347 static vlib_buffer_free_list_index_t
348 vlib_buffer_create_free_list_helper (vlib_main_t * vm,
350 u32 is_public, u32 is_default, u8 * name)
352 vlib_buffer_main_t *bm = &buffer_main;
353 vlib_buffer_free_list_t *f;
356 ASSERT (vlib_get_thread_index () == 0);
358 if (!is_default && pool_elts (vm->buffer_free_list_pool) == 0)
360 vlib_buffer_free_list_index_t default_free_free_list_index;
363 default_free_free_list_index =
364 vlib_buffer_create_free_list_helper
366 /* default buffer size */ VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
371 ASSERT (default_free_free_list_index ==
372 VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
374 if (n_data_bytes == VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES && is_public)
375 return default_free_free_list_index;
378 pool_get_aligned (vm->buffer_free_list_pool, f, CLIB_CACHE_LINE_BYTES);
380 memset (f, 0, sizeof (f[0]));
381 f->index = f - vm->buffer_free_list_pool;
382 f->n_data_bytes = vlib_buffer_round_size (n_data_bytes);
383 f->min_n_buffers_each_alloc = VLIB_FRAME_SIZE;
384 f->buffer_pool_index = 0;
385 f->name = clib_mem_is_vec (name) ? name : format (0, "%s", name);
387 /* Setup free buffer template. */
388 vlib_buffer_set_free_list_index (&f->buffer_init_template, f->index);
389 f->buffer_init_template.n_add_refs = 0;
393 uword *p = hash_get (bm->free_list_by_size, f->n_data_bytes);
395 hash_set (bm->free_list_by_size, f->n_data_bytes, f->index);
398 for (i = 1; i < vec_len (vlib_mains); i++)
400 vlib_main_t *wvm = vlib_mains[i];
401 vlib_buffer_free_list_t *wf;
402 pool_get_aligned (wvm->buffer_free_list_pool,
403 wf, CLIB_CACHE_LINE_BYTES);
404 ASSERT (f - vm->buffer_free_list_pool ==
405 wf - wvm->buffer_free_list_pool);
414 vlib_buffer_free_list_index_t
415 vlib_buffer_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
422 name = va_format (0, fmt, &va);
425 return vlib_buffer_create_free_list_helper (vm, n_data_bytes,
432 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
434 vlib_buffer_pool_t *bp = vlib_buffer_pool_get (f->buffer_pool_index);
436 vec_add_aligned (bp->buffers, f->buffers, vec_len (f->buffers),
437 CLIB_CACHE_LINE_BYTES);
439 vec_free (f->buffers);
442 memset (f, 0xab, sizeof (f[0]));
445 /* Add buffer free list. */
447 vlib_buffer_delete_free_list_internal (vlib_main_t * vm,
448 vlib_buffer_free_list_index_t index)
450 vlib_buffer_free_list_t *f;
453 ASSERT (vlib_get_thread_index () == 0);
455 f = vlib_buffer_get_free_list (vm, index);
457 ASSERT (vec_len (f->buffers) == f->n_alloc);
459 del_free_list (vm, f);
461 pool_put (vm->buffer_free_list_pool, f);
463 for (i = 1; i < vec_len (vlib_mains); i++)
465 vlib_main_t *wvm = vlib_mains[i];
466 f = vlib_buffer_get_free_list (vlib_mains[i], index);
467 del_free_list (wvm, f);
468 pool_put (wvm->buffer_free_list_pool, f);
472 static_always_inline void *
473 vlib_buffer_pool_get_buffer (vlib_buffer_pool_t * bp)
475 uword slot, page, addr;
477 if (PREDICT_FALSE (bp->n_elts == bp->n_used))
479 clib_spinlock_unlock (&bp->lock);
482 slot = bp->next_clear;
483 bp->bitmap = clib_bitmap_set (bp->bitmap, slot, 1);
484 bp->next_clear = clib_bitmap_next_clear (bp->bitmap, slot + 1);
487 page = slot / bp->buffers_per_page;
488 slot -= page * bp->buffers_per_page;
490 addr = bp->start + (page << bp->log2_page_size) + slot * bp->buffer_size;
492 return uword_to_pointer (addr, void *);
495 /* Make sure free list has at least given number of free buffers. */
497 vlib_buffer_fill_free_list_internal (vlib_main_t * vm,
498 vlib_buffer_free_list_t * fl,
499 uword min_free_buffers)
502 vlib_buffer_pool_t *bp = vlib_buffer_pool_get (fl->buffer_pool_index);
507 /* Already have enough free buffers on free list? */
508 n = min_free_buffers - vec_len (fl->buffers);
510 return min_free_buffers;
512 if (vec_len (bp->buffers) > 0)
515 clib_spinlock_lock (&bp->lock);
516 n_copy = clib_min (vec_len (bp->buffers), n);
517 n_left = vec_len (bp->buffers) - n_copy;
518 vec_add_aligned (fl->buffers, bp->buffers + n_left, n_copy,
519 CLIB_CACHE_LINE_BYTES);
520 _vec_len (bp->buffers) = n_left;
521 clib_spinlock_unlock (&bp->lock);
522 n = min_free_buffers - vec_len (fl->buffers);
524 return min_free_buffers;
527 /* Always allocate round number of buffers. */
528 n = round_pow2 (n, CLIB_CACHE_LINE_BYTES / sizeof (u32));
530 /* Always allocate new buffers in reasonably large sized chunks. */
531 n = clib_max (n, fl->min_n_buffers_each_alloc);
533 clib_spinlock_lock (&bp->lock);
536 if ((b = vlib_buffer_pool_get_buffer (bp)) == 0)
541 vec_add2_aligned (fl->buffers, bi, 1, CLIB_CACHE_LINE_BYTES);
542 bi[0] = vlib_get_buffer_index (vm, b);
545 vlib_buffer_set_known_state (bi[0], VLIB_BUFFER_KNOWN_FREE);
547 memset (b, 0, sizeof (vlib_buffer_t));
548 vlib_buffer_init_for_free_list (b, fl);
550 if (fl->buffer_init_function)
551 fl->buffer_init_function (vm, fl, bi, 1);
555 clib_spinlock_unlock (&bp->lock);
556 fl->n_alloc += n_alloc;
561 vlib_set_buffer_free_callback (vlib_main_t * vm, void *fp)
563 vlib_buffer_main_t *bm = &buffer_main;
564 void *rv = bm->buffer_free_callback;
566 bm->buffer_free_callback = fp;
570 static_always_inline void
571 recycle_or_free (vlib_main_t * vm, vlib_buffer_main_t * bm, u32 bi,
572 vlib_buffer_t * b, u32 follow_buffer_next)
574 vlib_buffer_free_list_t *fl;
575 vlib_buffer_free_list_index_t fi;
576 fl = vlib_buffer_get_buffer_free_list (vm, b, &fi);
578 /* The only current use of this callback:
579 * multicast recycle */
580 if (PREDICT_FALSE (fl->buffers_added_to_freelist_function != 0))
584 vlib_buffer_add_to_free_list (vm, fl, bi,
585 (b->flags & VLIB_BUFFER_RECYCLE) == 0);
586 for (j = 0; j < vec_len (vm->buffer_announce_list); j++)
588 if (fl == vm->buffer_announce_list[j])
589 goto already_announced;
591 vec_add1 (vm->buffer_announce_list, fl);
597 if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_RECYCLE) == 0))
603 vlib_buffer_t *nb = vlib_get_buffer (vm, bi);
605 next = nb->next_buffer;
610 vlib_buffer_validate_alloc_free (vm, &bi, 1,
611 VLIB_BUFFER_KNOWN_ALLOCATED);
612 vlib_buffer_add_to_free_list (vm, fl, bi, 1);
616 while (follow_buffer_next && (flags & VLIB_BUFFER_NEXT_PRESENT));
622 static_always_inline void
623 vlib_buffer_free_inline (vlib_main_t * vm,
624 u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
626 vlib_buffer_main_t *bm = &buffer_main;
627 vlib_buffer_t *p, *b0, *b1, *b2, *b3;
629 u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
630 u32 follow_buffer_next);
632 cb = bm->buffer_free_callback;
634 if (PREDICT_FALSE (cb != 0))
635 n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
640 while (i + 11 < n_buffers)
642 p = vlib_get_buffer (vm, buffers[i + 8]);
643 vlib_prefetch_buffer_header (p, LOAD);
644 p = vlib_get_buffer (vm, buffers[i + 9]);
645 vlib_prefetch_buffer_header (p, LOAD);
646 p = vlib_get_buffer (vm, buffers[i + 10]);
647 vlib_prefetch_buffer_header (p, LOAD);
648 p = vlib_get_buffer (vm, buffers[i + 11]);
649 vlib_prefetch_buffer_header (p, LOAD);
651 b0 = vlib_get_buffer (vm, buffers[i]);
652 b1 = vlib_get_buffer (vm, buffers[i + 1]);
653 b2 = vlib_get_buffer (vm, buffers[i + 2]);
654 b3 = vlib_get_buffer (vm, buffers[i + 3]);
656 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
657 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
658 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b2);
659 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b3);
661 recycle_or_free (vm, bm, buffers[i], b0, follow_buffer_next);
662 recycle_or_free (vm, bm, buffers[i + 1], b1, follow_buffer_next);
663 recycle_or_free (vm, bm, buffers[i + 2], b2, follow_buffer_next);
664 recycle_or_free (vm, bm, buffers[i + 3], b3, follow_buffer_next);
669 while (i < n_buffers)
671 b0 = vlib_get_buffer (vm, buffers[i]);
672 VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
673 recycle_or_free (vm, bm, buffers[i], b0, follow_buffer_next);
677 if (vec_len (vm->buffer_announce_list))
679 vlib_buffer_free_list_t *fl;
680 for (i = 0; i < vec_len (vm->buffer_announce_list); i++)
682 fl = vm->buffer_announce_list[i];
683 fl->buffers_added_to_freelist_function (vm, fl);
685 _vec_len (vm->buffer_announce_list) = 0;
690 vlib_buffer_free_internal (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
692 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
697 vlib_buffer_free_no_next_internal (vlib_main_t * vm, u32 * buffers,
700 vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */
704 /* Copy template packet data into buffers as they are allocated. */
705 static void __attribute__ ((unused))
706 vlib_packet_template_buffer_init (vlib_main_t * vm,
707 vlib_buffer_free_list_t * fl,
708 u32 * buffers, u32 n_buffers)
710 vlib_packet_template_t *t =
711 uword_to_pointer (fl->buffer_init_function_opaque,
712 vlib_packet_template_t *);
715 for (i = 0; i < n_buffers; i++)
717 vlib_buffer_t *b = vlib_get_buffer (vm, buffers[i]);
718 ASSERT (b->current_length == vec_len (t->packet_data));
719 clib_memcpy (vlib_buffer_get_current (b), t->packet_data,
725 vlib_packet_template_init (vlib_main_t * vm,
726 vlib_packet_template_t * t,
728 uword n_packet_data_bytes,
729 uword min_n_buffers_each_alloc, char *fmt, ...)
731 vlib_buffer_main_t *bm = &buffer_main;
734 vlib_buffer_free_list_t *fl;
737 name = va_format (0, fmt, &va);
740 if (bm->cb.vlib_packet_template_init_cb)
741 bm->cb.vlib_packet_template_init_cb (vm, (void *) t, packet_data,
743 min_n_buffers_each_alloc, name);
745 vlib_worker_thread_barrier_sync (vm);
747 memset (t, 0, sizeof (t[0]));
749 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
750 t->min_n_buffers_each_alloc = min_n_buffers_each_alloc;
752 t->free_list_index = vlib_buffer_create_free_list_helper
753 (vm, n_packet_data_bytes,
758 ASSERT (t->free_list_index != 0);
759 fl = vlib_buffer_get_free_list (vm, t->free_list_index);
760 fl->min_n_buffers_each_alloc = t->min_n_buffers_each_alloc;
762 fl->buffer_init_function = vlib_packet_template_buffer_init;
763 fl->buffer_init_function_opaque = pointer_to_uword (t);
765 fl->buffer_init_template.current_data = 0;
766 fl->buffer_init_template.current_length = n_packet_data_bytes;
767 fl->buffer_init_template.flags = 0;
768 fl->buffer_init_template.n_add_refs = 0;
769 vlib_worker_thread_barrier_release (vm);
773 vlib_packet_template_get_packet (vlib_main_t * vm,
774 vlib_packet_template_t * t, u32 * bi_result)
779 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
784 b = vlib_get_buffer (vm, bi);
785 clib_memcpy (vlib_buffer_get_current (b),
786 t->packet_data, vec_len (t->packet_data));
787 b->current_length = vec_len (t->packet_data);
793 vlib_packet_template_get_packet_helper (vlib_main_t * vm,
794 vlib_packet_template_t * t)
796 word n = t->min_n_buffers_each_alloc;
797 word l = vec_len (t->packet_data);
801 ASSERT (vec_len (t->free_buffers) == 0);
803 vec_validate (t->free_buffers, n - 1);
804 n_alloc = vlib_buffer_alloc_from_free_list (vm, t->free_buffers,
805 n, t->free_list_index);
806 _vec_len (t->free_buffers) = n_alloc;
809 /* Append given data to end of buffer, possibly allocating new buffers. */
811 vlib_buffer_add_data (vlib_main_t * vm,
812 vlib_buffer_free_list_index_t free_list_index,
813 u32 buffer_index, void *data, u32 n_data_bytes)
815 u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
821 && 1 != vlib_buffer_alloc_from_free_list (vm, &bi, 1, free_list_index))
825 n_left = n_data_bytes;
826 n_buffer_bytes = vlib_buffer_free_list_buffer_size (vm, free_list_index);
828 b = vlib_get_buffer (vm, bi);
829 b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
831 /* Get to the end of the chain before we try to append data... */
832 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
833 b = vlib_get_buffer (vm, b->next_buffer);
839 ASSERT (n_buffer_bytes >= b->current_length);
841 n_buffer_bytes - (b->current_data + b->current_length);
842 n = clib_min (n_left_this_buffer, n_left);
843 clib_memcpy (vlib_buffer_get_current (b) + b->current_length, d, n);
844 b->current_length += n;
851 vlib_buffer_alloc_from_free_list (vm, &b->next_buffer, 1,
855 b->flags |= VLIB_BUFFER_NEXT_PRESENT;
857 b = vlib_get_buffer (vm, b->next_buffer);
863 clib_error ("out of buffers");
868 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
869 vlib_buffer_free_list_index_t
871 vlib_buffer_t * first,
872 vlib_buffer_t ** last, void *data,
875 vlib_buffer_t *l = *last;
877 vlib_buffer_free_list_buffer_size (vm, free_list_index);
879 ASSERT (n_buffer_bytes >= l->current_length + l->current_data);
882 u16 max = n_buffer_bytes - l->current_length - l->current_data;
886 vlib_buffer_alloc_from_free_list (vm, &l->next_buffer, 1,
889 *last = l = vlib_buffer_chain_buffer (vm, first, l, l->next_buffer);
890 max = n_buffer_bytes - l->current_length - l->current_data;
893 u16 len = (data_len > max) ? max : data_len;
894 clib_memcpy (vlib_buffer_get_current (l) + l->current_length,
896 vlib_buffer_chain_increase_length (first, l, len);
904 vlib_buffer_pool_create (vlib_main_t * vm, vlib_physmem_region_index_t pri,
907 vlib_buffer_main_t *bm = &buffer_main;
908 vlib_physmem_region_t *pr = vlib_physmem_get_region (vm, pri);
909 vlib_buffer_pool_t *p;
910 uword start = pointer_to_uword (pr->mem);
911 uword size = pr->size;
913 if (bm->buffer_mem_size == 0)
915 bm->buffer_mem_start = start;
916 bm->buffer_mem_size = size;
918 else if (start < bm->buffer_mem_start)
920 bm->buffer_mem_size += bm->buffer_mem_start - start;
921 bm->buffer_mem_start = start;
922 if (size > bm->buffer_mem_size)
923 bm->buffer_mem_size = size;
925 else if (start > bm->buffer_mem_start)
927 uword new_size = start - bm->buffer_mem_start + size;
928 if (new_size > bm->buffer_mem_size)
929 bm->buffer_mem_size = new_size;
932 if ((u64) bm->buffer_mem_size >
933 ((u64) 1 << (32 + CLIB_LOG2_CACHE_LINE_BYTES)))
935 clib_panic ("buffer memory size out of range!");
938 vec_add2 (bm->buffer_pools, p, 1);
941 p->physmem_region = pri;
943 if (buffer_size == 0)
946 p->log2_page_size = pr->log2_page_size;
947 p->buffer_size = buffer_size;
948 p->buffers_per_page = (1 << pr->log2_page_size) / p->buffer_size;
949 p->n_elts = p->buffers_per_page * pr->n_pages;
951 clib_spinlock_init (&p->lock);
953 ASSERT (p - bm->buffer_pools < 256);
954 return p - bm->buffer_pools;
958 format_vlib_buffer_free_list (u8 * s, va_list * va)
960 vlib_buffer_free_list_t *f = va_arg (*va, vlib_buffer_free_list_t *);
961 u32 threadnum = va_arg (*va, u32);
962 uword bytes_alloc, bytes_free, n_free, size;
965 return format (s, "%=7s%=30s%=12s%=12s%=12s%=12s%=12s%=12s",
966 "Thread", "Name", "Index", "Size", "Alloc", "Free",
969 size = sizeof (vlib_buffer_t) + f->n_data_bytes;
970 n_free = vec_len (f->buffers);
971 bytes_alloc = size * f->n_alloc;
972 bytes_free = size * n_free;
974 s = format (s, "%7d%30v%12d%12d%=12U%=12U%=12d%=12d", threadnum,
975 f->name, f->index, f->n_data_bytes,
976 format_memory_size, bytes_alloc,
977 format_memory_size, bytes_free, f->n_alloc, n_free);
982 static clib_error_t *
983 show_buffers (vlib_main_t * vm,
984 unformat_input_t * input, vlib_cli_command_t * cmd)
986 vlib_buffer_free_list_t *f;
987 vlib_main_t *curr_vm;
990 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, 0, 0);
994 curr_vm = vlib_mains[vm_index];
997 pool_foreach (f, curr_vm->buffer_free_list_pool, ({
998 vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, f, vm_index);
1004 while (vm_index < vec_len (vlib_mains));
1010 VLIB_CLI_COMMAND (show_buffers_command, static) = {
1011 .path = "show buffers",
1012 .short_help = "Show packet buffer allocation",
1013 .function = show_buffers,
1018 vlib_buffer_main_init (struct vlib_main_t * vm)
1020 vlib_buffer_main_t *bm = &buffer_main;
1021 vlib_physmem_region_index_t pri;
1022 clib_error_t *error;
1024 if (vlib_buffer_callbacks)
1026 /* external plugin has registered own buffer callbacks
1027 so we just copy them and quit */
1028 clib_memcpy (&bm->cb, vlib_buffer_callbacks,
1029 sizeof (vlib_buffer_callbacks_t));
1030 bm->callbacks_registered = 1;
1034 bm->cb.vlib_buffer_fill_free_list_cb = &vlib_buffer_fill_free_list_internal;
1035 bm->cb.vlib_buffer_free_cb = &vlib_buffer_free_internal;
1036 bm->cb.vlib_buffer_free_no_next_cb = &vlib_buffer_free_no_next_internal;
1037 bm->cb.vlib_buffer_delete_free_list_cb =
1038 &vlib_buffer_delete_free_list_internal;
1039 clib_spinlock_init (&bm->buffer_known_hash_lockp);
1041 /* allocate default region */
1042 error = vlib_physmem_region_alloc (vm, "buffers",
1043 vlib_buffer_physmem_sz, 0,
1044 VLIB_PHYSMEM_F_SHARED |
1045 VLIB_PHYSMEM_F_HUGETLB, &pri);
1050 clib_error_free (error);
1052 error = vlib_physmem_region_alloc (vm, "buffers",
1053 vlib_buffer_physmem_sz, 0,
1054 VLIB_PHYSMEM_F_SHARED, &pri);
1057 vlib_buffer_pool_create (vm, pri, sizeof (vlib_buffer_t) +
1058 VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES);
1062 static clib_error_t *
1063 vlib_buffers_configure (vlib_main_t * vm, unformat_input_t * input)
1067 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1069 if (unformat (input, "memory-size-in-mb %d", &size_in_mb))
1070 vlib_buffer_physmem_sz = size_in_mb << 20;
1072 return unformat_parse_error (input);
1075 unformat_free (input);
1079 VLIB_EARLY_CONFIG_FUNCTION (vlib_buffers_configure, "buffers");
1084 * fd.io coding-style-patch-verification: ON
1087 * eval: (c-set-style "gnu")