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