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 <vlib/vlib.h>
  47 #include <vlib/unix/unix.h>
  48
  49 vlib_buffer_callbacks_t *vlib_buffer_callbacks = 0;
  50
  51 /* when running unpriviledged we are limited by RLIMIT_MEMLOCK which is
  52    typically set to 16MB so setting default size for buffer memory to 14MB
  53    */
  54 static u32 vlib_buffer_physmem_sz = 14 << 20;
  55
  56 /* logging */
  57 static vlib_log_class_t buffer_log_default;
  58
  59 uword
  60 vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
  61                                        vlib_buffer_t * b_first)
  62 {
  63   vlib_buffer_t *b = b_first;
  64   uword l_first = b_first->current_length;
  65   uword l = 0;
  66   while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
  67     {
  68       b = vlib_get_buffer (vm, b->next_buffer);
  69       l += b->current_length;
  70     }
  71   b_first->total_length_not_including_first_buffer = l;
  72   b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
  73   return l + l_first;
  74 }
  75
  76 u8 *
  77 format_vlib_buffer (u8 * s, va_list * args)
  78 {
  79   vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
  80   u32 indent = format_get_indent (s);
  81   u8 *a = 0;
  82
  83 #define _(bit, name, v) \
  84   if (v && (b->flags & VLIB_BUFFER_##name)) \
  85     a = format (a, "%s ", v);
  86   foreach_vlib_buffer_flag
  87 #undef _
  88     s = format (s, "current data %d, length %d, buffer-pool %d, "
  89                 "clone-count %u", b->current_data, b->current_length,
  90                 b->buffer_pool_index, b->n_add_refs);
  91
  92   if (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID)
  93     s = format (s, ", totlen-nifb %d",
  94                 b->total_length_not_including_first_buffer);
  95
  96   if (b->flags & VLIB_BUFFER_IS_TRACED)
  97     s = format (s, ", trace 0x%x", b->trace_index);
  98
  99   if (a)
 100     s = format (s, "\n%U%v", format_white_space, indent, a);
 101   vec_free (a);
 102
 103   while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
 104     {
 105       vlib_main_t *vm = vlib_get_main ();
 106       u32 next_buffer = b->next_buffer;
 107       b = vlib_get_buffer (vm, next_buffer);
 108
 109       s =
 110         format (s, "\n%Unext-buffer 0x%x, segment length %d, clone-count %u",
 111                 format_white_space, indent, next_buffer, b->current_length,
 112                 b->n_add_refs);
 113     }
 114
 115   return s;
 116 }
 117
 118 u8 *
 119 format_vlib_buffer_and_data (u8 * s, va_list * args)
 120 {
 121   vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
 122
 123   s = format (s, "%U, %U",
 124               format_vlib_buffer, b,
 125               format_hex_bytes, vlib_buffer_get_current (b), 64);
 126
 127   return s;
 128 }
 129
 130 static u8 *
 131 format_vlib_buffer_known_state (u8 * s, va_list * args)
 132 {
 133   vlib_buffer_known_state_t state = va_arg (*args, vlib_buffer_known_state_t);
 134   char *t;
 135
 136   switch (state)
 137     {
 138     case VLIB_BUFFER_UNKNOWN:
 139       t = "unknown";
 140       break;
 141
 142     case VLIB_BUFFER_KNOWN_ALLOCATED:
 143       t = "known-allocated";
 144       break;
 145
 146     case VLIB_BUFFER_KNOWN_FREE:
 147       t = "known-free";
 148       break;
 149
 150     default:
 151       t = "invalid";
 152       break;
 153     }
 154
 155   return format (s, "%s", t);
 156 }
 157
 158 u8 *
 159 format_vlib_buffer_contents (u8 * s, va_list * va)
 160 {
 161   vlib_main_t *vm = va_arg (*va, vlib_main_t *);
 162   vlib_buffer_t *b = va_arg (*va, vlib_buffer_t *);
 163
 164   while (1)
 165     {
 166       vec_add (s, vlib_buffer_get_current (b), b->current_length);
 167       if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
 168         break;
 169       b = vlib_get_buffer (vm, b->next_buffer);
 170     }
 171
 172   return s;
 173 }
 174
 175 static u8 *
 176 vlib_validate_buffer_helper (vlib_main_t * vm,
 177                              u32 bi,
 178                              uword follow_buffer_next, uword ** unique_hash)
 179 {
 180   vlib_buffer_t *b = vlib_get_buffer (vm, bi);
 181   vlib_buffer_free_list_t *fl;
 182
 183   fl = pool_elt_at_index (vm->buffer_free_list_pool,
 184                           VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
 185
 186   if ((signed) b->current_data < (signed) -VLIB_BUFFER_PRE_DATA_SIZE)
 187     return format (0, "current data %d before pre-data", b->current_data);
 188
 189   if (b->current_data + b->current_length > fl->n_data_bytes)
 190     return format (0, "%d-%d beyond end of buffer %d",
 191                    b->current_data, b->current_length, fl->n_data_bytes);
 192
 193   if (follow_buffer_next && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
 194     {
 195       vlib_buffer_known_state_t k;
 196       u8 *msg, *result;
 197
 198       k = vlib_buffer_is_known (vm, b->next_buffer);
 199       if (k != VLIB_BUFFER_KNOWN_ALLOCATED)
 200         return format (0, "next 0x%x: %U",
 201                        b->next_buffer, format_vlib_buffer_known_state, k);
 202
 203       if (unique_hash)
 204         {
 205           if (hash_get (*unique_hash, b->next_buffer))
 206             return format (0, "duplicate buffer 0x%x", b->next_buffer);
 207
 208           hash_set1 (*unique_hash, b->next_buffer);
 209         }
 210
 211       msg = vlib_validate_buffer (vm, b->next_buffer, follow_buffer_next);
 212       if (msg)
 213         {
 214           result = format (0, "next 0x%x: %v", b->next_buffer, msg);
 215           vec_free (msg);
 216           return result;
 217         }
 218     }
 219
 220   return 0;
 221 }
 222
 223 u8 *
 224 vlib_validate_buffer (vlib_main_t * vm, u32 bi, uword follow_buffer_next)
 225 {
 226   return vlib_validate_buffer_helper (vm, bi, follow_buffer_next,
 227                                       /* unique_hash */ 0);
 228 }
 229
 230 u8 *
 231 vlib_validate_buffers (vlib_main_t * vm,
 232                        u32 * buffers,
 233                        uword next_buffer_stride,
 234                        uword n_buffers,
 235                        vlib_buffer_known_state_t known_state,
 236                        uword follow_buffer_next)
 237 {
 238   uword i, *hash;
 239   u32 bi, *b = buffers;
 240   vlib_buffer_known_state_t k;
 241   u8 *msg = 0, *result = 0;
 242
 243   hash = hash_create (0, 0);
 244   for (i = 0; i < n_buffers; i++)
 245     {
 246       bi = b[0];
 247       b += next_buffer_stride;
 248
 249       /* Buffer is not unique. */
 250       if (hash_get (hash, bi))
 251         {
 252           msg = format (0, "not unique");
 253           goto done;
 254         }
 255
 256       k = vlib_buffer_is_known (vm, bi);
 257       if (k != known_state)
 258         {
 259           msg = format (0, "is %U; expected %U",
 260                         format_vlib_buffer_known_state, k,
 261                         format_vlib_buffer_known_state, known_state);
 262           goto done;
 263         }
 264
 265       msg = vlib_validate_buffer_helper (vm, bi, follow_buffer_next, &hash);
 266       if (msg)
 267         goto done;
 268
 269       hash_set1 (hash, bi);
 270     }
 271
 272 done:
 273   if (msg)
 274     {
 275       result = format (0, "0x%x: %v", bi, msg);
 276       vec_free (msg);
 277     }
 278   hash_free (hash);
 279   return result;
 280 }
 281
 282 /*
 283  * Hand-craft a static vector w/ length 1, so vec_len(vlib_mains) =1
 284  * and vlib_mains[0] = &vlib_global_main from the beginning of time.
 285  *
 286  * The only place which should ever expand vlib_mains is start_workers()
 287  * in threads.c. It knows about the bootstrap vector.
 288  */
 289 /* *INDENT-OFF* */
 290 static struct
 291 {
 292   vec_header_t h;
 293   vlib_main_t *vm;
 294 } __attribute__ ((packed)) __bootstrap_vlib_main_vector
 295   __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES))) =
 296 {
 297   .h.len = 1,
 298   .vm = &vlib_global_main,
 299 };
 300 /* *INDENT-ON* */
 301
 302 vlib_main_t **vlib_mains = &__bootstrap_vlib_main_vector.vm;
 303
 304
 305 /* When dubugging validate that given buffers are either known allocated
 306    or known free. */
 307 void
 308 vlib_buffer_validate_alloc_free (vlib_main_t * vm,
 309                                  u32 * buffers,
 310                                  uword n_buffers,
 311                                  vlib_buffer_known_state_t expected_state)
 312 {
 313   u32 *b;
 314   uword i, bi, is_free;
 315
 316   if (CLIB_DEBUG == 0)
 317     return;
 318
 319   if (vlib_buffer_callbacks)
 320     return;
 321
 322   is_free = expected_state == VLIB_BUFFER_KNOWN_ALLOCATED;
 323   b = buffers;
 324   for (i = 0; i < n_buffers; i++)
 325     {
 326       vlib_buffer_known_state_t known;
 327
 328       bi = b[0];
 329       b += 1;
 330       known = vlib_buffer_is_known (vm, bi);
 331       if (known != expected_state)
 332         {
 333           ASSERT (0);
 334           vlib_panic_with_msg
 335             (vm, "%s %U buffer 0x%x",
 336              is_free ? "freeing" : "allocating",
 337              format_vlib_buffer_known_state, known, bi);
 338         }
 339
 340       vlib_buffer_set_known_state (vm, bi, is_free ? VLIB_BUFFER_KNOWN_FREE :
 341                                    VLIB_BUFFER_KNOWN_ALLOCATED);
 342     }
 343 }
 344
 345 /* Add buffer free list. */
 346 static vlib_buffer_free_list_index_t
 347 vlib_buffer_create_free_list_helper (vlib_main_t * vm,
 348                                      u32 n_data_bytes,
 349                                      u32 is_public, u32 is_default, u8 * name)
 350 {
 351   vlib_buffer_main_t *bm = vm->buffer_main;
 352   vlib_buffer_free_list_t *f;
 353   int i;
 354
 355   ASSERT (vlib_get_thread_index () == 0);
 356
 357   if (!is_default && pool_elts (vm->buffer_free_list_pool) == 0)
 358     {
 359       vlib_buffer_free_list_index_t default_free_free_list_index;
 360
 361       /* *INDENT-OFF* */
 362       default_free_free_list_index =
 363         vlib_buffer_create_free_list_helper
 364         (vm,
 365          /* default buffer size */ VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
 366          /* is_public */ 1,
 367          /* is_default */ 1,
 368          (u8 *) "default");
 369       /* *INDENT-ON* */
 370       ASSERT (default_free_free_list_index ==
 371               VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
 372
 373       if (n_data_bytes == VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES && is_public)
 374         return default_free_free_list_index;
 375     }
 376
 377   pool_get_aligned (vm->buffer_free_list_pool, f, CLIB_CACHE_LINE_BYTES);
 378
 379   clib_memset (f, 0, sizeof (f[0]));
 380   f->index = f - vm->buffer_free_list_pool;
 381   vec_validate (f->buffers, 0);
 382   vec_reset_length (f->buffers);
 383   f->n_data_bytes = vlib_buffer_round_size (n_data_bytes);
 384   f->min_n_buffers_each_alloc = VLIB_FRAME_SIZE;
 385   f->buffer_pool_index = 0;
 386   f->name = clib_mem_is_vec (name) ? name : format (0, "%s", name);
 387
 388   /* Setup free buffer template. */
 389   f->buffer_init_template.n_add_refs = 0;
 390
 391   if (is_public)
 392     {
 393       uword *p = hash_get (bm->free_list_by_size, f->n_data_bytes);
 394       if (!p)
 395         hash_set (bm->free_list_by_size, f->n_data_bytes, f->index);
 396     }
 397
 398   for (i = 1; i < vec_len (vlib_mains); i++)
 399     {
 400       vlib_main_t *wvm = vlib_mains[i];
 401       vlib_buffer_free_list_t *wf;
 402       pool_get_aligned (wvm->buffer_free_list_pool,
 403                         wf, CLIB_CACHE_LINE_BYTES);
 404       ASSERT (f - vm->buffer_free_list_pool ==
 405               wf - wvm->buffer_free_list_pool);
 406       wf[0] = f[0];
 407       wf->buffers = 0;
 408       vec_validate (wf->buffers, 0);
 409       vec_reset_length (wf->buffers);
 410       wf->n_alloc = 0;
 411     }
 412
 413   return f->index;
 414 }
 415
 416 vlib_buffer_free_list_index_t
 417 vlib_buffer_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
 418                               char *fmt, ...)
 419 {
 420   va_list va;
 421   u8 *name;
 422
 423   va_start (va, fmt);
 424   name = va_format (0, fmt, &va);
 425   va_end (va);
 426
 427   return vlib_buffer_create_free_list_helper (vm, n_data_bytes,
 428                                               /* is_public */ 0,
 429                                               /* is_default */ 0,
 430                                               name);
 431 }
 432
 433 static void
 434 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
 435 {
 436   vlib_buffer_pool_t *bp = vlib_buffer_pool_get (vm, f->buffer_pool_index);
 437
 438   vec_add_aligned (bp->buffers, f->buffers, vec_len (f->buffers),
 439                    CLIB_CACHE_LINE_BYTES);
 440   vec_free (f->name);
 441   vec_free (f->buffers);
 442
 443   /* Poison it. */
 444   clib_memset (f, 0xab, sizeof (f[0]));
 445 }
 446
 447 /* Add buffer free list. */
 448 void
 449 vlib_buffer_delete_free_list_internal (vlib_main_t * vm,
 450                                        vlib_buffer_free_list_index_t index)
 451 {
 452   vlib_buffer_free_list_t *f;
 453   int i;
 454
 455   ASSERT (vlib_get_thread_index () == 0);
 456
 457   f = vlib_buffer_get_free_list (vm, index);
 458
 459   ASSERT (vec_len (f->buffers) == f->n_alloc);
 460
 461   del_free_list (vm, f);
 462
 463   pool_put (vm->buffer_free_list_pool, f);
 464
 465   for (i = 1; i < vec_len (vlib_mains); i++)
 466     {
 467       vlib_main_t *wvm = vlib_mains[i];
 468       f = vlib_buffer_get_free_list (vlib_mains[i], index);
 469       del_free_list (wvm, f);
 470       pool_put (wvm->buffer_free_list_pool, f);
 471     }
 472 }
 473
 474 static_always_inline void *
 475 vlib_buffer_pool_get_buffer (vlib_main_t * vm, vlib_buffer_pool_t * bp)
 476 {
 477   return vlib_physmem_alloc_from_map (vm, bp->physmem_map_index,
 478                                       bp->buffer_size, CLIB_CACHE_LINE_BYTES);
 479 }
 480
 481 /* Make sure free list has at least given number of free buffers. */
 482 static uword
 483 vlib_buffer_fill_free_list_internal (vlib_main_t * vm,
 484                                      vlib_buffer_free_list_t * fl,
 485                                      uword min_free_buffers)
 486 {
 487   vlib_buffer_t *b;
 488   vlib_buffer_pool_t *bp = vlib_buffer_pool_get (vm, fl->buffer_pool_index);
 489   int n;
 490   u32 *bi;
 491   u32 n_alloc = 0;
 492
 493   /* Already have enough free buffers on free list? */
 494   n = min_free_buffers - vec_len (fl->buffers);
 495   if (n <= 0)
 496     return min_free_buffers;
 497
 498   if (vec_len (bp->buffers) > 0)
 499     {
 500       int n_copy, n_left;
 501       clib_spinlock_lock (&bp->lock);
 502       n_copy = clib_min (vec_len (bp->buffers), n);
 503       n_left = vec_len (bp->buffers) - n_copy;
 504       vec_add_aligned (fl->buffers, bp->buffers + n_left, n_copy,
 505                        CLIB_CACHE_LINE_BYTES);
 506       _vec_len (bp->buffers) = n_left;
 507       clib_spinlock_unlock (&bp->lock);
 508       n = min_free_buffers - vec_len (fl->buffers);
 509       if (n <= 0)
 510         return min_free_buffers;
 511     }
 512
 513   /* Always allocate round number of buffers. */
 514   n = round_pow2 (n, CLIB_CACHE_LINE_BYTES / sizeof (u32));
 515
 516   /* Always allocate new buffers in reasonably large sized chunks. */
 517   n = clib_max (n, fl->min_n_buffers_each_alloc);
 518
 519   clib_spinlock_lock (&bp->lock);
 520   while (n_alloc < n)
 521     {
 522       if ((b = vlib_buffer_pool_get_buffer (vm, bp)) == 0)
 523         goto done;
 524
 525       n_alloc += 1;
 526
 527       vec_add2_aligned (fl->buffers, bi, 1, CLIB_CACHE_LINE_BYTES);
 528       bi[0] = vlib_get_buffer_index (vm, b);
 529
 530       if (CLIB_DEBUG > 0)
 531         vlib_buffer_set_known_state (vm, bi[0], VLIB_BUFFER_KNOWN_FREE);
 532
 533       clib_memset (b, 0, sizeof (vlib_buffer_t));
 534       vlib_buffer_init_for_free_list (b, fl);
 535
 536       if (fl->buffer_init_function)
 537         fl->buffer_init_function (vm, fl, bi, 1);
 538     }
 539
 540 done:
 541   clib_spinlock_unlock (&bp->lock);
 542   fl->n_alloc += n_alloc;
 543   return n_alloc;
 544 }
 545
 546 void *
 547 vlib_set_buffer_free_callback (vlib_main_t * vm, void *fp)
 548 {
 549   vlib_buffer_main_t *bm = vm->buffer_main;
 550   void *rv = bm->buffer_free_callback;
 551
 552   bm->buffer_free_callback = fp;
 553   return rv;
 554 }
 555
 556 static_always_inline void
 557 recycle_or_free (vlib_main_t * vm, vlib_buffer_main_t * bm, u32 bi,
 558                  vlib_buffer_t * b, u32 follow_buffer_next)
 559 {
 560   vlib_buffer_free_list_t *fl;
 561   u32 flags, next;
 562
 563   fl = pool_elt_at_index (vm->buffer_free_list_pool,
 564                           VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
 565
 566   do
 567     {
 568       vlib_buffer_t *nb = vlib_get_buffer (vm, bi);
 569       flags = nb->flags;
 570       next = nb->next_buffer;
 571       if (nb->n_add_refs)
 572         nb->n_add_refs--;
 573       else
 574         {
 575           vlib_buffer_validate_alloc_free (vm, &bi, 1,
 576                                            VLIB_BUFFER_KNOWN_ALLOCATED);
 577           vlib_buffer_add_to_free_list (vm, fl, bi, 1);
 578         }
 579       bi = next;
 580     }
 581   while (follow_buffer_next && (flags & VLIB_BUFFER_NEXT_PRESENT));
 582 }
 583
 584 static_always_inline void
 585 vlib_buffer_free_inline (vlib_main_t * vm,
 586                          u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
 587 {
 588   vlib_buffer_main_t *bm = vm->buffer_main;
 589   vlib_buffer_t *p, *b0, *b1, *b2, *b3;
 590   int i = 0;
 591   u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
 592              u32 follow_buffer_next);
 593
 594   cb = bm->buffer_free_callback;
 595
 596   if (PREDICT_FALSE (cb != 0))
 597     n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
 598
 599   if (!n_buffers)
 600     return;
 601
 602   while (i + 11 < n_buffers)
 603     {
 604       p = vlib_get_buffer (vm, buffers[i + 8]);
 605       vlib_prefetch_buffer_header (p, LOAD);
 606       p = vlib_get_buffer (vm, buffers[i + 9]);
 607       vlib_prefetch_buffer_header (p, LOAD);
 608       p = vlib_get_buffer (vm, buffers[i + 10]);
 609       vlib_prefetch_buffer_header (p, LOAD);
 610       p = vlib_get_buffer (vm, buffers[i + 11]);
 611       vlib_prefetch_buffer_header (p, LOAD);
 612
 613       b0 = vlib_get_buffer (vm, buffers[i]);
 614       b1 = vlib_get_buffer (vm, buffers[i + 1]);
 615       b2 = vlib_get_buffer (vm, buffers[i + 2]);
 616       b3 = vlib_get_buffer (vm, buffers[i + 3]);
 617
 618       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
 619       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
 620       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b2);
 621       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b3);
 622
 623       recycle_or_free (vm, bm, buffers[i], b0, follow_buffer_next);
 624       recycle_or_free (vm, bm, buffers[i + 1], b1, follow_buffer_next);
 625       recycle_or_free (vm, bm, buffers[i + 2], b2, follow_buffer_next);
 626       recycle_or_free (vm, bm, buffers[i + 3], b3, follow_buffer_next);
 627
 628       i += 4;
 629     }
 630
 631   while (i < n_buffers)
 632     {
 633       b0 = vlib_get_buffer (vm, buffers[i]);
 634       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
 635       recycle_or_free (vm, bm, buffers[i], b0, follow_buffer_next);
 636       i++;
 637     }
 638 }
 639
 640 static void
 641 vlib_buffer_free_internal (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
 642 {
 643   vlib_buffer_free_inline (vm, buffers, n_buffers,      /* follow_buffer_next */
 644                            1);
 645 }
 646
 647 static void
 648 vlib_buffer_free_no_next_internal (vlib_main_t * vm, u32 * buffers,
 649                                    u32 n_buffers)
 650 {
 651   vlib_buffer_free_inline (vm, buffers, n_buffers,      /* follow_buffer_next */
 652                            0);
 653 }
 654
 655 void
 656 vlib_packet_template_init (vlib_main_t * vm,
 657                            vlib_packet_template_t * t,
 658                            void *packet_data,
 659                            uword n_packet_data_bytes,
 660                            uword min_n_buffers_each_alloc, char *fmt, ...)
 661 {
 662   va_list va;
 663
 664   va_start (va, fmt);
 665   t->name = va_format (0, fmt, &va);
 666   va_end (va);
 667
 668   vlib_worker_thread_barrier_sync (vm);
 669
 670   clib_memset (t, 0, sizeof (t[0]));
 671
 672   vec_add (t->packet_data, packet_data, n_packet_data_bytes);
 673   t->min_n_buffers_each_alloc = min_n_buffers_each_alloc;
 674
 675   vlib_worker_thread_barrier_release (vm);
 676 }
 677
 678 void *
 679 vlib_packet_template_get_packet (vlib_main_t * vm,
 680                                  vlib_packet_template_t * t, u32 * bi_result)
 681 {
 682   u32 bi;
 683   vlib_buffer_t *b;
 684
 685   if (vlib_buffer_alloc (vm, &bi, 1) != 1)
 686     return 0;
 687
 688   *bi_result = bi;
 689
 690   b = vlib_get_buffer (vm, bi);
 691   clib_memcpy_fast (vlib_buffer_get_current (b),
 692                     t->packet_data, vec_len (t->packet_data));
 693   b->current_length = vec_len (t->packet_data);
 694
 695   return b->data;
 696 }
 697
 698 /* Append given data to end of buffer, possibly allocating new buffers. */
 699 int
 700 vlib_buffer_add_data (vlib_main_t * vm, u32 * buffer_index, void *data,
 701                       u32 n_data_bytes)
 702 {
 703   u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
 704   vlib_buffer_t *b;
 705   void *d;
 706
 707   bi = *buffer_index;
 708   if (bi == ~0 && 1 != vlib_buffer_alloc (vm, &bi, 1))
 709     goto out_of_buffers;
 710
 711   d = data;
 712   n_left = n_data_bytes;
 713   n_buffer_bytes = VLIB_BUFFER_DATA_SIZE;
 714
 715   b = vlib_get_buffer (vm, bi);
 716   b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
 717
 718   /* Get to the end of the chain before we try to append data... */
 719   while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
 720     b = vlib_get_buffer (vm, b->next_buffer);
 721
 722   while (1)
 723     {
 724       u32 n;
 725
 726       ASSERT (n_buffer_bytes >= b->current_length);
 727       n_left_this_buffer =
 728         n_buffer_bytes - (b->current_data + b->current_length);
 729       n = clib_min (n_left_this_buffer, n_left);
 730       clib_memcpy_fast (vlib_buffer_get_current (b) + b->current_length, d,
 731                         n);
 732       b->current_length += n;
 733       n_left -= n;
 734       if (n_left == 0)
 735         break;
 736
 737       d += n;
 738       if (1 != vlib_buffer_alloc (vm, &b->next_buffer, 1))
 739         goto out_of_buffers;
 740
 741       b->flags |= VLIB_BUFFER_NEXT_PRESENT;
 742
 743       b = vlib_get_buffer (vm, b->next_buffer);
 744     }
 745
 746   *buffer_index = bi;
 747   return 0;
 748
 749 out_of_buffers:
 750   clib_warning ("out of buffers");
 751   return 1;
 752 }
 753
 754 u16
 755 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
 756                                           vlib_buffer_free_list_index_t
 757                                           free_list_index,
 758                                           vlib_buffer_t * first,
 759                                           vlib_buffer_t ** last, void *data,
 760                                           u16 data_len)
 761 {
 762   vlib_buffer_t *l = *last;
 763   u32 n_buffer_bytes =
 764     vlib_buffer_free_list_buffer_size (vm, free_list_index);
 765   u16 copied = 0;
 766   ASSERT (n_buffer_bytes >= l->current_length + l->current_data);
 767   while (data_len)
 768     {
 769       u16 max = n_buffer_bytes - l->current_length - l->current_data;
 770       if (max == 0)
 771         {
 772           if (1 !=
 773               vlib_buffer_alloc_from_free_list (vm, &l->next_buffer, 1,
 774                                                 free_list_index))
 775             return copied;
 776           *last = l = vlib_buffer_chain_buffer (vm, l, l->next_buffer);
 777           max = n_buffer_bytes - l->current_length - l->current_data;
 778         }
 779
 780       u16 len = (data_len > max) ? max : data_len;
 781       clib_memcpy_fast (vlib_buffer_get_current (l) + l->current_length,
 782                         data + copied, len);
 783       vlib_buffer_chain_increase_length (first, l, len);
 784       data_len -= len;
 785       copied += len;
 786     }
 787   return copied;
 788 }
 789
 790 u8
 791 vlib_buffer_register_physmem_map (vlib_main_t * vm, u32 physmem_map_index)
 792 {
 793   vlib_buffer_main_t *bm = vm->buffer_main;
 794   vlib_buffer_pool_t *p;
 795   vlib_physmem_map_t *m = vlib_physmem_get_map (vm, physmem_map_index);
 796   uword start = pointer_to_uword (m->base);
 797   uword size = (uword) m->n_pages << m->log2_page_size;
 798
 799   if (bm->buffer_mem_size == 0)
 800     {
 801       bm->buffer_mem_start = start;
 802       bm->buffer_mem_size = size;
 803     }
 804   else if (start < bm->buffer_mem_start)
 805     {
 806       bm->buffer_mem_size += bm->buffer_mem_start - start;
 807       bm->buffer_mem_start = start;
 808       if (size > bm->buffer_mem_size)
 809         bm->buffer_mem_size = size;
 810     }
 811   else if (start > bm->buffer_mem_start)
 812     {
 813       uword new_size = start - bm->buffer_mem_start + size;
 814       if (new_size > bm->buffer_mem_size)
 815         bm->buffer_mem_size = new_size;
 816     }
 817
 818   if ((u64) bm->buffer_mem_size >
 819       ((u64) 1 << (32 + CLIB_LOG2_CACHE_LINE_BYTES)))
 820     {
 821       clib_panic ("buffer memory size out of range!");
 822     }
 823
 824   vec_add2 (bm->buffer_pools, p, 1);
 825   p->start = start;
 826   p->size = size;
 827   p->physmem_map_index = physmem_map_index;
 828
 829   ASSERT (p - bm->buffer_pools < 256);
 830   return p - bm->buffer_pools;
 831 }
 832
 833 static u8 *
 834 format_vlib_buffer_free_list (u8 * s, va_list * va)
 835 {
 836   vlib_buffer_free_list_t *f = va_arg (*va, vlib_buffer_free_list_t *);
 837   u32 threadnum = va_arg (*va, u32);
 838   uword bytes_alloc, bytes_free, n_free, size;
 839
 840   if (!f)
 841     return format (s, "%=7s%=30s%=12s%=12s%=12s%=12s%=12s%=12s",
 842                    "Thread", "Name", "Index", "Size", "Alloc", "Free",
 843                    "#Alloc", "#Free");
 844
 845   size = sizeof (vlib_buffer_t) + f->n_data_bytes;
 846   n_free = vec_len (f->buffers);
 847   bytes_alloc = size * f->n_alloc;
 848   bytes_free = size * n_free;
 849
 850   s = format (s, "%7d%30v%12d%12d%=12U%=12U%=12d%=12d", threadnum,
 851               f->name, f->index, f->n_data_bytes,
 852               format_memory_size, bytes_alloc,
 853               format_memory_size, bytes_free, f->n_alloc, n_free);
 854
 855   return s;
 856 }
 857
 858 static clib_error_t *
 859 show_buffers (vlib_main_t * vm,
 860               unformat_input_t * input, vlib_cli_command_t * cmd)
 861 {
 862   vlib_buffer_free_list_t *f;
 863   vlib_main_t *curr_vm;
 864   u32 vm_index = 0;
 865
 866   vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, 0, 0);
 867
 868   do
 869     {
 870       curr_vm = vlib_mains[vm_index];
 871
 872     /* *INDENT-OFF* */
 873     pool_foreach (f, curr_vm->buffer_free_list_pool, ({
 874       vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, f, vm_index);
 875     }));
 876     /* *INDENT-ON* */
 877
 878       vm_index++;
 879     }
 880   while (vm_index < vec_len (vlib_mains));
 881
 882   return 0;
 883 }
 884
 885 /* *INDENT-OFF* */
 886 VLIB_CLI_COMMAND (show_buffers_command, static) = {
 887   .path = "show buffers",
 888   .short_help = "Show packet buffer allocation",
 889   .function = show_buffers,
 890 };
 891 /* *INDENT-ON* */
 892
 893 clib_error_t *
 894 vlib_buffer_main_init (struct vlib_main_t * vm)
 895 {
 896   vlib_buffer_main_t *bm;
 897   clib_error_t *error;
 898   u32 physmem_map_index;
 899   u8 pool_index;
 900   int log2_page_size = 0;
 901
 902   buffer_log_default = vlib_log_register_class ("buffer", 0);
 903
 904   bm = vm->buffer_main = clib_mem_alloc (sizeof (bm[0]));
 905   clib_memset (bm, 0, sizeof (bm[0]));
 906
 907   if (vlib_buffer_callbacks)
 908     {
 909       /* external plugin has registered own buffer callbacks
 910          so we just copy them  and quit */
 911       clib_memcpy_fast (&bm->cb, vlib_buffer_callbacks,
 912                         sizeof (vlib_buffer_callbacks_t));
 913       bm->callbacks_registered = 1;
 914       return 0;
 915     }
 916
 917   bm->cb.vlib_buffer_fill_free_list_cb = &vlib_buffer_fill_free_list_internal;
 918   bm->cb.vlib_buffer_free_cb = &vlib_buffer_free_internal;
 919   bm->cb.vlib_buffer_free_no_next_cb = &vlib_buffer_free_no_next_internal;
 920   bm->cb.vlib_buffer_delete_free_list_cb =
 921     &vlib_buffer_delete_free_list_internal;
 922   clib_spinlock_init (&bm->buffer_known_hash_lockp);
 923
 924 retry:
 925   error = vlib_physmem_shared_map_create (vm, "buffers",
 926                                           vlib_buffer_physmem_sz,
 927                                           log2_page_size,
 928                                           CLIB_PMALLOC_NUMA_LOCAL,
 929                                           &physmem_map_index);
 930
 931   if (error && log2_page_size == 0)
 932     {
 933       vlib_log_warn (buffer_log_default, "%U", format_clib_error, error);
 934       clib_error_free (error);
 935       vlib_log_warn (buffer_log_default, "falling back to non-hugepage "
 936                      "backed buffer pool");
 937       log2_page_size = min_log2 (clib_mem_get_page_size ());
 938       goto retry;
 939     }
 940
 941   if (error)
 942     return error;
 943
 944   pool_index = vlib_buffer_register_physmem_map (vm, physmem_map_index);
 945   vlib_buffer_pool_t *bp = vlib_buffer_pool_get (vm, pool_index);
 946   clib_spinlock_init (&bp->lock);
 947   bp->buffer_size = VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES +
 948     sizeof (vlib_buffer_t);
 949
 950   return 0;
 951 }
 952
 953 static clib_error_t *
 954 vlib_buffers_configure (vlib_main_t * vm, unformat_input_t * input)
 955 {
 956   u32 size_in_mb;
 957
 958   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
 959     {
 960       if (unformat (input, "memory-size-in-mb %d", &size_in_mb))
 961         vlib_buffer_physmem_sz = size_in_mb << 20;
 962       else
 963         return unformat_parse_error (input);
 964     }
 965
 966   unformat_free (input);
 967   return 0;
 968 }
 969
 970 VLIB_EARLY_CONFIG_FUNCTION (vlib_buffers_configure, "buffers");
 971
 972
 973 /** @endcond */
 974 /*
 975  * fd.io coding-style-patch-verification: ON
 976  *
 977  * Local Variables:
 978  * eval: (c-set-style "gnu")
 979  * End:
 980  */