src/vlib/buffer.c

   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 <vlib/stats/stats.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: */
  56 STATIC_ASSERT_FITS_IN (vlib_buffer_t, flags, 16);
  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 u16 __vlib_buffer_external_hdr_size = 0;
  62
  63 uword
  64 vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
  65                                        vlib_buffer_t * b_first)
  66 {
  67   vlib_buffer_t *b = b_first;
  68   uword l_first = b_first->current_length;
  69   uword l = 0;
  70   while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
  71     {
  72       b = vlib_get_buffer (vm, b->next_buffer);
  73       l += b->current_length;
  74     }
  75   b_first->total_length_not_including_first_buffer = l;
  76   b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
  77   return l + l_first;
  78 }
  79
  80 u8 *
  81 format_vlib_buffer_no_chain (u8 * s, va_list * args)
  82 {
  83   vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
  84   u32 indent = format_get_indent (s);
  85   u8 *a = 0;
  86
  87 #define _(bit, name, v) \
  88   if (v && (b->flags & VLIB_BUFFER_##name)) \
  89     a = format (a, "%s ", v);
  90   foreach_vlib_buffer_flag
  91 #undef _
  92     s = format (s, "current data %d, length %d, buffer-pool %d, "
  93                 "ref-count %u", b->current_data, b->current_length,
  94                 b->buffer_pool_index, b->ref_count);
  95
  96   if (b->flags & VLIB_BUFFER_NEXT_PRESENT)
  97     s = format (s, ", totlen-nifb %d",
  98                 b->total_length_not_including_first_buffer);
  99
 100   if (b->flags & VLIB_BUFFER_IS_TRACED)
 101     s = format (s, ", trace handle 0x%x", b->trace_handle);
 102
 103   if (a)
 104     s = format (s, "\n%U%v", format_white_space, indent, a);
 105   vec_free (a);
 106
 107   return s;
 108 }
 109
 110 u8 *
 111 format_vlib_buffer (u8 * s, va_list * args)
 112 {
 113   vlib_main_t *vm = vlib_get_main ();
 114   vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
 115   u32 indent = format_get_indent (s);
 116
 117   s = format (s, "%U", format_vlib_buffer_no_chain, b);
 118
 119   while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
 120     {
 121       u32 next_buffer = b->next_buffer;
 122       b = vlib_get_buffer (vm, next_buffer);
 123
 124       s =
 125         format (s, "\n%Unext-buffer 0x%x, segment length %d, ref-count %u",
 126                 format_white_space, indent, next_buffer, b->current_length,
 127                 b->ref_count);
 128     }
 129
 130   return s;
 131 }
 132
 133 u8 *
 134 format_vlib_buffer_and_data (u8 * s, va_list * args)
 135 {
 136   vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
 137
 138   s = format (s, "%U, %U",
 139               format_vlib_buffer, b,
 140               format_hex_bytes, vlib_buffer_get_current (b), 64);
 141
 142   return s;
 143 }
 144
 145 static u8 *
 146 format_vlib_buffer_known_state (u8 * s, va_list * args)
 147 {
 148   vlib_buffer_known_state_t state = va_arg (*args, vlib_buffer_known_state_t);
 149   char *t;
 150
 151   switch (state)
 152     {
 153     case VLIB_BUFFER_UNKNOWN:
 154       t = "unknown";
 155       break;
 156
 157     case VLIB_BUFFER_KNOWN_ALLOCATED:
 158       t = "known-allocated";
 159       break;
 160
 161     case VLIB_BUFFER_KNOWN_FREE:
 162       t = "known-free";
 163       break;
 164
 165     default:
 166       t = "invalid";
 167       break;
 168     }
 169
 170   return format (s, "%s", t);
 171 }
 172
 173 u8 *
 174 format_vlib_buffer_contents (u8 * s, va_list * va)
 175 {
 176   vlib_main_t *vm = va_arg (*va, vlib_main_t *);
 177   vlib_buffer_t *b = va_arg (*va, vlib_buffer_t *);
 178
 179   while (1)
 180     {
 181       vec_add (s, vlib_buffer_get_current (b), b->current_length);
 182       if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
 183         break;
 184       b = vlib_get_buffer (vm, b->next_buffer);
 185     }
 186
 187   return s;
 188 }
 189
 190 static u8 *
 191 vlib_validate_buffer_helper (vlib_main_t * vm,
 192                              u32 bi,
 193                              uword follow_buffer_next, uword ** unique_hash)
 194 {
 195   vlib_buffer_main_t *bm = vm->buffer_main;
 196   vlib_buffer_t *b = vlib_get_buffer (vm, bi);
 197
 198   if (vec_len (bm->buffer_pools) <= b->buffer_pool_index)
 199     return format (0, "unknown buffer pool 0x%x", b->buffer_pool_index);
 200
 201   if ((signed) b->current_data < (signed) -VLIB_BUFFER_PRE_DATA_SIZE)
 202     return format (0, "current data %d before pre-data", b->current_data);
 203
 204   if (b->current_data + b->current_length >
 205       vlib_buffer_get_default_data_size (vm))
 206     return format (0, "%d-%d beyond end of buffer %d", b->current_data,
 207                    b->current_length, vlib_buffer_get_default_data_size (vm));
 208
 209   if (follow_buffer_next && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
 210     {
 211       vlib_buffer_known_state_t k;
 212       u8 *msg, *result;
 213
 214       k = vlib_buffer_is_known (vm, b->next_buffer);
 215       if (k != VLIB_BUFFER_KNOWN_ALLOCATED)
 216         return format (0, "next 0x%x: %U",
 217                        b->next_buffer, format_vlib_buffer_known_state, k);
 218
 219       if (unique_hash)
 220         {
 221           if (hash_get (*unique_hash, b->next_buffer))
 222             return format (0, "duplicate buffer 0x%x", b->next_buffer);
 223
 224           hash_set1 (*unique_hash, b->next_buffer);
 225         }
 226
 227       msg = vlib_validate_buffer (vm, b->next_buffer, follow_buffer_next);
 228       if (msg)
 229         {
 230           result = format (0, "next 0x%x: %v", b->next_buffer, msg);
 231           vec_free (msg);
 232           return result;
 233         }
 234     }
 235
 236   return 0;
 237 }
 238
 239 u8 *
 240 vlib_validate_buffer (vlib_main_t * vm, u32 bi, uword follow_buffer_next)
 241 {
 242   return vlib_validate_buffer_helper (vm, bi, follow_buffer_next,
 243                                       /* unique_hash */ 0);
 244 }
 245
 246 u8 *
 247 vlib_validate_buffers (vlib_main_t * vm,
 248                        u32 * buffers,
 249                        uword next_buffer_stride,
 250                        uword n_buffers,
 251                        vlib_buffer_known_state_t known_state,
 252                        uword follow_buffer_next)
 253 {
 254   uword i, *hash;
 255   u32 bi, *b = buffers;
 256   vlib_buffer_known_state_t k;
 257   u8 *msg = 0, *result = 0;
 258
 259   hash = hash_create (0, 0);
 260   for (i = 0; i < n_buffers; i++)
 261     {
 262       bi = b[0];
 263       b += next_buffer_stride;
 264
 265       /* Buffer is not unique. */
 266       if (hash_get (hash, bi))
 267         {
 268           msg = format (0, "not unique");
 269           goto done;
 270         }
 271
 272       k = vlib_buffer_is_known (vm, bi);
 273       if (k != known_state)
 274         {
 275           msg = format (0, "is %U; expected %U",
 276                         format_vlib_buffer_known_state, k,
 277                         format_vlib_buffer_known_state, known_state);
 278           goto done;
 279         }
 280
 281       msg = vlib_validate_buffer_helper (vm, bi, follow_buffer_next, &hash);
 282       if (msg)
 283         goto done;
 284
 285       hash_set1 (hash, bi);
 286     }
 287
 288 done:
 289   if (msg)
 290     {
 291       result = format (0, "0x%x: %v", bi, msg);
 292       vec_free (msg);
 293     }
 294   hash_free (hash);
 295   return result;
 296 }
 297
 298 /* When debugging validate that given buffers are either known allocated
 299    or known free. */
 300 void
 301 vlib_buffer_validate_alloc_free (vlib_main_t * vm,
 302                                  u32 * buffers,
 303                                  uword n_buffers,
 304                                  vlib_buffer_known_state_t expected_state)
 305 {
 306   vlib_buffer_main_t *bm = vm->buffer_main;
 307   u32 *b;
 308   uword i, bi, is_free;
 309
 310   if (CLIB_DEBUG == 0)
 311     return;
 312
 313   is_free = expected_state == VLIB_BUFFER_KNOWN_ALLOCATED;
 314   b = buffers;
 315   for (i = 0; i < n_buffers; i++)
 316     {
 317       vlib_buffer_known_state_t known;
 318
 319       bi = b[0];
 320       b += 1;
 321       known = vlib_buffer_is_known (vm, bi);
 322
 323       if (known == VLIB_BUFFER_UNKNOWN &&
 324           expected_state == VLIB_BUFFER_KNOWN_FREE)
 325         known = VLIB_BUFFER_KNOWN_FREE;
 326
 327       if (known != expected_state)
 328         {
 329           clib_panic ("%s %U buffer 0x%x", is_free ? "freeing" : "allocating",
 330                       format_vlib_buffer_known_state, known, bi);
 331         }
 332
 333       clib_spinlock_lock (&bm->buffer_known_hash_lockp);
 334       hash_set (bm->buffer_known_hash, bi, is_free ? VLIB_BUFFER_KNOWN_FREE :
 335                 VLIB_BUFFER_KNOWN_ALLOCATED);
 336       clib_spinlock_unlock (&bm->buffer_known_hash_lockp);
 337     }
 338 }
 339
 340 void
 341 vlib_packet_template_init (vlib_main_t * vm,
 342                            vlib_packet_template_t * t,
 343                            void *packet_data,
 344                            uword n_packet_data_bytes,
 345                            uword min_n_buffers_each_alloc, char *fmt, ...)
 346 {
 347   va_list va;
 348
 349   va_start (va, fmt);
 350   t->name = va_format (0, fmt, &va);
 351   va_end (va);
 352
 353   vlib_worker_thread_barrier_sync (vm);
 354
 355   clib_memset (t, 0, sizeof (t[0]));
 356
 357   vec_add (t->packet_data, packet_data, n_packet_data_bytes);
 358   t->min_n_buffers_each_alloc = min_n_buffers_each_alloc;
 359   vlib_worker_thread_barrier_release (vm);
 360 }
 361
 362 void *
 363 vlib_packet_template_get_packet (vlib_main_t * vm,
 364                                  vlib_packet_template_t * t, u32 * bi_result)
 365 {
 366   u32 bi;
 367   vlib_buffer_t *b;
 368
 369   if (vlib_buffer_alloc (vm, &bi, 1) != 1)
 370     return 0;
 371
 372   *bi_result = bi;
 373
 374   b = vlib_get_buffer (vm, bi);
 375   clib_memcpy_fast (vlib_buffer_get_current (b),
 376                     t->packet_data, vec_len (t->packet_data));
 377   b->current_length = vec_len (t->packet_data);
 378
 379   return b->data;
 380 }
 381
 382 /* Append given data to end of buffer, possibly allocating new buffers. */
 383 int
 384 vlib_buffer_add_data (vlib_main_t * vm, u32 * buffer_index, void *data,
 385                       u32 n_data_bytes)
 386 {
 387   u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
 388   vlib_buffer_t *b;
 389   void *d;
 390
 391   bi = *buffer_index;
 392   if (bi == ~0 && 1 != vlib_buffer_alloc (vm, &bi, 1))
 393     goto out_of_buffers;
 394
 395   d = data;
 396   n_left = n_data_bytes;
 397   n_buffer_bytes = vlib_buffer_get_default_data_size (vm);
 398
 399   b = vlib_get_buffer (vm, bi);
 400   b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
 401
 402   /* Get to the end of the chain before we try to append data... */
 403   while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
 404     b = vlib_get_buffer (vm, b->next_buffer);
 405
 406   while (1)
 407     {
 408       u32 n;
 409
 410       ASSERT (n_buffer_bytes >= b->current_length);
 411       n_left_this_buffer =
 412         n_buffer_bytes - (b->current_data + b->current_length);
 413       n = clib_min (n_left_this_buffer, n_left);
 414       clib_memcpy_fast (vlib_buffer_get_current (b) + b->current_length, d,
 415                         n);
 416       b->current_length += n;
 417       n_left -= n;
 418       if (n_left == 0)
 419         break;
 420
 421       d += n;
 422       if (1 != vlib_buffer_alloc (vm, &b->next_buffer, 1))
 423         goto out_of_buffers;
 424
 425       b->flags |= VLIB_BUFFER_NEXT_PRESENT;
 426
 427       b = vlib_get_buffer (vm, b->next_buffer);
 428     }
 429
 430   *buffer_index = bi;
 431   return 0;
 432
 433 out_of_buffers:
 434   clib_warning ("out of buffers");
 435   return 1;
 436 }
 437
 438 u16
 439 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
 440                                           vlib_buffer_t * first,
 441                                           vlib_buffer_t ** last, void *data,
 442                                           u16 data_len)
 443 {
 444   vlib_buffer_t *l = *last;
 445   u32 n_buffer_bytes = vlib_buffer_get_default_data_size (vm);
 446   u16 copied = 0;
 447   ASSERT (n_buffer_bytes >= l->current_length + l->current_data);
 448   while (data_len)
 449     {
 450       u16 max = n_buffer_bytes - l->current_length - l->current_data;
 451       if (max == 0)
 452         {
 453           if (1 != vlib_buffer_alloc_from_pool (vm, &l->next_buffer, 1,
 454                                                 first->buffer_pool_index))
 455             return copied;
 456           *last = l = vlib_buffer_chain_buffer (vm, l, l->next_buffer);
 457           max = n_buffer_bytes - l->current_length - l->current_data;
 458         }
 459
 460       u16 len = (data_len > max) ? max : data_len;
 461       clib_memcpy_fast (vlib_buffer_get_current (l) + l->current_length,
 462                         data + copied, len);
 463       vlib_buffer_chain_increase_length (first, l, len);
 464       data_len -= len;
 465       copied += len;
 466     }
 467   return copied;
 468 }
 469
 470 static uword
 471 vlib_buffer_alloc_size (uword ext_hdr_size, uword data_size)
 472 {
 473   uword alloc_size = ext_hdr_size + sizeof (vlib_buffer_t) + data_size;
 474   alloc_size = round_pow2 (alloc_size, VLIB_BUFFER_ALIGN);
 475
 476   return alloc_size;
 477 }
 478
 479 u8
 480 vlib_buffer_pool_create (vlib_main_t *vm, u32 data_size, u32 physmem_map_index,
 481                          char *fmt, ...)
 482 {
 483   vlib_buffer_main_t *bm = vm->buffer_main;
 484   vlib_buffer_pool_t *bp;
 485   vlib_physmem_map_t *m = vlib_physmem_get_map (vm, physmem_map_index);
 486   uword start = pointer_to_uword (m->base);
 487   uword size = (uword) m->n_pages << m->log2_page_size;
 488   uword page_mask = ~pow2_mask (m->log2_page_size);
 489   u8 *p;
 490   u32 alloc_size;
 491   va_list va;
 492
 493   if (vec_len (bm->buffer_pools) >= 255)
 494     return ~0;
 495
 496   vec_add2_aligned (bm->buffer_pools, bp, 1, CLIB_CACHE_LINE_BYTES);
 497
 498   if (bm->buffer_mem_size == 0)
 499     {
 500       bm->buffer_mem_start = start;
 501       bm->buffer_mem_size = size;
 502     }
 503   else if (start < bm->buffer_mem_start)
 504     {
 505       bm->buffer_mem_size += bm->buffer_mem_start - start;
 506       bm->buffer_mem_start = start;
 507       if (size > bm->buffer_mem_size)
 508         bm->buffer_mem_size = size;
 509     }
 510   else if (start > bm->buffer_mem_start)
 511     {
 512       uword new_size = start - bm->buffer_mem_start + size;
 513       if (new_size > bm->buffer_mem_size)
 514         bm->buffer_mem_size = new_size;
 515     }
 516
 517   if ((u64) bm->buffer_mem_size >
 518       ((u64) 1 << (32 + CLIB_LOG2_CACHE_LINE_BYTES)))
 519     {
 520       clib_panic ("buffer memory size out of range!");
 521     }
 522
 523   bp->start = start;
 524   bp->size = size;
 525   bp->index = bp - bm->buffer_pools;
 526   bp->buffer_template.buffer_pool_index = bp->index;
 527   bp->buffer_template.ref_count = 1;
 528   bp->physmem_map_index = physmem_map_index;
 529   bp->data_size = data_size;
 530   bp->numa_node = m->numa_node;
 531   bp->log2_page_size = m->log2_page_size;
 532
 533   va_start (va, fmt);
 534   bp->name = va_format (0, fmt, &va);
 535   va_end (va);
 536
 537   vec_validate_aligned (bp->threads, vlib_get_n_threads () - 1,
 538                         CLIB_CACHE_LINE_BYTES);
 539
 540   alloc_size = vlib_buffer_alloc_size (bm->ext_hdr_size, data_size);
 541   bp->alloc_size = alloc_size;
 542
 543   /* preallocate buffer indices memory */
 544   bp->buffers = clib_mem_alloc_aligned (
 545     round_pow2 ((size / alloc_size) * sizeof (u32), CLIB_CACHE_LINE_BYTES),
 546     CLIB_CACHE_LINE_BYTES);
 547
 548   clib_spinlock_init (&bp->lock);
 549
 550   p = m->base;
 551
 552   /* start with naturally aligned address */
 553   p += alloc_size - (uword) p % alloc_size;
 554
 555   /*
 556    * Waste 1 buffer (maximum) so that 0 is never a valid buffer index.
 557    * Allows various places to ASSERT (bi != 0). Much easier
 558    * than debugging downstream crashes in successor nodes.
 559    */
 560   if (p == m->base)
 561     p += alloc_size;
 562
 563   for (; p < (u8 *) m->base + size - alloc_size; p += alloc_size)
 564     {
 565       vlib_buffer_t *b;
 566       u32 bi;
 567
 568       /* skip if buffer spans across page boundary */
 569       if (((uword) p & page_mask) != ((uword) (p + alloc_size) & page_mask))
 570         continue;
 571
 572       b = (vlib_buffer_t *) (p + bm->ext_hdr_size);
 573       b->template = bp->buffer_template;
 574       bi = vlib_get_buffer_index (vm, b);
 575       bp->buffers[bp->n_avail++] = bi;
 576       vlib_get_buffer (vm, bi);
 577     }
 578
 579   bp->n_buffers = bp->n_avail;
 580
 581   return bp->index;
 582 }
 583
 584 static u8 *
 585 format_vlib_buffer_pool (u8 * s, va_list * va)
 586 {
 587   vlib_main_t *vm = va_arg (*va, vlib_main_t *);
 588   vlib_buffer_pool_t *bp = va_arg (*va, vlib_buffer_pool_t *);
 589   vlib_buffer_pool_thread_t *bpt;
 590   u32 cached = 0;
 591
 592   if (!bp)
 593     return format (s, "%-20s%=6s%=6s%=6s%=11s%=6s%=8s%=8s%=8s",
 594                    "Pool Name", "Index", "NUMA", "Size", "Data Size",
 595                    "Total", "Avail", "Cached", "Used");
 596
 597   /* *INDENT-OFF* */
 598   vec_foreach (bpt, bp->threads)
 599     cached += bpt->n_cached;
 600   /* *INDENT-ON* */
 601
 602   s = format (s, "%-20v%=6d%=6d%=6u%=11u%=6u%=8u%=8u%=8u", bp->name, bp->index,
 603               bp->numa_node,
 604               bp->data_size + sizeof (vlib_buffer_t) +
 605                 vm->buffer_main->ext_hdr_size,
 606               bp->data_size, bp->n_buffers, bp->n_avail, cached,
 607               bp->n_buffers - bp->n_avail - cached);
 608
 609   return s;
 610 }
 611
 612 u8 *
 613 format_vlib_buffer_pool_all (u8 *s, va_list *va)
 614 {
 615   vlib_main_t *vm = va_arg (*va, vlib_main_t *);
 616   vlib_buffer_main_t *bm = vm->buffer_main;
 617   vlib_buffer_pool_t *bp;
 618
 619   s = format (s, "%U", format_vlib_buffer_pool, vm, 0);
 620
 621   vec_foreach (bp, bm->buffer_pools)
 622     s = format (s, "\n%U", format_vlib_buffer_pool, vm, bp);
 623
 624   return s;
 625 }
 626
 627 static clib_error_t *
 628 show_buffers (vlib_main_t *vm, unformat_input_t *input,
 629               vlib_cli_command_t *cmd)
 630 {
 631   vlib_cli_output (vm, "%U", format_vlib_buffer_pool_all, vm);
 632   return 0;
 633 }
 634
 635 /* *INDENT-OFF* */
 636 VLIB_CLI_COMMAND (show_buffers_command, static) = {
 637   .path = "show buffers",
 638   .short_help = "Show packet buffer allocation",
 639   .function = show_buffers,
 640 };
 641 /* *INDENT-ON* */
 642
 643 clib_error_t *
 644 vlib_buffer_num_workers_change (vlib_main_t *vm)
 645 {
 646   vlib_buffer_main_t *bm = vm->buffer_main;
 647   vlib_buffer_pool_t *bp;
 648
 649   vec_foreach (bp, bm->buffer_pools)
 650     vec_validate_aligned (bp->threads, vlib_get_n_threads () - 1,
 651                           CLIB_CACHE_LINE_BYTES);
 652
 653   return 0;
 654 }
 655
 656 VLIB_NUM_WORKERS_CHANGE_FN (vlib_buffer_num_workers_change);
 657
 658 static clib_error_t *
 659 vlib_buffer_main_init_numa_alloc (struct vlib_main_t *vm, u32 numa_node,
 660                                   u32 * physmem_map_index,
 661                                   clib_mem_page_sz_t log2_page_size,
 662                                   u8 unpriv)
 663 {
 664   vlib_buffer_main_t *bm = vm->buffer_main;
 665   u32 buffers_per_numa = bm->buffers_per_numa;
 666   clib_error_t *error;
 667   u32 buffer_size;
 668   uword n_pages, pagesize;
 669   u8 *name = 0;
 670
 671   ASSERT (log2_page_size != CLIB_MEM_PAGE_SZ_UNKNOWN);
 672
 673   pagesize = clib_mem_page_bytes (log2_page_size);
 674   buffer_size = vlib_buffer_alloc_size (bm->ext_hdr_size,
 675                                         vlib_buffer_get_default_data_size
 676                                         (vm));
 677   if (buffer_size > pagesize)
 678     return clib_error_return (0, "buffer size (%llu) is greater than page "
 679                               "size (%llu)", buffer_size, pagesize);
 680
 681   if (buffers_per_numa == 0)
 682     buffers_per_numa = unpriv ? VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA_UNPRIV :
 683       VLIB_BUFFER_DEFAULT_BUFFERS_PER_NUMA;
 684
 685   name = format (0, "buffers-numa-%d%c", numa_node, 0);
 686   n_pages = (buffers_per_numa - 1) / (pagesize / buffer_size) + 1;
 687   error = vlib_physmem_shared_map_create (vm, (char *) name,
 688                                           n_pages * pagesize,
 689                                           min_log2 (pagesize), numa_node,
 690                                           physmem_map_index);
 691   vec_free (name);
 692   return error;
 693 }
 694
 695 static clib_error_t *
 696 vlib_buffer_main_init_numa_node (struct vlib_main_t *vm, u32 numa_node,
 697                                  u8 * index)
 698 {
 699   vlib_buffer_main_t *bm = vm->buffer_main;
 700   u32 physmem_map_index;
 701   clib_error_t *error;
 702
 703   if (bm->log2_page_size == CLIB_MEM_PAGE_SZ_UNKNOWN)
 704     {
 705       error = vlib_buffer_main_init_numa_alloc (vm, numa_node,
 706                                                 &physmem_map_index,
 707                                                 CLIB_MEM_PAGE_SZ_DEFAULT_HUGE,
 708                                                 0 /* unpriv */ );
 709       if (!error)
 710         goto buffer_pool_create;
 711
 712       /* If alloc failed, retry without hugepages */
 713       vlib_log_warn (bm->log_default,
 714                      "numa[%u] falling back to non-hugepage backed "
 715                      "buffer pool (%U)", numa_node, format_clib_error, error);
 716       clib_error_free (error);
 717
 718       error = vlib_buffer_main_init_numa_alloc (vm, numa_node,
 719                                                 &physmem_map_index,
 720                                                 CLIB_MEM_PAGE_SZ_DEFAULT,
 721                                                 1 /* unpriv */ );
 722     }
 723   else
 724     error = vlib_buffer_main_init_numa_alloc (vm, numa_node,
 725                                               &physmem_map_index,
 726                                               bm->log2_page_size,
 727                                               0 /* unpriv */ );
 728   if (error)
 729     return error;
 730
 731 buffer_pool_create:
 732   *index =
 733     vlib_buffer_pool_create (vm, vlib_buffer_get_default_data_size (vm),
 734                              physmem_map_index, "default-numa-%d", numa_node);
 735
 736   if (*index == (u8) ~ 0)
 737     error = clib_error_return (0, "maximum number of buffer pools reached");
 738
 739
 740   return error;
 741 }
 742
 743 void
 744 vlib_buffer_main_alloc (vlib_main_t * vm)
 745 {
 746   vlib_buffer_main_t *bm;
 747
 748   if (vm->buffer_main)
 749     return;
 750
 751   vm->buffer_main = bm = clib_mem_alloc (sizeof (bm[0]));
 752   clib_memset (vm->buffer_main, 0, sizeof (bm[0]));
 753   bm->default_data_size = VLIB_BUFFER_DEFAULT_DATA_SIZE;
 754 }
 755
 756 static u32
 757 buffer_get_cached (vlib_buffer_pool_t * bp)
 758 {
 759   u32 cached = 0;
 760   vlib_buffer_pool_thread_t *bpt;
 761
 762   clib_spinlock_lock (&bp->lock);
 763
 764   /* *INDENT-OFF* */
 765   vec_foreach (bpt, bp->threads)
 766     cached += bpt->n_cached;
 767   /* *INDENT-ON* */
 768
 769   clib_spinlock_unlock (&bp->lock);
 770
 771   return cached;
 772 }
 773
 774 static vlib_buffer_pool_t *
 775 buffer_get_by_index (vlib_buffer_main_t * bm, u32 index)
 776 {
 777   vlib_buffer_pool_t *bp;
 778   if (!bm->buffer_pools || vec_len (bm->buffer_pools) < index)
 779     return 0;
 780   bp = vec_elt_at_index (bm->buffer_pools, index);
 781
 782   return bp;
 783 }
 784
 785 static void
 786 buffer_gauges_collect_used_fn (vlib_stats_collector_data_t *d)
 787 {
 788   vlib_main_t *vm = vlib_get_main ();
 789   vlib_buffer_pool_t *bp =
 790     buffer_get_by_index (vm->buffer_main, d->private_data);
 791   if (!bp)
 792     return;
 793
 794   d->entry->value = bp->n_buffers - bp->n_avail - buffer_get_cached (bp);
 795 }
 796
 797 static void
 798 buffer_gauges_collect_available_fn (vlib_stats_collector_data_t *d)
 799 {
 800   vlib_main_t *vm = vlib_get_main ();
 801   vlib_buffer_pool_t *bp =
 802     buffer_get_by_index (vm->buffer_main, d->private_data);
 803   if (!bp)
 804     return;
 805
 806   d->entry->value = bp->n_avail;
 807 }
 808
 809 static void
 810 buffer_gauges_collect_cached_fn (vlib_stats_collector_data_t *d)
 811 {
 812   vlib_main_t *vm = vlib_get_main ();
 813   vlib_buffer_pool_t *bp =
 814     buffer_get_by_index (vm->buffer_main, d->private_data);
 815   if (!bp)
 816     return;
 817
 818   d->entry->value = buffer_get_cached (bp);
 819 }
 820
 821 clib_error_t *
 822 vlib_buffer_main_init (struct vlib_main_t * vm)
 823 {
 824   vlib_buffer_main_t *bm;
 825   clib_error_t *err;
 826   clib_bitmap_t *bmp = 0, *bmp_has_memory = 0;
 827   u32 numa_node;
 828   vlib_buffer_pool_t *bp;
 829   u8 *name = 0, first_valid_buffer_pool_index = ~0;
 830
 831   vlib_buffer_main_alloc (vm);
 832
 833   bm = vm->buffer_main;
 834   bm->log_default = vlib_log_register_class ("buffer", 0);
 835   bm->ext_hdr_size = __vlib_buffer_external_hdr_size;
 836
 837   clib_spinlock_init (&bm->buffer_known_hash_lockp);
 838
 839   if ((err = clib_sysfs_read ("/sys/devices/system/node/online", "%U",
 840                               unformat_bitmap_list, &bmp)))
 841     clib_error_free (err);
 842
 843   if ((err = clib_sysfs_read ("/sys/devices/system/node/has_memory", "%U",
 844                               unformat_bitmap_list, &bmp_has_memory)))
 845     clib_error_free (err);
 846
 847   if (bmp && bmp_has_memory)
 848     bmp = clib_bitmap_and (bmp, bmp_has_memory);
 849
 850   /* no info from sysfs, assuming that only numa 0 exists */
 851   if (bmp == 0)
 852     bmp = clib_bitmap_set (bmp, 0, 1);
 853
 854   if (clib_bitmap_last_set (bmp) >= VLIB_BUFFER_MAX_NUMA_NODES)
 855     clib_panic ("system have more than %u NUMA nodes",
 856                 VLIB_BUFFER_MAX_NUMA_NODES);
 857
 858   /* *INDENT-OFF* */
 859   clib_bitmap_foreach (numa_node, bmp)
 860     {
 861       u8 *index = bm->default_buffer_pool_index_for_numa + numa_node;
 862       index[0] = ~0;
 863       if ((err = vlib_buffer_main_init_numa_node (vm, numa_node, index)))
 864         {
 865           clib_error_report (err);
 866           clib_error_free (err);
 867           continue;
 868         }
 869
 870       if (first_valid_buffer_pool_index == 0xff)
 871         first_valid_buffer_pool_index = index[0];
 872     }
 873   /* *INDENT-ON* */
 874
 875   if (first_valid_buffer_pool_index == (u8) ~ 0)
 876     {
 877       err = clib_error_return (0, "failed to allocate buffer pool(s)");
 878       goto done;
 879     }
 880
 881   /* *INDENT-OFF* */
 882   clib_bitmap_foreach (numa_node, bmp)
 883     {
 884       if (bm->default_buffer_pool_index_for_numa[numa_node]  == (u8) ~0)
 885         bm->default_buffer_pool_index_for_numa[numa_node] =
 886           first_valid_buffer_pool_index;
 887     }
 888   /* *INDENT-ON* */
 889
 890   vec_foreach (bp, bm->buffer_pools)
 891   {
 892     vlib_stats_collector_reg_t reg = { .private_data = bp - bm->buffer_pools };
 893     if (bp->n_buffers == 0)
 894       continue;
 895
 896     reg.entry_index =
 897       vlib_stats_add_gauge ("/buffer-pools/%v/cached", bp->name);
 898     reg.collect_fn = buffer_gauges_collect_cached_fn;
 899     vlib_stats_register_collector_fn (&reg);
 900
 901     reg.entry_index = vlib_stats_add_gauge ("/buffer-pools/%v/used", bp->name);
 902     reg.collect_fn = buffer_gauges_collect_used_fn;
 903     vlib_stats_register_collector_fn (&reg);
 904
 905     reg.entry_index =
 906       vlib_stats_add_gauge ("/buffer-pools/%v/available", bp->name);
 907     reg.collect_fn = buffer_gauges_collect_available_fn;
 908     vlib_stats_register_collector_fn (&reg);
 909   }
 910
 911 done:
 912   vec_free (bmp);
 913   vec_free (bmp_has_memory);
 914   vec_free (name);
 915   return err;
 916 }
 917
 918 static clib_error_t *
 919 vlib_buffers_configure (vlib_main_t * vm, unformat_input_t * input)
 920 {
 921   vlib_buffer_main_t *bm;
 922
 923   vlib_buffer_main_alloc (vm);
 924
 925   bm = vm->buffer_main;
 926   bm->log2_page_size = CLIB_MEM_PAGE_SZ_UNKNOWN;
 927
 928   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 929     {
 930       if (unformat (input, "buffers-per-numa %u", &bm->buffers_per_numa))
 931         ;
 932       else if (unformat (input, "page-size %U", unformat_log2_page_size,
 933                          &bm->log2_page_size))
 934         ;
 935       else if (unformat (input, "default data-size %u",
 936                          &bm->default_data_size))
 937         ;
 938       else
 939         return unformat_parse_error (input);
 940     }
 941
 942   unformat_free (input);
 943   return 0;
 944 }
 945
 946 VLIB_EARLY_CONFIG_FUNCTION (vlib_buffers_configure, "buffers");
 947
 948 #if VLIB_BUFFER_ALLOC_FAULT_INJECTOR > 0
 949 u32
 950 vlib_buffer_alloc_may_fail (vlib_main_t * vm, u32 n_buffers)
 951 {
 952   f64 r;
 953
 954   r = random_f64 (&vm->buffer_alloc_success_seed);
 955
 956   /* Fail this request? */
 957   if (r > vm->buffer_alloc_success_rate)
 958     n_buffers--;
 959   /* 5% chance of returning nothing at all */
 960   if (r > vm->buffer_alloc_success_rate && r > 0.95)
 961     n_buffers = 0;
 962
 963   return n_buffers;
 964 }
 965 #endif
 966
 967 __clib_export int
 968 vlib_buffer_set_alloc_free_callback (
 969   vlib_main_t *vm, vlib_buffer_alloc_free_callback_t *alloc_callback_fn,
 970   vlib_buffer_alloc_free_callback_t *free_callback_fn)
 971 {
 972   vlib_buffer_main_t *bm = vm->buffer_main;
 973   if ((alloc_callback_fn && bm->alloc_callback_fn) ||
 974       (free_callback_fn && bm->free_callback_fn))
 975     return 1;
 976   bm->alloc_callback_fn = alloc_callback_fn;
 977   bm->free_callback_fn = free_callback_fn;
 978   return 0;
 979 }
 980
 981 /** @endcond */
 982 /*
 983  * fd.io coding-style-patch-verification: ON
 984  *
 985  * Local Variables:
 986  * eval: (c-set-style "gnu")
 987  * End:
 988  */