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 <vppinfra/linux/sysfs.h>
47 #include <vlib/vlib.h>
48 #include <vlib/unix/unix.h>
50 #define VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA 16384
51 #define VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA_UNPRIV 8192
53 #ifdef CLIB_HAVE_VEC128
54 /* Assumptions by vlib_buffer_free_inline: */
55 STATIC_ASSERT_FITS_IN (vlib_buffer_t, flags, 16);
56 STATIC_ASSERT_FITS_IN (vlib_buffer_t, ref_count, 16);
57 STATIC_ASSERT_FITS_IN (vlib_buffer_t, buffer_pool_index, 16);
60 /* Make sure that buffer template size is not accidentally changed */
61 STATIC_ASSERT_OFFSET_OF (vlib_buffer_t, template_end, 64);
63 u16 __vlib_buffer_external_hdr_size = 0;
66 vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
67 vlib_buffer_t * b_first)
69 vlib_buffer_t *b = b_first;
70 uword l_first = b_first->current_length;
72 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
74 b = vlib_get_buffer (vm, b->next_buffer);
75 l += b->current_length;
77 b_first->total_length_not_including_first_buffer = l;
78 b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
83 format_vlib_buffer (u8 * s, va_list * args)
85 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
86 u32 indent = format_get_indent (s);
89 #define _(bit, name, v) \
90 if (v && (b->flags & VLIB_BUFFER_##name)) \
91 a = format (a, "%s ", v);
92 foreach_vlib_buffer_flag
94 s = format (s, "current data %d, length %d, buffer-pool %d, "
95 "ref-count %u", b->current_data, b->current_length,
96 b->buffer_pool_index, b->ref_count);
98 if (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID)
99 s = format (s, ", totlen-nifb %d",
100 b->total_length_not_including_first_buffer);
102 if (b->flags & VLIB_BUFFER_IS_TRACED)
103 s = format (s, ", trace 0x%x", b->trace_index);
106 s = format (s, "\n%U%v", format_white_space, indent, a);
109 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
111 vlib_main_t *vm = vlib_get_main ();
112 u32 next_buffer = b->next_buffer;
113 b = vlib_get_buffer (vm, next_buffer);
116 format (s, "\n%Unext-buffer 0x%x, segment length %d, ref-count %u",
117 format_white_space, indent, next_buffer, b->current_length,
125 format_vlib_buffer_and_data (u8 * s, va_list * args)
127 vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
129 s = format (s, "%U, %U",
130 format_vlib_buffer, b,
131 format_hex_bytes, vlib_buffer_get_current (b), 64);
137 format_vlib_buffer_known_state (u8 * s, va_list * args)
139 vlib_buffer_known_state_t state = va_arg (*args, vlib_buffer_known_state_t);
144 case VLIB_BUFFER_UNKNOWN:
148 case VLIB_BUFFER_KNOWN_ALLOCATED:
149 t = "known-allocated";
152 case VLIB_BUFFER_KNOWN_FREE:
161 return format (s, "%s", t);
165 format_vlib_buffer_contents (u8 * s, va_list * va)
167 vlib_main_t *vm = va_arg (*va, vlib_main_t *);
168 vlib_buffer_t *b = va_arg (*va, vlib_buffer_t *);
172 vec_add (s, vlib_buffer_get_current (b), b->current_length);
173 if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
175 b = vlib_get_buffer (vm, b->next_buffer);
182 vlib_validate_buffer_helper (vlib_main_t * vm,
184 uword follow_buffer_next, uword ** unique_hash)
186 vlib_buffer_main_t *bm = vm->buffer_main;
187 vlib_buffer_t *b = vlib_get_buffer (vm, bi);
189 if (vec_len (bm->buffer_pools) <= b->buffer_pool_index)
190 return format (0, "unknown buffer pool 0x%x", b->buffer_pool_index);
192 if ((signed) b->current_data < (signed) -VLIB_BUFFER_PRE_DATA_SIZE)
193 return format (0, "current data %d before pre-data", b->current_data);
195 if (b->current_data + b->current_length > VLIB_BUFFER_DATA_SIZE)
196 return format (0, "%d-%d beyond end of buffer %d", b->current_data,
197 b->current_length, VLIB_BUFFER_DATA_SIZE);
199 if (follow_buffer_next && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
201 vlib_buffer_known_state_t k;
204 k = vlib_buffer_is_known (vm, b->next_buffer);
205 if (k != VLIB_BUFFER_KNOWN_ALLOCATED)
206 return format (0, "next 0x%x: %U",
207 b->next_buffer, format_vlib_buffer_known_state, k);
211 if (hash_get (*unique_hash, b->next_buffer))
212 return format (0, "duplicate buffer 0x%x", b->next_buffer);
214 hash_set1 (*unique_hash, b->next_buffer);
217 msg = vlib_validate_buffer (vm, b->next_buffer, follow_buffer_next);
220 result = format (0, "next 0x%x: %v", b->next_buffer, msg);
230 vlib_validate_buffer (vlib_main_t * vm, u32 bi, uword follow_buffer_next)
232 return vlib_validate_buffer_helper (vm, bi, follow_buffer_next,
233 /* unique_hash */ 0);
237 vlib_validate_buffers (vlib_main_t * vm,
239 uword next_buffer_stride,
241 vlib_buffer_known_state_t known_state,
242 uword follow_buffer_next)
245 u32 bi, *b = buffers;
246 vlib_buffer_known_state_t k;
247 u8 *msg = 0, *result = 0;
249 hash = hash_create (0, 0);
250 for (i = 0; i < n_buffers; i++)
253 b += next_buffer_stride;
255 /* Buffer is not unique. */
256 if (hash_get (hash, bi))
258 msg = format (0, "not unique");
262 k = vlib_buffer_is_known (vm, bi);
263 if (k != known_state)
265 msg = format (0, "is %U; expected %U",
266 format_vlib_buffer_known_state, k,
267 format_vlib_buffer_known_state, known_state);
271 msg = vlib_validate_buffer_helper (vm, bi, follow_buffer_next, &hash);
275 hash_set1 (hash, bi);
281 result = format (0, "0x%x: %v", bi, msg);
289 * Hand-craft a static vector w/ length 1, so vec_len(vlib_mains) =1
290 * and vlib_mains[0] = &vlib_global_main from the beginning of time.
292 * The only place which should ever expand vlib_mains is start_workers()
293 * in threads.c. It knows about the bootstrap vector.
300 } __attribute__ ((packed)) __bootstrap_vlib_main_vector
301 __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES))) =
304 .vm = &vlib_global_main,
308 vlib_main_t **vlib_mains = &__bootstrap_vlib_main_vector.vm;
311 /* When dubugging validate that given buffers are either known allocated
314 vlib_buffer_validate_alloc_free (vlib_main_t * vm,
317 vlib_buffer_known_state_t expected_state)
319 vlib_buffer_main_t *bm = vm->buffer_main;
321 uword i, bi, is_free;
326 is_free = expected_state == VLIB_BUFFER_KNOWN_ALLOCATED;
328 for (i = 0; i < n_buffers; i++)
330 vlib_buffer_known_state_t known;
334 known = vlib_buffer_is_known (vm, bi);
336 if (known == VLIB_BUFFER_UNKNOWN &&
337 expected_state == VLIB_BUFFER_KNOWN_FREE)
338 known = VLIB_BUFFER_KNOWN_FREE;
340 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 clib_spinlock_lock (&bm->buffer_known_hash_lockp);
349 hash_set (bm->buffer_known_hash, bi, is_free ? VLIB_BUFFER_KNOWN_FREE :
350 VLIB_BUFFER_KNOWN_ALLOCATED);
351 clib_spinlock_unlock (&bm->buffer_known_hash_lockp);
356 vlib_packet_template_init (vlib_main_t * vm,
357 vlib_packet_template_t * t,
359 uword n_packet_data_bytes,
360 uword min_n_buffers_each_alloc, char *fmt, ...)
365 t->name = va_format (0, fmt, &va);
368 vlib_worker_thread_barrier_sync (vm);
370 clib_memset (t, 0, sizeof (t[0]));
372 vec_add (t->packet_data, packet_data, n_packet_data_bytes);
373 t->min_n_buffers_each_alloc = min_n_buffers_each_alloc;
374 vlib_worker_thread_barrier_release (vm);
378 vlib_packet_template_get_packet (vlib_main_t * vm,
379 vlib_packet_template_t * t, u32 * bi_result)
384 if (vlib_buffer_alloc (vm, &bi, 1) != 1)
389 b = vlib_get_buffer (vm, bi);
390 clib_memcpy_fast (vlib_buffer_get_current (b),
391 t->packet_data, vec_len (t->packet_data));
392 b->current_length = vec_len (t->packet_data);
397 /* Append given data to end of buffer, possibly allocating new buffers. */
399 vlib_buffer_add_data (vlib_main_t * vm, u32 * buffer_index, void *data,
402 u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
407 if (bi == ~0 && 1 != vlib_buffer_alloc (vm, &bi, 1))
411 n_left = n_data_bytes;
412 n_buffer_bytes = VLIB_BUFFER_DATA_SIZE;
414 b = vlib_get_buffer (vm, bi);
415 b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
417 /* Get to the end of the chain before we try to append data... */
418 while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
419 b = vlib_get_buffer (vm, b->next_buffer);
425 ASSERT (n_buffer_bytes >= b->current_length);
427 n_buffer_bytes - (b->current_data + b->current_length);
428 n = clib_min (n_left_this_buffer, n_left);
429 clib_memcpy_fast (vlib_buffer_get_current (b) + b->current_length, d,
431 b->current_length += n;
437 if (1 != vlib_buffer_alloc (vm, &b->next_buffer, 1))
440 b->flags |= VLIB_BUFFER_NEXT_PRESENT;
442 b = vlib_get_buffer (vm, b->next_buffer);
449 clib_warning ("out of buffers");
454 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
455 vlib_buffer_t * first,
456 vlib_buffer_t ** last, void *data,
459 vlib_buffer_t *l = *last;
460 u32 n_buffer_bytes = VLIB_BUFFER_DATA_SIZE;
462 ASSERT (n_buffer_bytes >= l->current_length + l->current_data);
465 u16 max = n_buffer_bytes - l->current_length - l->current_data;
468 if (1 != vlib_buffer_alloc_from_pool (vm, &l->next_buffer, 1,
469 first->buffer_pool_index))
471 *last = l = vlib_buffer_chain_buffer (vm, l, l->next_buffer);
472 max = n_buffer_bytes - l->current_length - l->current_data;
475 u16 len = (data_len > max) ? max : data_len;
476 clib_memcpy_fast (vlib_buffer_get_current (l) + l->current_length,
478 vlib_buffer_chain_increase_length (first, l, len);
486 vlib_buffer_pool_create (vlib_main_t * vm, u8 index, char *name,
487 u32 data_size, u32 physmem_map_index)
489 vlib_buffer_main_t *bm = vm->buffer_main;
490 vlib_buffer_pool_t *bp;
491 vlib_physmem_map_t *m = vlib_physmem_get_map (vm, physmem_map_index);
492 uword start = pointer_to_uword (m->base);
493 uword size = (uword) m->n_pages << m->log2_page_size;
494 u32 alloc_size, n_alloc_per_page;;
496 vec_validate_aligned (bm->buffer_pools, index, CLIB_CACHE_LINE_BYTES);
497 bp = vec_elt_at_index (bm->buffer_pools, index);
500 return clib_error_return (0, "buffer with index %u already exists",
504 return clib_error_return (0, "buffer index must be < 255", index);
506 if (bm->buffer_mem_size == 0)
508 bm->buffer_mem_start = start;
509 bm->buffer_mem_size = size;
511 else if (start < bm->buffer_mem_start)
513 bm->buffer_mem_size += bm->buffer_mem_start - start;
514 bm->buffer_mem_start = start;
515 if (size > bm->buffer_mem_size)
516 bm->buffer_mem_size = size;
518 else if (start > bm->buffer_mem_start)
520 uword new_size = start - bm->buffer_mem_start + size;
521 if (new_size > bm->buffer_mem_size)
522 bm->buffer_mem_size = new_size;
525 if ((u64) bm->buffer_mem_size >
526 ((u64) 1 << (32 + CLIB_LOG2_CACHE_LINE_BYTES)))
528 clib_panic ("buffer memory size out of range!");
533 bp->index = bp - bm->buffer_pools;
534 bp->buffer_template.buffer_pool_index = bp->index;
535 bp->buffer_template.ref_count = 1;
536 bp->physmem_map_index = physmem_map_index;
537 bp->name = format (0, "%s%c", name, 0);
538 bp->data_size = data_size;
539 bp->numa_node = m->numa_node;
541 vec_validate_aligned (bp->threads, vec_len (vlib_mains) - 1,
542 CLIB_CACHE_LINE_BYTES);
544 alloc_size = data_size + sizeof (vlib_buffer_t) + bm->ext_hdr_size;
545 n_alloc_per_page = (1ULL << m->log2_page_size) / alloc_size;
547 /* preallocate buffer indices memory */
548 vec_validate_aligned (bp->buffers, m->n_pages * n_alloc_per_page,
549 CLIB_CACHE_LINE_BYTES);
550 vec_reset_length (bp->buffers);
552 clib_spinlock_init (&bp->lock);
559 p = vlib_physmem_alloc_from_map (vm, bp->physmem_map_index, alloc_size,
560 CLIB_CACHE_LINE_BYTES);
565 p += bm->ext_hdr_size;
567 vlib_buffer_copy_template ((vlib_buffer_t *) p, &bp->buffer_template);
569 bi = vlib_get_buffer_index (vm, (vlib_buffer_t *) p);
571 vec_add1_aligned (bp->buffers, bi, CLIB_CACHE_LINE_BYTES);
580 format_vlib_buffer_pool (u8 * s, va_list * va)
582 vlib_main_t *vm = va_arg (*va, vlib_main_t *);
583 vlib_buffer_pool_t *bp = va_arg (*va, vlib_buffer_pool_t *);
584 vlib_buffer_pool_thread_t *bpt;
588 return format (s, "%-20s%=6s%=6s%=6s%=11s%=6s%=8s%=8s%=8s",
589 "Pool Name", "Index", "NUMA", "Size", "Data Size",
590 "Total", "Avail", "Cached", "Used");
593 vec_foreach (bpt, bp->threads)
594 cached += vec_len (bpt->cached_buffers);
597 s = format (s, "%-20s%=6d%=6d%=6u%=11u%=6u%=8u%=8u%=8u",
598 bp->name, bp->index, bp->numa_node, bp->data_size +
599 sizeof (vlib_buffer_t) + vm->buffer_main->ext_hdr_size,
600 bp->data_size, bp->n_buffers, vec_len (bp->buffers), cached,
601 bp->n_buffers - vec_len (bp->buffers) - cached);
606 static clib_error_t *
607 show_buffers (vlib_main_t * vm,
608 unformat_input_t * input, vlib_cli_command_t * cmd)
610 vlib_buffer_main_t *bm = vm->buffer_main;
611 vlib_buffer_pool_t *bp;
613 vlib_cli_output (vm, "%U", format_vlib_buffer_pool, vm, 0);
616 vec_foreach (bp, bm->buffer_pools)
617 vlib_cli_output (vm, "%U", format_vlib_buffer_pool, vm, bp);
624 VLIB_CLI_COMMAND (show_buffers_command, static) = {
625 .path = "show buffers",
626 .short_help = "Show packet buffer allocation",
627 .function = show_buffers,
632 vlib_buffer_worker_init (vlib_main_t * vm)
634 vlib_buffer_main_t *bm = vm->buffer_main;
635 vlib_buffer_pool_t *bp;
638 vec_foreach (bp, bm->buffer_pools)
640 clib_spinlock_lock (&bp->lock);
641 vec_validate_aligned (bp->threads, vec_len (vlib_mains) - 1,
642 CLIB_CACHE_LINE_BYTES);
643 clib_spinlock_unlock (&bp->lock);
650 VLIB_WORKER_INIT_FUNCTION (vlib_buffer_worker_init);
652 static clib_error_t *
653 vlib_buffer_main_init_numa_node (struct vlib_main_t *vm, u32 numa_node)
655 vlib_buffer_main_t *bm = vm->buffer_main;
657 u32 physmem_map_index;
658 uword n_pages, pagesize;
659 u32 buffers_per_numa;
660 u32 buffer_size = CLIB_CACHE_LINE_ROUND (bm->ext_hdr_size +
661 sizeof (vlib_buffer_t) +
662 VLIB_BUFFER_DATA_SIZE);
665 pagesize = clib_mem_get_default_hugepage_size ();
666 name = format (0, "buffers-numa-%d%c", numa_node, 0);
668 buffers_per_numa = bm->buffers_per_numa ? bm->buffers_per_numa :
669 VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA;
672 n_pages = (buffers_per_numa - 1) / (pagesize / buffer_size) + 1;
673 error = vlib_physmem_shared_map_create (vm, (char *) name,
675 min_log2 (pagesize), numa_node,
678 if (error && pagesize != clib_mem_get_page_size ())
680 vlib_log_warn (bm->log_default, "%U", format_clib_error, error);
681 clib_error_free (error);
682 vlib_log_warn (bm->log_default, "falling back to non-hugepage "
683 "backed buffer pool");
684 pagesize = clib_mem_get_page_size ();
685 buffers_per_numa = bm->buffers_per_numa ? bm->buffers_per_numa :
686 VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA_UNPRIV;
693 vec_reset_length (name);
694 name = format (name, "default-numa-%d%c", numa_node, 0);
696 return vlib_buffer_pool_create (vm, numa_node, (char *) name,
697 VLIB_BUFFER_DATA_SIZE, physmem_map_index);
701 vlib_buffer_main_init (struct vlib_main_t *vm)
703 vlib_buffer_main_t *bm;
705 clib_bitmap_t *bmp = 0;
708 if (vm->buffer_main == 0)
710 vm->buffer_main = clib_mem_alloc (sizeof (bm[0]));
711 clib_memset (vm->buffer_main, 0, sizeof (bm[0]));
714 bm = vm->buffer_main;
715 bm->log_default = vlib_log_register_class ("buffer", 0);
716 bm->ext_hdr_size = __vlib_buffer_external_hdr_size;
718 clib_spinlock_init (&bm->buffer_known_hash_lockp);
720 err = clib_sysfs_read ("/sys/devices/system/node/possible", "%U",
721 unformat_bitmap_list, &bmp);
724 /* no info from sysfs, assuming that only numa 0 exists */
725 clib_error_free (err);
726 bmp = clib_bitmap_set (bmp, 0, 1);
730 clib_bitmap_foreach (numa_node, bmp, {
731 if ((err = vlib_buffer_main_init_numa_node(vm, numa_node)))
736 bm->n_numa_nodes = clib_bitmap_last_set (bmp) + 1;
743 static clib_error_t *
744 vlib_buffers_configure (vlib_main_t * vm, unformat_input_t * input)
746 vlib_buffer_main_t *bm;
748 if (vm->buffer_main == 0)
750 vm->buffer_main = clib_mem_alloc (sizeof (bm[0]));
751 clib_memset (vm->buffer_main, 0, sizeof (bm[0]));
754 bm = vm->buffer_main;
756 while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
758 if (unformat (input, "buffers-per-numa %u", &bm->buffers_per_numa))
761 return unformat_parse_error (input);
764 unformat_free (input);
768 VLIB_EARLY_CONFIG_FUNCTION (vlib_buffers_configure, "buffers");
773 * fd.io coding-style-patch-verification: ON
776 * eval: (c-set-style "gnu")