FD.io VPP  v20.01-rc1
Vector Packet Processing
buffer.c
Go to the documentation of this file.
1 /*
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:
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
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.
14  */
15 /*
16  * buffer.c: allocate/free network buffers.
17  *
18  * Copyright (c) 2008 Eliot Dresselhaus
19  *
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:
27  *
28  * The above copyright notice and this permission notice shall be
29  * included in all copies or substantial portions of the Software.
30  *
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.
38  */
39 
40 /**
41  * @file
42  *
43  * Allocate/free network buffers.
44  */
45 
46 #include <vppinfra/linux/sysfs.h>
47 #include <vlib/vlib.h>
48 #include <vlib/unix/unix.h>
49 #include <vpp/stats/stat_segment.h>
50 
51 #define VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA 16384
52 #define VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA_UNPRIV 8192
53 
54 #ifdef CLIB_HAVE_VEC128
55 /* Assumptions by vlib_buffer_free_inline: */
57 STATIC_ASSERT_FITS_IN (vlib_buffer_t, ref_count, 16);
58 STATIC_ASSERT_FITS_IN (vlib_buffer_t, buffer_pool_index, 16);
59 #endif
60 
61 /* Make sure that buffer template size is not accidentally changed */
62 STATIC_ASSERT_OFFSET_OF (vlib_buffer_t, template_end, 64);
63 
64 u16 __vlib_buffer_external_hdr_size = 0;
65 
66 static void
68  u32 index);
69 
70 static void
72  u32 index);
73 
74 static void
76 
77 uword
79  vlib_buffer_t * b_first)
80 {
81  vlib_buffer_t *b = b_first;
82  uword l_first = b_first->current_length;
83  uword l = 0;
84  while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
85  {
86  b = vlib_get_buffer (vm, b->next_buffer);
87  l += b->current_length;
88  }
90  b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
91  return l + l_first;
92 }
93 
94 u8 *
95 format_vlib_buffer_no_chain (u8 * s, va_list * args)
96 {
97  vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
98  u32 indent = format_get_indent (s);
99  u8 *a = 0;
100 
101 #define _(bit, name, v) \
102  if (v && (b->flags & VLIB_BUFFER_##name)) \
103  a = format (a, "%s ", v);
105 #undef _
106  s = format (s, "current data %d, length %d, buffer-pool %d, "
107  "ref-count %u", b->current_data, b->current_length,
109 
110  if (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID)
111  s = format (s, ", totlen-nifb %d",
113 
114  if (b->flags & VLIB_BUFFER_IS_TRACED)
115  s = format (s, ", trace handle 0x%x", b->trace_handle);
116 
117  if (a)
118  s = format (s, "\n%U%v", format_white_space, indent, a);
119  vec_free (a);
120 
121  return s;
122 }
123 
124 u8 *
125 format_vlib_buffer (u8 * s, va_list * args)
126 {
128  vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
129  u32 indent = format_get_indent (s);
130 
131  s = format (s, "%U", format_vlib_buffer_no_chain, b);
132 
133  while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
134  {
135  u32 next_buffer = b->next_buffer;
136  b = vlib_get_buffer (vm, next_buffer);
137 
138  s =
139  format (s, "\n%Unext-buffer 0x%x, segment length %d, ref-count %u",
140  format_white_space, indent, next_buffer, b->current_length,
141  b->ref_count);
142  }
143 
144  return s;
145 }
146 
147 u8 *
148 format_vlib_buffer_and_data (u8 * s, va_list * args)
149 {
150  vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
151 
152  s = format (s, "%U, %U",
155 
156  return s;
157 }
158 
159 static u8 *
160 format_vlib_buffer_known_state (u8 * s, va_list * args)
161 {
163  char *t;
164 
165  switch (state)
166  {
167  case VLIB_BUFFER_UNKNOWN:
168  t = "unknown";
169  break;
170 
172  t = "known-allocated";
173  break;
174 
176  t = "known-free";
177  break;
178 
179  default:
180  t = "invalid";
181  break;
182  }
183 
184  return format (s, "%s", t);
185 }
186 
187 u8 *
188 format_vlib_buffer_contents (u8 * s, va_list * va)
189 {
190  vlib_main_t *vm = va_arg (*va, vlib_main_t *);
191  vlib_buffer_t *b = va_arg (*va, vlib_buffer_t *);
192 
193  while (1)
194  {
196  if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
197  break;
198  b = vlib_get_buffer (vm, b->next_buffer);
199  }
200 
201  return s;
202 }
203 
204 static u8 *
206  u32 bi,
207  uword follow_buffer_next, uword ** unique_hash)
208 {
210  vlib_buffer_t *b = vlib_get_buffer (vm, bi);
211 
212  if (vec_len (bm->buffer_pools) <= b->buffer_pool_index)
213  return format (0, "unknown buffer pool 0x%x", b->buffer_pool_index);
214 
215  if ((signed) b->current_data < (signed) -VLIB_BUFFER_PRE_DATA_SIZE)
216  return format (0, "current data %d before pre-data", b->current_data);
217 
218  if (b->current_data + b->current_length >
220  return format (0, "%d-%d beyond end of buffer %d", b->current_data,
222 
223  if (follow_buffer_next && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
224  {
226  u8 *msg, *result;
227 
228  k = vlib_buffer_is_known (vm, b->next_buffer);
230  return format (0, "next 0x%x: %U",
232 
233  if (unique_hash)
234  {
235  if (hash_get (*unique_hash, b->next_buffer))
236  return format (0, "duplicate buffer 0x%x", b->next_buffer);
237 
238  hash_set1 (*unique_hash, b->next_buffer);
239  }
240 
241  msg = vlib_validate_buffer (vm, b->next_buffer, follow_buffer_next);
242  if (msg)
243  {
244  result = format (0, "next 0x%x: %v", b->next_buffer, msg);
245  vec_free (msg);
246  return result;
247  }
248  }
249 
250  return 0;
251 }
252 
253 u8 *
254 vlib_validate_buffer (vlib_main_t * vm, u32 bi, uword follow_buffer_next)
255 {
256  return vlib_validate_buffer_helper (vm, bi, follow_buffer_next,
257  /* unique_hash */ 0);
258 }
259 
260 u8 *
262  u32 * buffers,
263  uword next_buffer_stride,
264  uword n_buffers,
265  vlib_buffer_known_state_t known_state,
266  uword follow_buffer_next)
267 {
268  uword i, *hash;
269  u32 bi, *b = buffers;
271  u8 *msg = 0, *result = 0;
272 
273  hash = hash_create (0, 0);
274  for (i = 0; i < n_buffers; i++)
275  {
276  bi = b[0];
277  b += next_buffer_stride;
278 
279  /* Buffer is not unique. */
280  if (hash_get (hash, bi))
281  {
282  msg = format (0, "not unique");
283  goto done;
284  }
285 
286  k = vlib_buffer_is_known (vm, bi);
287  if (k != known_state)
288  {
289  msg = format (0, "is %U; expected %U",
291  format_vlib_buffer_known_state, known_state);
292  goto done;
293  }
294 
295  msg = vlib_validate_buffer_helper (vm, bi, follow_buffer_next, &hash);
296  if (msg)
297  goto done;
298 
299  hash_set1 (hash, bi);
300  }
301 
302 done:
303  if (msg)
304  {
305  result = format (0, "0x%x: %v", bi, msg);
306  vec_free (msg);
307  }
308  hash_free (hash);
309  return result;
310 }
311 
312 /*
313  * Hand-craft a static vector w/ length 1, so vec_len(vlib_mains) =1
314  * and vlib_mains[0] = &vlib_global_main from the beginning of time.
315  *
316  * The only place which should ever expand vlib_mains is start_workers()
317  * in threads.c. It knows about the bootstrap vector.
318  */
319 /* *INDENT-OFF* */
320 static struct
321 {
324 } __attribute__ ((packed)) __bootstrap_vlib_main_vector
325  __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES))) =
326 {
327  .h.len = 1,
328  .vm = &vlib_global_main,
329 };
330 /* *INDENT-ON* */
331 
332 vlib_main_t **vlib_mains = &__bootstrap_vlib_main_vector.vm;
333 
334 
335 /* When debugging validate that given buffers are either known allocated
336  or known free. */
337 void
339  u32 * buffers,
340  uword n_buffers,
341  vlib_buffer_known_state_t expected_state)
342 {
344  u32 *b;
345  uword i, bi, is_free;
346 
347  if (CLIB_DEBUG == 0)
348  return;
349 
350  is_free = expected_state == VLIB_BUFFER_KNOWN_ALLOCATED;
351  b = buffers;
352  for (i = 0; i < n_buffers; i++)
353  {
355 
356  bi = b[0];
357  b += 1;
358  known = vlib_buffer_is_known (vm, bi);
359 
360  if (known == VLIB_BUFFER_UNKNOWN &&
361  expected_state == VLIB_BUFFER_KNOWN_FREE)
362  known = VLIB_BUFFER_KNOWN_FREE;
363 
364  if (known != expected_state)
365  {
366  clib_panic ("%s %U buffer 0x%x", is_free ? "freeing" : "allocating",
367  format_vlib_buffer_known_state, known, bi);
368  }
369 
374  }
375 }
376 
377 void
380  void *packet_data,
381  uword n_packet_data_bytes,
382  uword min_n_buffers_each_alloc, char *fmt, ...)
383 {
384  va_list va;
385 
386  va_start (va, fmt);
387  t->name = va_format (0, fmt, &va);
388  va_end (va);
389 
391 
392  clib_memset (t, 0, sizeof (t[0]));
393 
394  vec_add (t->packet_data, packet_data, n_packet_data_bytes);
395  t->min_n_buffers_each_alloc = min_n_buffers_each_alloc;
397 }
398 
399 void *
401  vlib_packet_template_t * t, u32 * bi_result)
402 {
403  u32 bi;
404  vlib_buffer_t *b;
405 
406  if (vlib_buffer_alloc (vm, &bi, 1) != 1)
407  return 0;
408 
409  *bi_result = bi;
410 
411  b = vlib_get_buffer (vm, bi);
413  t->packet_data, vec_len (t->packet_data));
415 
416  return b->data;
417 }
418 
419 /* Append given data to end of buffer, possibly allocating new buffers. */
420 int
421 vlib_buffer_add_data (vlib_main_t * vm, u32 * buffer_index, void *data,
422  u32 n_data_bytes)
423 {
424  u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
425  vlib_buffer_t *b;
426  void *d;
427 
428  bi = *buffer_index;
429  if (bi == ~0 && 1 != vlib_buffer_alloc (vm, &bi, 1))
430  goto out_of_buffers;
431 
432  d = data;
433  n_left = n_data_bytes;
434  n_buffer_bytes = vlib_buffer_get_default_data_size (vm);
435 
436  b = vlib_get_buffer (vm, bi);
437  b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
438 
439  /* Get to the end of the chain before we try to append data... */
440  while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
441  b = vlib_get_buffer (vm, b->next_buffer);
442 
443  while (1)
444  {
445  u32 n;
446 
447  ASSERT (n_buffer_bytes >= b->current_length);
448  n_left_this_buffer =
449  n_buffer_bytes - (b->current_data + b->current_length);
450  n = clib_min (n_left_this_buffer, n_left);
452  n);
453  b->current_length += n;
454  n_left -= n;
455  if (n_left == 0)
456  break;
457 
458  d += n;
459  if (1 != vlib_buffer_alloc (vm, &b->next_buffer, 1))
460  goto out_of_buffers;
461 
462  b->flags |= VLIB_BUFFER_NEXT_PRESENT;
463 
464  b = vlib_get_buffer (vm, b->next_buffer);
465  }
466 
467  *buffer_index = bi;
468  return 0;
469 
470 out_of_buffers:
471  clib_warning ("out of buffers");
472  return 1;
473 }
474 
475 u16
478  vlib_buffer_t ** last, void *data,
479  u16 data_len)
480 {
481  vlib_buffer_t *l = *last;
482  u32 n_buffer_bytes = vlib_buffer_get_default_data_size (vm);
483  u16 copied = 0;
484  ASSERT (n_buffer_bytes >= l->current_length + l->current_data);
485  while (data_len)
486  {
487  u16 max = n_buffer_bytes - l->current_length - l->current_data;
488  if (max == 0)
489  {
490  if (1 != vlib_buffer_alloc_from_pool (vm, &l->next_buffer, 1,
491  first->buffer_pool_index))
492  return copied;
493  *last = l = vlib_buffer_chain_buffer (vm, l, l->next_buffer);
494  max = n_buffer_bytes - l->current_length - l->current_data;
495  }
496 
497  u16 len = (data_len > max) ? max : data_len;
499  data + copied, len);
500  vlib_buffer_chain_increase_length (first, l, len);
501  data_len -= len;
502  copied += len;
503  }
504  return copied;
505 }
506 
507 u8
509  u32 physmem_map_index)
510 {
512  vlib_buffer_pool_t *bp;
513  vlib_physmem_map_t *m = vlib_physmem_get_map (vm, physmem_map_index);
514  uword start = pointer_to_uword (m->base);
515  uword size = (uword) m->n_pages << m->log2_page_size;
516  uword i, j;
517  u32 alloc_size, n_alloc_per_page;
518 
519  if (vec_len (bm->buffer_pools) >= 255)
520  return ~0;
521 
523 
524  if (bm->buffer_mem_size == 0)
525  {
526  bm->buffer_mem_start = start;
527  bm->buffer_mem_size = size;
528  }
529  else if (start < bm->buffer_mem_start)
530  {
531  bm->buffer_mem_size += bm->buffer_mem_start - start;
532  bm->buffer_mem_start = start;
533  if (size > bm->buffer_mem_size)
534  bm->buffer_mem_size = size;
535  }
536  else if (start > bm->buffer_mem_start)
537  {
538  uword new_size = start - bm->buffer_mem_start + size;
539  if (new_size > bm->buffer_mem_size)
540  bm->buffer_mem_size = new_size;
541  }
542 
543  if ((u64) bm->buffer_mem_size >
544  ((u64) 1 << (32 + CLIB_LOG2_CACHE_LINE_BYTES)))
545  {
546  clib_panic ("buffer memory size out of range!");
547  }
548 
549  bp->start = start;
550  bp->size = size;
551  bp->index = bp - bm->buffer_pools;
553  bp->buffer_template.ref_count = 1;
554  bp->physmem_map_index = physmem_map_index;
555  bp->name = format (0, "%s%c", name, 0);
556  bp->data_size = data_size;
557  bp->numa_node = m->numa_node;
558 
559  vec_validate_aligned (bp->threads, vec_len (vlib_mains) - 1,
561 
562  alloc_size = data_size + sizeof (vlib_buffer_t) + bm->ext_hdr_size;
563  n_alloc_per_page = (1ULL << m->log2_page_size) / alloc_size;
564 
565  /* preallocate buffer indices memory */
566  bp->n_buffers = m->n_pages * n_alloc_per_page;
567  bp->buffers = clib_mem_alloc_aligned (bp->n_buffers * sizeof (u32),
569 
570  clib_spinlock_init (&bp->lock);
571 
572  for (j = 0; j < m->n_pages; j++)
573  for (i = 0; i < n_alloc_per_page; i++)
574  {
575  u8 *p;
576  u32 bi;
577 
578  p = m->base + (j << m->log2_page_size) + i * alloc_size;
579  p += bm->ext_hdr_size;
580 
582 
583  bi = vlib_get_buffer_index (vm, (vlib_buffer_t *) p);
584 
585  bp->buffers[bp->n_avail++] = bi;
586 
587  vlib_get_buffer (vm, bi);
588  }
589 
590  return bp->index;
591 }
592 
593 static u8 *
594 format_vlib_buffer_pool (u8 * s, va_list * va)
595 {
596  vlib_main_t *vm = va_arg (*va, vlib_main_t *);
597  vlib_buffer_pool_t *bp = va_arg (*va, vlib_buffer_pool_t *);
599  u32 cached = 0;
600 
601  if (!bp)
602  return format (s, "%-20s%=6s%=6s%=6s%=11s%=6s%=8s%=8s%=8s",
603  "Pool Name", "Index", "NUMA", "Size", "Data Size",
604  "Total", "Avail", "Cached", "Used");
605 
606  /* *INDENT-OFF* */
607  vec_foreach (bpt, bp->threads)
608  cached += bpt->n_cached;
609  /* *INDENT-ON* */
610 
611  s = format (s, "%-20s%=6d%=6d%=6u%=11u%=6u%=8u%=8u%=8u",
612  bp->name, bp->index, bp->numa_node, bp->data_size +
613  sizeof (vlib_buffer_t) + vm->buffer_main->ext_hdr_size,
614  bp->data_size, bp->n_buffers, bp->n_avail, cached,
615  bp->n_buffers - bp->n_avail - cached);
616 
617  return s;
618 }
619 
620 static clib_error_t *
622  unformat_input_t * input, vlib_cli_command_t * cmd)
623 {
625  vlib_buffer_pool_t *bp;
626 
627  vlib_cli_output (vm, "%U", format_vlib_buffer_pool, vm, 0);
628 
629  /* *INDENT-OFF* */
630  vec_foreach (bp, bm->buffer_pools)
631  vlib_cli_output (vm, "%U", format_vlib_buffer_pool, vm, bp);
632  /* *INDENT-ON* */
633 
634  return 0;
635 }
636 
637 /* *INDENT-OFF* */
638 VLIB_CLI_COMMAND (show_buffers_command, static) = {
639  .path = "show buffers",
640  .short_help = "Show packet buffer allocation",
641  .function = show_buffers,
642 };
643 /* *INDENT-ON* */
644 
645 clib_error_t *
647 {
649  vlib_buffer_pool_t *bp;
650 
651  /* *INDENT-OFF* */
652  vec_foreach (bp, bm->buffer_pools)
653  {
654  clib_spinlock_lock (&bp->lock);
655  vec_validate_aligned (bp->threads, vec_len (vlib_mains) - 1,
657  clib_spinlock_unlock (&bp->lock);
658  }
659  /* *INDENT-ON* */
660 
661  return 0;
662 }
663 
665 
666 static clib_error_t *
668  u8 * index)
669 {
671  clib_error_t *error;
672  u32 physmem_map_index;
673  uword n_pages, pagesize;
674  u32 buffers_per_numa;
675  u32 buffer_size = CLIB_CACHE_LINE_ROUND (bm->ext_hdr_size +
676  sizeof (vlib_buffer_t) +
678  (vm));
679  u8 *name;
680 
682  name = format (0, "buffers-numa-%d%c", numa_node, 0);
683 
684  buffers_per_numa = bm->buffers_per_numa ? bm->buffers_per_numa :
686 
687 retry:
688  n_pages = (buffers_per_numa - 1) / (pagesize / buffer_size) + 1;
689  error = vlib_physmem_shared_map_create (vm, (char *) name,
690  n_pages * pagesize,
691  min_log2 (pagesize), numa_node,
692  &physmem_map_index);
693 
694  if (error && pagesize != clib_mem_get_page_size ())
695  {
696  vlib_log_warn (bm->log_default, "%U", format_clib_error, error);
697  clib_error_free (error);
698  vlib_log_warn (bm->log_default, "falling back to non-hugepage "
699  "backed buffer pool");
700  pagesize = clib_mem_get_page_size ();
701  buffers_per_numa = bm->buffers_per_numa ? bm->buffers_per_numa :
703  goto retry;
704  }
705 
706  if (error)
707  goto done;
708 
709  vec_reset_length (name);
710  name = format (name, "default-numa-%d%c", numa_node, 0);
711 
712  *index = vlib_buffer_pool_create (vm, (char *) name,
714  physmem_map_index);
715 
716  if (*index == (u8) ~ 0)
717  {
718  error = clib_error_return (0, "maximum number of buffer pools reached");
719  goto done;
720  }
721 
722 done:
723  vec_free (name);
724  return error;
725 }
726 
727 void
729 {
730  vlib_buffer_main_t *bm;
731 
732  if (vm->buffer_main)
733  return;
734 
735  vm->buffer_main = bm = clib_mem_alloc (sizeof (bm[0]));
736  clib_memset (vm->buffer_main, 0, sizeof (bm[0]));
738 }
739 
740 static u32
742 {
743  u32 cached = 0;
745 
746  clib_spinlock_lock (&bp->lock);
747 
748  /* *INDENT-OFF* */
749  vec_foreach (bpt, bp->threads)
750  cached += bpt->n_cached;
751  /* *INDENT-ON* */
752 
753  clib_spinlock_unlock (&bp->lock);
754 
755  return cached;
756 }
757 
758 static vlib_buffer_pool_t *
760 {
761  vlib_buffer_pool_t *bp;
762  if (!bm->buffer_pools || vec_len (bm->buffer_pools) < index)
763  return 0;
764  bp = vec_elt_at_index (bm->buffer_pools, index);
765 
766  return bp;
767 }
768 
769 static void
771 {
774  if (!bp)
775  return;
776 
777  e->value = bp->n_buffers - bp->n_avail - buffer_get_cached (bp);
778 }
779 
780 static void
782  u32 index)
783 {
786  if (!bp)
787  return;
788 
789  e->value = bp->n_avail;
790 }
791 
792 static void
794 {
797  if (!bp)
798  return;
799 
800  e->value = buffer_get_cached (bp);
801 }
802 
803 clib_error_t *
805 {
806  vlib_buffer_main_t *bm;
807  clib_error_t *err;
808  clib_bitmap_t *bmp = 0, *bmp_has_memory = 0;
809  u32 numa_node;
810  vlib_buffer_pool_t *bp;
811  u8 *name = 0, first_valid_buffer_pool_index = ~0;
812 
814 
815  bm = vm->buffer_main;
816  bm->log_default = vlib_log_register_class ("buffer", 0);
817  bm->ext_hdr_size = __vlib_buffer_external_hdr_size;
818 
820 
821  if ((err = clib_sysfs_read ("/sys/devices/system/node/online", "%U",
822  unformat_bitmap_list, &bmp)))
823  clib_error_free (err);
824 
825  if ((err = clib_sysfs_read ("/sys/devices/system/node/has_memory", "%U",
826  unformat_bitmap_list, &bmp_has_memory)))
827  clib_error_free (err);
828 
829  if (bmp && bmp_has_memory)
830  bmp = clib_bitmap_and (bmp, bmp_has_memory);
831 
832  /* no info from sysfs, assuming that only numa 0 exists */
833  if (bmp == 0)
834  bmp = clib_bitmap_set (bmp, 0, 1);
835 
837  clib_panic ("system have more than %u NUMA nodes",
839 
840  /* *INDENT-OFF* */
841  clib_bitmap_foreach (numa_node, bmp,
842  {
843  u8 *index = bm->default_buffer_pool_index_for_numa + numa_node;
844  index[0] = ~0;
845  if ((err = vlib_buffer_main_init_numa_node (vm, numa_node, index)))
846  {
847  clib_error_report (err);
848  clib_error_free (err);
849  continue;
850  }
851 
852  if (first_valid_buffer_pool_index == 0xff)
853  first_valid_buffer_pool_index = index[0];
854  });
855  /* *INDENT-ON* */
856 
857  if (first_valid_buffer_pool_index == (u8) ~ 0)
858  {
859  err = clib_error_return (0, "failed to allocate buffer pool(s)");
860  goto done;
861  }
862 
863  /* *INDENT-OFF* */
864  clib_bitmap_foreach (numa_node, bmp,
865  {
866  if (bm->default_buffer_pool_index_for_numa[numa_node] == (u8) ~0)
867  bm->default_buffer_pool_index_for_numa[numa_node] =
868  first_valid_buffer_pool_index;
869  });
870  /* *INDENT-ON* */
871 
872  vec_foreach (bp, bm->buffer_pools)
873  {
874  if (bp->n_buffers == 0)
875  continue;
876 
877  vec_reset_length (name);
878  name = format (name, "/buffer-pools/%s/cached%c", bp->name, 0);
880  bp - bm->buffer_pools);
881 
882  vec_reset_length (name);
883  name = format (name, "/buffer-pools/%s/used%c", bp->name, 0);
885  bp - bm->buffer_pools);
886 
887  vec_reset_length (name);
888  name = format (name, "/buffer-pools/%s/available%c", bp->name, 0);
890  bp - bm->buffer_pools);
891  }
892 
893 done:
894  vec_free (bmp);
895  vec_free (bmp_has_memory);
896  vec_free (name);
897  return err;
898 }
899 
900 static clib_error_t *
902 {
903  vlib_buffer_main_t *bm;
904 
906 
907  bm = vm->buffer_main;
908 
910  {
911  if (unformat (input, "buffers-per-numa %u", &bm->buffers_per_numa))
912  ;
913  else if (unformat (input, "default data-size %u",
914  &bm->default_data_size))
915  ;
916  else
917  return unformat_parse_error (input);
918  }
919 
920  unformat_free (input);
921  return 0;
922 }
923 
925 
926 
927 /** @endcond */
928 /*
929  * fd.io coding-style-patch-verification: ON
930  *
931  * Local Variables:
932  * eval: (c-set-style "gnu")
933  * End:
934  */
vlib_log_class_t vlib_log_register_class(char *class, char *subclass)
Definition: log.c:176
u32 flags
buffer flags: VLIB_BUFFER_FREE_LIST_INDEX_MASK: bits used to store free list index, VLIB_BUFFER_IS_TRACED: trace this buffer.
Definition: buffer.h:124
vlib_main_t vlib_global_main
Definition: main.c:1943
u8 * format_clib_error(u8 *s, va_list *va)
Definition: error.c:191
#define hash_set(h, key, value)
Definition: hash.h:255
#define vlib_log_warn(...)
Definition: log.h:103
#define clib_min(x, y)
Definition: clib.h:295
static_always_inline void clib_spinlock_unlock(clib_spinlock_t *p)
Definition: lock.h:102
static_always_inline void clib_spinlock_lock(clib_spinlock_t *p)
Definition: lock.h:80
#define CLIB_CACHE_LINE_ROUND(x)
Definition: cache.h:61
a
Definition: bitmap.h:538
static clib_error_t * vlib_buffers_configure(vlib_main_t *vm, unformat_input_t *input)
Definition: buffer.c:901
void vlib_buffer_main_alloc(vlib_main_t *vm)
Definition: buffer.c:728
STATIC_ASSERT_OFFSET_OF(vlib_buffer_t, template_end, 64)
static void buffer_gauges_update_used_fn(stat_segment_directory_entry_t *e, u32 index)
Definition: buffer.c:770
i16 current_data
signed offset in data[], pre_data[] that we are currently processing.
Definition: buffer.h:110
unsigned long u64
Definition: types.h:89
#define clib_memcpy_fast(a, b, c)
Definition: string.h:81
clib_memset(h->entries, 0, sizeof(h->entries[0]) *entries)
#define vec_add2_aligned(V, P, N, A)
Add N elements to end of vector V, return pointer to new elements in P.
Definition: vec.h:573
static void vlib_buffer_chain_increase_length(vlib_buffer_t *first, vlib_buffer_t *last, i32 len)
int vlib_buffer_add_data(vlib_main_t *vm, u32 *buffer_index, void *data, u32 n_data_bytes)
Definition: buffer.c:421
#define VLIB_BUFFER_PRE_DATA_SIZE
Definition: buffer.h:51
u32 physmem_map_index
Definition: buffer.h:430
u16 current_length
Nbytes between current data and the end of this buffer.
Definition: buffer.h:113
#define CLIB_LOG2_CACHE_LINE_BYTES
Definition: cache.h:50
u8 data[0]
Packet data.
Definition: buffer.h:181
static heap_elt_t * last(heap_header_t *h)
Definition: heap.c:53
int i
vlib_buffer_main_t * buffer_main
Definition: main.h:152
static uword * clib_bitmap_set(uword *ai, uword i, uword value)
Sets the ith bit of a bitmap to new_value Removes trailing zeros from the bitmap. ...
Definition: bitmap.h:167
static u32 format_get_indent(u8 *s)
Definition: format.h:72
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
u8 * va_format(u8 *s, const char *fmt, va_list *va)
Definition: format.c:387
vlib_physmem_map_t * vlib_physmem_get_map(vlib_main_t *vm, u32 index)
Definition: physmem.c:87
#define vec_validate_aligned(V, I, A)
Make sure vector is long enough for given index (no header, specified alignment)
Definition: vec.h:451
static u8 * format_vlib_buffer_pool(u8 *s, va_list *va)
Definition: buffer.c:594
static clib_error_t * show_buffers(vlib_main_t *vm, unformat_input_t *input, vlib_cli_command_t *cmd)
Definition: buffer.c:621
static vlib_buffer_known_state_t vlib_buffer_is_known(vlib_main_t *vm, u32 buffer_index)
Definition: buffer_funcs.h:462
unsigned char u8
Definition: types.h:56
u8 default_buffer_pool_index_for_numa[VLIB_BUFFER_MAX_NUMA_NODES]
Definition: buffer.h:462
static uword min_log2(uword x)
Definition: clib.h:144
u8 buffer_pool_index
index of buffer pool this buffer belongs.
Definition: buffer.h:133
uword vlib_buffer_length_in_chain_slow_path(vlib_main_t *vm, vlib_buffer_t *b_first)
Definition: buffer.c:78
#define vec_reset_length(v)
Reset vector length to zero NULL-pointer tolerant.
#define vlib_worker_thread_barrier_sync(X)
Definition: threads.h:204
#define vec_add(V, E, N)
Add N elements to end of vector V (no header, unspecified alignment)
Definition: vec.h:599
vlib_buffer_pool_thread_t * threads
Definition: buffer.h:439
uint64_t value
u16 vlib_buffer_chain_append_data_with_alloc(vlib_main_t *vm, vlib_buffer_t *first, vlib_buffer_t **last, void *data, u16 data_len)
Definition: buffer.c:476
void * vlib_packet_template_get_packet(vlib_main_t *vm, vlib_packet_template_t *t, u32 *bi_result)
Definition: buffer.c:400
static void buffer_gauges_update_available_fn(stat_segment_directory_entry_t *e, u32 index)
Definition: buffer.c:781
u8 * format_white_space(u8 *s, va_list *va)
Definition: std-formats.c:129
uword buffer_mem_size
Definition: buffer.h:453
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
u8 * format_hex_bytes(u8 *s, va_list *va)
Definition: std-formats.c:84
#define clib_error_return(e, args...)
Definition: error.h:99
u8 * format_vlib_buffer_no_chain(u8 *s, va_list *args)
Definition: buffer.c:95
unsigned int u32
Definition: types.h:88
u8 * format_vlib_buffer(u8 *s, va_list *args)
Definition: buffer.c:125
static u32 vlib_get_buffer_index(vlib_main_t *vm, void *p)
Translate buffer pointer into buffer index.
Definition: buffer_funcs.h:257
static void clib_spinlock_init(clib_spinlock_t *p)
Definition: lock.h:63
static heap_elt_t * first(heap_header_t *h)
Definition: heap.c:59
#define hash_get(h, key)
Definition: hash.h:249
#define clib_bitmap_foreach(i, ai, body)
Macro to iterate across set bits in a bitmap.
Definition: bitmap.h:361
clib_error_t * vlib_physmem_shared_map_create(vlib_main_t *vm, char *name, uword size, u32 log2_page_sz, u32 numa_node, u32 *map_index)
Definition: physmem.c:42
void vlib_packet_template_init(vlib_main_t *vm, vlib_packet_template_t *t, void *packet_data, uword n_packet_data_bytes, uword min_n_buffers_each_alloc, char *fmt,...)
Definition: buffer.c:378
static uword clib_bitmap_last_set(uword *ai)
Return the higest numbered set bit in a bitmap.
Definition: bitmap.h:423
static_always_inline void vlib_buffer_copy_template(vlib_buffer_t *b, vlib_buffer_t *bt)
Definition: buffer_funcs.h:145
struct _unformat_input_t unformat_input_t
unsigned short u16
Definition: types.h:57
uword clib_mem_get_page_size(void)
Definition: mem.c:51
u64 size
Definition: vhost_user.h:140
vlib_buffer_t buffer_template
Definition: buffer.h:442
static void * vlib_buffer_get_current(vlib_buffer_t *b)
Get pointer to current data to process.
Definition: buffer.h:229
#define hash_free(h)
Definition: hash.h:310
vlib_buffer_pool_t * buffer_pools
Definition: buffer.h:454
u32 trace_handle
Specifies trace buffer handle if VLIB_PACKET_IS_TRACED flag is set.
Definition: buffer.h:163
static u8 * vlib_validate_buffer_helper(vlib_main_t *vm, u32 bi, uword follow_buffer_next, uword **unique_hash)
Definition: buffer.c:205
static u32 buffer_get_cached(vlib_buffer_pool_t *bp)
Definition: buffer.c:741
clib_error_t * clib_sysfs_read(char *file_name, char *fmt,...)
Definition: sysfs.c:50
vlib_log_class_t log_default
Definition: buffer.h:470
#define STATIC_ASSERT_FITS_IN(s, e, o)
u8 len
Definition: ip_types.api:91
static vlib_buffer_pool_t * buffer_get_by_index(vlib_buffer_main_t *bm, u32 index)
Definition: buffer.c:759
static_always_inline u32 vlib_buffer_get_default_data_size(vlib_main_t *vm)
Definition: buffer_funcs.h:96
clib_spinlock_t buffer_known_hash_lockp
Definition: buffer.h:461
#define VLIB_EARLY_CONFIG_FUNCTION(x, n,...)
Definition: init.h:226
#define UNFORMAT_END_OF_INPUT
Definition: format.h:145
u32 flags
Definition: vhost_user.h:141
clib_error_t * stat_segment_register_gauge(u8 *name, stat_segment_update_fn update_fn, u32 caller_index)
Definition: stat_segment.c:753
vlib_main_t * vm
Definition: buffer.c:323
vec_header_t h
Definition: buffer.c:322
u8 * format_vlib_buffer_contents(u8 *s, va_list *va)
Definition: buffer.c:188
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:342
u8 * vlib_validate_buffer(vlib_main_t *vm, u32 bi, uword follow_buffer_next)
Definition: buffer.c:254
#define VLIB_BUFFER_MAX_NUMA_NODES
Definition: buffer.h:445
#define clib_warning(format, args...)
Definition: error.h:59
clib_spinlock_t lock
Definition: buffer.h:436
clib_error_t * vlib_buffer_main_init(struct vlib_main_t *vm)
Definition: buffer.c:804
u32 buffers_per_numa
Definition: buffer.h:465
#define VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA
Definition: buffer.c:51
vlib_buffer_known_state_t
Definition: buffer_funcs.h:446
string name[64]
Definition: ip.api:44
#define VLIB_CLI_COMMAND(x,...)
Definition: cli.h:152
static void buffer_gauges_update_cached_fn(stat_segment_directory_entry_t *e, u32 index)
Definition: buffer.c:793
#define hash_set1(h, key)
Definition: hash.h:258
#define hash_create(elts, value_bytes)
Definition: hash.h:696
static u32 vlib_buffer_alloc_from_pool(vlib_main_t *vm, u32 *buffers, u32 n_buffers, u8 buffer_pool_index)
Allocate buffers from specific pool into supplied array.
Definition: buffer_funcs.h:530
#define ASSERT(truth)
u8 data[128]
Definition: ipsec_types.api:87
static u8 * format_vlib_buffer_known_state(u8 *s, va_list *args)
Definition: buffer.c:160
u8 * format_vlib_buffer_and_data(u8 *s, va_list *args)
Definition: buffer.c:148
vector header structure
Definition: vec_bootstrap.h:55
#define clib_error_report(e)
Definition: error.h:113
uword clib_mem_get_default_hugepage_size(void)
Definition: mem.c:57
static void * clib_mem_alloc(uword size)
Definition: mem.h:153
static uword pointer_to_uword(const void *p)
Definition: types.h:131
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
#define unformat_parse_error(input)
Definition: format.h:269
VLIB_WORKER_INIT_FUNCTION(vlib_buffer_worker_init)
static vlib_buffer_t * vlib_buffer_chain_buffer(vlib_main_t *vm, vlib_buffer_t *last, u32 next_bi)
#define VLIB_BUFFER_DEFAULT_DATA_SIZE
Definition: buffer.h:53
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
u32 next_buffer
Next buffer for this linked-list of buffers.
Definition: buffer.h:140
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
static void unformat_free(unformat_input_t *i)
Definition: format.h:163
uword buffer_mem_start
Definition: buffer.h:452
uword * buffer_known_hash
Definition: buffer.h:460
u32 default_data_size
Definition: buffer.h:467
u8 * vlib_validate_buffers(vlib_main_t *vm, u32 *buffers, uword next_buffer_stride, uword n_buffers, vlib_buffer_known_state_t known_state, uword follow_buffer_next)
Definition: buffer.c:261
#define clib_error_free(e)
Definition: error.h:86
clib_error_t * vlib_buffer_worker_init(vlib_main_t *vm)
Definition: buffer.c:646
static void * clib_mem_alloc_aligned(uword size, uword align)
Definition: mem.h:161
void vlib_worker_thread_barrier_release(vlib_main_t *vm)
Definition: threads.c:1484
vl_api_dhcp_client_state_t state
Definition: dhcp.api:201
uword clib_bitmap_t
Definition: bitmap.h:50
#define vec_foreach(var, vec)
Vector iterator.
u8 vlib_buffer_pool_create(vlib_main_t *vm, char *name, u32 data_size, u32 physmem_map_index)
Definition: buffer.c:508
#define VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA_UNPRIV
Definition: buffer.c:52
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
u32 total_length_not_including_first_buffer
Only valid for first buffer in chain.
Definition: buffer.h:167
static u32 vlib_buffer_alloc(vlib_main_t *vm, u32 *buffers, u32 n_buffers)
Allocate buffers into supplied array.
Definition: buffer_funcs.h:630
void vlib_cli_output(vlib_main_t *vm, char *fmt,...)
Definition: cli.c:689
volatile u8 ref_count
Reference count for this buffer.
Definition: buffer.h:130
static uword * clib_bitmap_and(uword *ai, uword *bi)
Logical operator across two bitmaps.
static clib_error_t * vlib_buffer_main_init_numa_node(struct vlib_main_t *vm, u32 numa_node, u8 *index)
Definition: buffer.c:667
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:85
#define clib_panic(format, args...)
Definition: error.h:72
void vlib_buffer_validate_alloc_free(vlib_main_t *vm, u32 *buffers, uword n_buffers, vlib_buffer_known_state_t expected_state)
Definition: buffer.c:338
uword unformat(unformat_input_t *i, const char *fmt,...)
Definition: unformat.c:978
static uword unformat_check_input(unformat_input_t *i)
Definition: format.h:171