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