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