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