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 uword
  59 vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm,
  60                                        vlib_buffer_t * b_first)
  61 {
  62   vlib_buffer_t *b = b_first;
  63   uword l_first = b_first->current_length;
  64   uword l = 0;
  65   while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
  66     {
  67       b = vlib_get_buffer (vm, b->next_buffer);
  68       l += b->current_length;
  69     }
  70   b_first->total_length_not_including_first_buffer = l;
  71   b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
  72   return l + l_first;
  73 }
  74
  75 u8 *
  76 format_vlib_buffer (u8 * s, va_list * args)
  77 {
  78   vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
  79   u32 indent = format_get_indent (s);
  80   u8 *a = 0;
  81
  82 #define _(bit, name, v) \
  83   if (v && (b->flags & VLIB_BUFFER_##name)) \
  84     a = format (a, "%s ", v);
  85   foreach_vlib_buffer_flag
  86 #undef _
  87     s = format (s, "current data %d, length %d, free-list %d, clone-count %u",
  88                 b->current_data, b->current_length,
  89                 vlib_buffer_get_free_list_index (b), b->n_add_refs);
  90
  91   if (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID)
  92     s = format (s, ", totlen-nifb %d",
  93                 b->total_length_not_including_first_buffer);
  94
  95   if (b->flags & VLIB_BUFFER_IS_TRACED)
  96     s = format (s, ", trace 0x%x", b->trace_index);
  97
  98   if (a)
  99     s = format (s, "\n%U%v", format_white_space, indent, a);
 100   vec_free (a);
 101
 102   while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
 103     {
 104       vlib_main_t *vm = vlib_get_main ();
 105       u32 next_buffer = b->next_buffer;
 106       b = vlib_get_buffer (vm, next_buffer);
 107
 108       s =
 109         format (s, "\n%Unext-buffer 0x%x, segment length %d, clone-count %u",
 110                 format_white_space, indent, next_buffer, b->current_length,
 111                 b->n_add_refs);
 112     }
 113
 114   return s;
 115 }
 116
 117 u8 *
 118 format_vlib_buffer_and_data (u8 * s, va_list * args)
 119 {
 120   vlib_buffer_t *b = va_arg (*args, vlib_buffer_t *);
 121
 122   s = format (s, "%U, %U",
 123               format_vlib_buffer, b,
 124               format_hex_bytes, vlib_buffer_get_current (b), 64);
 125
 126   return s;
 127 }
 128
 129 static u8 *
 130 format_vlib_buffer_known_state (u8 * s, va_list * args)
 131 {
 132   vlib_buffer_known_state_t state = va_arg (*args, vlib_buffer_known_state_t);
 133   char *t;
 134
 135   switch (state)
 136     {
 137     case VLIB_BUFFER_UNKNOWN:
 138       t = "unknown";
 139       break;
 140
 141     case VLIB_BUFFER_KNOWN_ALLOCATED:
 142       t = "known-allocated";
 143       break;
 144
 145     case VLIB_BUFFER_KNOWN_FREE:
 146       t = "known-free";
 147       break;
 148
 149     default:
 150       t = "invalid";
 151       break;
 152     }
 153
 154   return format (s, "%s", t);
 155 }
 156
 157 u8 *
 158 format_vlib_buffer_contents (u8 * s, va_list * va)
 159 {
 160   vlib_main_t *vm = va_arg (*va, vlib_main_t *);
 161   vlib_buffer_t *b = va_arg (*va, vlib_buffer_t *);
 162
 163   while (1)
 164     {
 165       vec_add (s, vlib_buffer_get_current (b), b->current_length);
 166       if (!(b->flags & VLIB_BUFFER_NEXT_PRESENT))
 167         break;
 168       b = vlib_get_buffer (vm, b->next_buffer);
 169     }
 170
 171   return s;
 172 }
 173
 174 static u8 *
 175 vlib_validate_buffer_helper (vlib_main_t * vm,
 176                              u32 bi,
 177                              uword follow_buffer_next, uword ** unique_hash)
 178 {
 179   vlib_buffer_t *b = vlib_get_buffer (vm, bi);
 180   vlib_buffer_free_list_t *fl;
 181
 182   if (pool_is_free_index
 183       (vm->buffer_free_list_pool, vlib_buffer_get_free_list_index (b)))
 184     return format (0, "unknown free list 0x%x",
 185                    vlib_buffer_get_free_list_index (b));
 186
 187   fl =
 188     pool_elt_at_index (vm->buffer_free_list_pool,
 189                        vlib_buffer_get_free_list_index (b));
 190
 191   if ((signed) b->current_data < (signed) -VLIB_BUFFER_PRE_DATA_SIZE)
 192     return format (0, "current data %d before pre-data", b->current_data);
 193
 194   if (b->current_data + b->current_length > fl->n_data_bytes)
 195     return format (0, "%d-%d beyond end of buffer %d",
 196                    b->current_data, b->current_length, fl->n_data_bytes);
 197
 198   if (follow_buffer_next && (b->flags & VLIB_BUFFER_NEXT_PRESENT))
 199     {
 200       vlib_buffer_known_state_t k;
 201       u8 *msg, *result;
 202
 203       k = vlib_buffer_is_known (b->next_buffer);
 204       if (k != VLIB_BUFFER_KNOWN_ALLOCATED)
 205         return format (0, "next 0x%x: %U",
 206                        b->next_buffer, format_vlib_buffer_known_state, k);
 207
 208       if (unique_hash)
 209         {
 210           if (hash_get (*unique_hash, b->next_buffer))
 211             return format (0, "duplicate buffer 0x%x", b->next_buffer);
 212
 213           hash_set1 (*unique_hash, b->next_buffer);
 214         }
 215
 216       msg = vlib_validate_buffer (vm, b->next_buffer, follow_buffer_next);
 217       if (msg)
 218         {
 219           result = format (0, "next 0x%x: %v", b->next_buffer, msg);
 220           vec_free (msg);
 221           return result;
 222         }
 223     }
 224
 225   return 0;
 226 }
 227
 228 u8 *
 229 vlib_validate_buffer (vlib_main_t * vm, u32 bi, uword follow_buffer_next)
 230 {
 231   return vlib_validate_buffer_helper (vm, bi, follow_buffer_next,
 232                                       /* unique_hash */ 0);
 233 }
 234
 235 u8 *
 236 vlib_validate_buffers (vlib_main_t * vm,
 237                        u32 * buffers,
 238                        uword next_buffer_stride,
 239                        uword n_buffers,
 240                        vlib_buffer_known_state_t known_state,
 241                        uword follow_buffer_next)
 242 {
 243   uword i, *hash;
 244   u32 bi, *b = buffers;
 245   vlib_buffer_known_state_t k;
 246   u8 *msg = 0, *result = 0;
 247
 248   hash = hash_create (0, 0);
 249   for (i = 0; i < n_buffers; i++)
 250     {
 251       bi = b[0];
 252       b += next_buffer_stride;
 253
 254       /* Buffer is not unique. */
 255       if (hash_get (hash, bi))
 256         {
 257           msg = format (0, "not unique");
 258           goto done;
 259         }
 260
 261       k = vlib_buffer_is_known (bi);
 262       if (k != known_state)
 263         {
 264           msg = format (0, "is %U; expected %U",
 265                         format_vlib_buffer_known_state, k,
 266                         format_vlib_buffer_known_state, known_state);
 267           goto done;
 268         }
 269
 270       msg = vlib_validate_buffer_helper (vm, bi, follow_buffer_next, &hash);
 271       if (msg)
 272         goto done;
 273
 274       hash_set1 (hash, bi);
 275     }
 276
 277 done:
 278   if (msg)
 279     {
 280       result = format (0, "0x%x: %v", bi, msg);
 281       vec_free (msg);
 282     }
 283   hash_free (hash);
 284   return result;
 285 }
 286
 287 /*
 288  * Hand-craft a static vector w/ length 1, so vec_len(vlib_mains) =1
 289  * and vlib_mains[0] = &vlib_global_main from the beginning of time.
 290  *
 291  * The only place which should ever expand vlib_mains is start_workers()
 292  * in threads.c. It knows about the bootstrap vector.
 293  */
 294 /* *INDENT-OFF* */
 295 static struct
 296 {
 297   vec_header_t h;
 298   vlib_main_t *vm;
 299 } __attribute__ ((packed)) __bootstrap_vlib_main_vector
 300   __attribute__ ((aligned (CLIB_CACHE_LINE_BYTES))) =
 301 {
 302   .h.len = 1,
 303   .vm = &vlib_global_main,
 304 };
 305 /* *INDENT-ON* */
 306
 307 vlib_main_t **vlib_mains = &__bootstrap_vlib_main_vector.vm;
 308
 309
 310 /* When dubugging validate that given buffers are either known allocated
 311    or known free. */
 312 void
 313 vlib_buffer_validate_alloc_free (vlib_main_t * vm,
 314                                  u32 * buffers,
 315                                  uword n_buffers,
 316                                  vlib_buffer_known_state_t expected_state)
 317 {
 318   u32 *b;
 319   uword i, bi, is_free;
 320
 321   if (CLIB_DEBUG == 0)
 322     return;
 323
 324   if (vlib_buffer_callbacks)
 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 (bi);
 336       if (known != expected_state)
 337         {
 338           ASSERT (0);
 339           vlib_panic_with_msg
 340             (vm, "%s %U buffer 0x%x",
 341              is_free ? "freeing" : "allocating",
 342              format_vlib_buffer_known_state, known, bi);
 343         }
 344
 345       vlib_buffer_set_known_state
 346         (bi, is_free ? VLIB_BUFFER_KNOWN_FREE : VLIB_BUFFER_KNOWN_ALLOCATED);
 347     }
 348 }
 349
 350 /* Add buffer free list. */
 351 static vlib_buffer_free_list_index_t
 352 vlib_buffer_create_free_list_helper (vlib_main_t * vm,
 353                                      u32 n_data_bytes,
 354                                      u32 is_public, u32 is_default, u8 * name)
 355 {
 356   vlib_buffer_main_t *bm = &buffer_main;
 357   vlib_buffer_free_list_t *f;
 358   int i;
 359
 360   ASSERT (vlib_get_thread_index () == 0);
 361
 362   if (!is_default && pool_elts (vm->buffer_free_list_pool) == 0)
 363     {
 364       vlib_buffer_free_list_index_t default_free_free_list_index;
 365
 366       /* *INDENT-OFF* */
 367       default_free_free_list_index =
 368         vlib_buffer_create_free_list_helper
 369         (vm,
 370          /* default buffer size */ VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
 371          /* is_public */ 1,
 372          /* is_default */ 1,
 373          (u8 *) "default");
 374       /* *INDENT-ON* */
 375       ASSERT (default_free_free_list_index ==
 376               VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
 377
 378       if (n_data_bytes == VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES && is_public)
 379         return default_free_free_list_index;
 380     }
 381
 382   pool_get_aligned (vm->buffer_free_list_pool, f, CLIB_CACHE_LINE_BYTES);
 383
 384   clib_memset (f, 0, sizeof (f[0]));
 385   f->index = f - vm->buffer_free_list_pool;
 386   f->n_data_bytes = vlib_buffer_round_size (n_data_bytes);
 387   f->min_n_buffers_each_alloc = VLIB_FRAME_SIZE;
 388   f->buffer_pool_index = 0;
 389   f->name = clib_mem_is_vec (name) ? name : format (0, "%s", name);
 390
 391   /* Setup free buffer template. */
 392   vlib_buffer_set_free_list_index (&f->buffer_init_template, f->index);
 393   f->buffer_init_template.n_add_refs = 0;
 394
 395   if (is_public)
 396     {
 397       uword *p = hash_get (bm->free_list_by_size, f->n_data_bytes);
 398       if (!p)
 399         hash_set (bm->free_list_by_size, f->n_data_bytes, f->index);
 400     }
 401
 402   for (i = 1; i < vec_len (vlib_mains); i++)
 403     {
 404       vlib_main_t *wvm = vlib_mains[i];
 405       vlib_buffer_free_list_t *wf;
 406       pool_get_aligned (wvm->buffer_free_list_pool,
 407                         wf, CLIB_CACHE_LINE_BYTES);
 408       ASSERT (f - vm->buffer_free_list_pool ==
 409               wf - wvm->buffer_free_list_pool);
 410       wf[0] = f[0];
 411       wf->buffers = 0;
 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   vlib_buffer_free_list_index_t fi;
 564   u32 flags, next;
 565
 566   fl = vlib_buffer_get_buffer_free_list (vm, b, &fi);
 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 /* Copy template packet data into buffers as they are allocated. */
 658 static void __attribute__ ((unused))
 659 vlib_packet_template_buffer_init (vlib_main_t * vm,
 660                                   vlib_buffer_free_list_t * fl,
 661                                   u32 * buffers, u32 n_buffers)
 662 {
 663   vlib_packet_template_t *t =
 664     uword_to_pointer (fl->buffer_init_function_opaque,
 665                       vlib_packet_template_t *);
 666   uword i;
 667
 668   for (i = 0; i < n_buffers; i++)
 669     {
 670       vlib_buffer_t *b = vlib_get_buffer (vm, buffers[i]);
 671       ASSERT (b->current_length == vec_len (t->packet_data));
 672       clib_memcpy (vlib_buffer_get_current (b), t->packet_data,
 673                    b->current_length);
 674     }
 675 }
 676
 677 void
 678 vlib_packet_template_init (vlib_main_t * vm,
 679                            vlib_packet_template_t * t,
 680                            void *packet_data,
 681                            uword n_packet_data_bytes,
 682                            uword min_n_buffers_each_alloc, char *fmt, ...)
 683 {
 684   vlib_buffer_main_t *bm = &buffer_main;
 685   va_list va;
 686   u8 *name;
 687   vlib_buffer_free_list_t *fl;
 688
 689   va_start (va, fmt);
 690   name = va_format (0, fmt, &va);
 691   va_end (va);
 692
 693   if (bm->cb.vlib_packet_template_init_cb)
 694     bm->cb.vlib_packet_template_init_cb (vm, (void *) t, packet_data,
 695                                          n_packet_data_bytes,
 696                                          min_n_buffers_each_alloc, name);
 697
 698   vlib_worker_thread_barrier_sync (vm);
 699
 700   clib_memset (t, 0, sizeof (t[0]));
 701
 702   vec_add (t->packet_data, packet_data, n_packet_data_bytes);
 703   t->min_n_buffers_each_alloc = min_n_buffers_each_alloc;
 704
 705   t->free_list_index = vlib_buffer_create_free_list_helper
 706     (vm, n_packet_data_bytes,
 707      /* is_public */ 1,
 708      /* is_default */ 0,
 709      name);
 710
 711   ASSERT (t->free_list_index != 0);
 712   fl = vlib_buffer_get_free_list (vm, t->free_list_index);
 713   fl->min_n_buffers_each_alloc = t->min_n_buffers_each_alloc;
 714
 715   fl->buffer_init_function = vlib_packet_template_buffer_init;
 716   fl->buffer_init_function_opaque = pointer_to_uword (t);
 717
 718   fl->buffer_init_template.current_data = 0;
 719   fl->buffer_init_template.current_length = n_packet_data_bytes;
 720   fl->buffer_init_template.flags = 0;
 721   fl->buffer_init_template.n_add_refs = 0;
 722   vlib_worker_thread_barrier_release (vm);
 723 }
 724
 725 void *
 726 vlib_packet_template_get_packet (vlib_main_t * vm,
 727                                  vlib_packet_template_t * t, u32 * bi_result)
 728 {
 729   u32 bi;
 730   vlib_buffer_t *b;
 731
 732   if (vlib_buffer_alloc (vm, &bi, 1) != 1)
 733     return 0;
 734
 735   *bi_result = bi;
 736
 737   b = vlib_get_buffer (vm, bi);
 738   clib_memcpy (vlib_buffer_get_current (b),
 739                t->packet_data, vec_len (t->packet_data));
 740   b->current_length = vec_len (t->packet_data);
 741
 742   return b->data;
 743 }
 744
 745 void
 746 vlib_packet_template_get_packet_helper (vlib_main_t * vm,
 747                                         vlib_packet_template_t * t)
 748 {
 749   word n = t->min_n_buffers_each_alloc;
 750   word l = vec_len (t->packet_data);
 751   word n_alloc;
 752
 753   ASSERT (l > 0);
 754   ASSERT (vec_len (t->free_buffers) == 0);
 755
 756   vec_validate (t->free_buffers, n - 1);
 757   n_alloc = vlib_buffer_alloc_from_free_list (vm, t->free_buffers,
 758                                               n, t->free_list_index);
 759   _vec_len (t->free_buffers) = n_alloc;
 760 }
 761
 762 /* Append given data to end of buffer, possibly allocating new buffers. */
 763 u32
 764 vlib_buffer_add_data (vlib_main_t * vm,
 765                       vlib_buffer_free_list_index_t free_list_index,
 766                       u32 buffer_index, void *data, u32 n_data_bytes)
 767 {
 768   u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
 769   vlib_buffer_t *b;
 770   void *d;
 771
 772   bi = buffer_index;
 773   if (bi == ~0
 774       && 1 != vlib_buffer_alloc_from_free_list (vm, &bi, 1, free_list_index))
 775     goto out_of_buffers;
 776
 777   d = data;
 778   n_left = n_data_bytes;
 779   n_buffer_bytes = vlib_buffer_free_list_buffer_size (vm, free_list_index);
 780
 781   b = vlib_get_buffer (vm, bi);
 782   b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
 783
 784   /* Get to the end of the chain before we try to append data... */
 785   while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
 786     b = vlib_get_buffer (vm, b->next_buffer);
 787
 788   while (1)
 789     {
 790       u32 n;
 791
 792       ASSERT (n_buffer_bytes >= b->current_length);
 793       n_left_this_buffer =
 794         n_buffer_bytes - (b->current_data + b->current_length);
 795       n = clib_min (n_left_this_buffer, n_left);
 796       clib_memcpy (vlib_buffer_get_current (b) + b->current_length, d, n);
 797       b->current_length += n;
 798       n_left -= n;
 799       if (n_left == 0)
 800         break;
 801
 802       d += n;
 803       if (1 !=
 804           vlib_buffer_alloc_from_free_list (vm, &b->next_buffer, 1,
 805                                             free_list_index))
 806         goto out_of_buffers;
 807
 808       b->flags |= VLIB_BUFFER_NEXT_PRESENT;
 809
 810       b = vlib_get_buffer (vm, b->next_buffer);
 811     }
 812
 813   return bi;
 814
 815 out_of_buffers:
 816   clib_error ("out of buffers");
 817   return bi;
 818 }
 819
 820 u16
 821 vlib_buffer_chain_append_data_with_alloc (vlib_main_t * vm,
 822                                           vlib_buffer_free_list_index_t
 823                                           free_list_index,
 824                                           vlib_buffer_t * first,
 825                                           vlib_buffer_t ** last, void *data,
 826                                           u16 data_len)
 827 {
 828   vlib_buffer_t *l = *last;
 829   u32 n_buffer_bytes =
 830     vlib_buffer_free_list_buffer_size (vm, free_list_index);
 831   u16 copied = 0;
 832   ASSERT (n_buffer_bytes >= l->current_length + l->current_data);
 833   while (data_len)
 834     {
 835       u16 max = n_buffer_bytes - l->current_length - l->current_data;
 836       if (max == 0)
 837         {
 838           if (1 !=
 839               vlib_buffer_alloc_from_free_list (vm, &l->next_buffer, 1,
 840                                                 free_list_index))
 841             return copied;
 842           *last = l = vlib_buffer_chain_buffer (vm, first, l, l->next_buffer);
 843           max = n_buffer_bytes - l->current_length - l->current_data;
 844         }
 845
 846       u16 len = (data_len > max) ? max : data_len;
 847       clib_memcpy (vlib_buffer_get_current (l) + l->current_length,
 848                    data + copied, len);
 849       vlib_buffer_chain_increase_length (first, l, len);
 850       data_len -= len;
 851       copied += len;
 852     }
 853   return copied;
 854 }
 855
 856 u8
 857 vlib_buffer_register_physmem_map (vlib_main_t * vm, u32 physmem_map_index)
 858 {
 859   vlib_buffer_main_t *bm = &buffer_main;
 860   vlib_buffer_pool_t *p;
 861   vlib_physmem_map_t *m = vlib_physmem_get_map (vm, physmem_map_index);
 862   uword start = pointer_to_uword (m->base);
 863   uword size = m->n_pages << m->log2_page_size;
 864
 865   if (bm->buffer_mem_size == 0)
 866     {
 867       bm->buffer_mem_start = start;
 868       bm->buffer_mem_size = size;
 869     }
 870   else if (start < bm->buffer_mem_start)
 871     {
 872       bm->buffer_mem_size += bm->buffer_mem_start - start;
 873       bm->buffer_mem_start = start;
 874       if (size > bm->buffer_mem_size)
 875         bm->buffer_mem_size = size;
 876     }
 877   else if (start > bm->buffer_mem_start)
 878     {
 879       uword new_size = start - bm->buffer_mem_start + size;
 880       if (new_size > bm->buffer_mem_size)
 881         bm->buffer_mem_size = new_size;
 882     }
 883
 884   if ((u64) bm->buffer_mem_size >
 885       ((u64) 1 << (32 + CLIB_LOG2_CACHE_LINE_BYTES)))
 886     {
 887       clib_panic ("buffer memory size out of range!");
 888     }
 889
 890   vec_add2 (bm->buffer_pools, p, 1);
 891   p->start = start;
 892   p->size = size;
 893   p->physmem_map_index = physmem_map_index;
 894
 895   ASSERT (p - bm->buffer_pools < 256);
 896   return p - bm->buffer_pools;
 897 }
 898
 899 static u8 *
 900 format_vlib_buffer_free_list (u8 * s, va_list * va)
 901 {
 902   vlib_buffer_free_list_t *f = va_arg (*va, vlib_buffer_free_list_t *);
 903   u32 threadnum = va_arg (*va, u32);
 904   uword bytes_alloc, bytes_free, n_free, size;
 905
 906   if (!f)
 907     return format (s, "%=7s%=30s%=12s%=12s%=12s%=12s%=12s%=12s",
 908                    "Thread", "Name", "Index", "Size", "Alloc", "Free",
 909                    "#Alloc", "#Free");
 910
 911   size = sizeof (vlib_buffer_t) + f->n_data_bytes;
 912   n_free = vec_len (f->buffers);
 913   bytes_alloc = size * f->n_alloc;
 914   bytes_free = size * n_free;
 915
 916   s = format (s, "%7d%30v%12d%12d%=12U%=12U%=12d%=12d", threadnum,
 917               f->name, f->index, f->n_data_bytes,
 918               format_memory_size, bytes_alloc,
 919               format_memory_size, bytes_free, f->n_alloc, n_free);
 920
 921   return s;
 922 }
 923
 924 static clib_error_t *
 925 show_buffers (vlib_main_t * vm,
 926               unformat_input_t * input, vlib_cli_command_t * cmd)
 927 {
 928   vlib_buffer_free_list_t *f;
 929   vlib_main_t *curr_vm;
 930   u32 vm_index = 0;
 931
 932   vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, 0, 0);
 933
 934   do
 935     {
 936       curr_vm = vlib_mains[vm_index];
 937
 938     /* *INDENT-OFF* */
 939     pool_foreach (f, curr_vm->buffer_free_list_pool, ({
 940       vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, f, vm_index);
 941     }));
 942     /* *INDENT-ON* */
 943
 944       vm_index++;
 945     }
 946   while (vm_index < vec_len (vlib_mains));
 947
 948   return 0;
 949 }
 950
 951 /* *INDENT-OFF* */
 952 VLIB_CLI_COMMAND (show_buffers_command, static) = {
 953   .path = "show buffers",
 954   .short_help = "Show packet buffer allocation",
 955   .function = show_buffers,
 956 };
 957 /* *INDENT-ON* */
 958
 959 clib_error_t *
 960 vlib_buffer_main_init (struct vlib_main_t * vm)
 961 {
 962   vlib_buffer_main_t *bm = &buffer_main;
 963   clib_error_t *error;
 964   u32 physmem_map_index;
 965   u8 pool_index;
 966
 967   if (vlib_buffer_callbacks)
 968     {
 969       /* external plugin has registered own buffer callbacks
 970          so we just copy them  and quit */
 971       clib_memcpy (&bm->cb, vlib_buffer_callbacks,
 972                    sizeof (vlib_buffer_callbacks_t));
 973       bm->callbacks_registered = 1;
 974       return 0;
 975     }
 976
 977   bm->cb.vlib_buffer_fill_free_list_cb = &vlib_buffer_fill_free_list_internal;
 978   bm->cb.vlib_buffer_free_cb = &vlib_buffer_free_internal;
 979   bm->cb.vlib_buffer_free_no_next_cb = &vlib_buffer_free_no_next_internal;
 980   bm->cb.vlib_buffer_delete_free_list_cb =
 981     &vlib_buffer_delete_free_list_internal;
 982   clib_spinlock_init (&bm->buffer_known_hash_lockp);
 983
 984   if ((error = vlib_physmem_shared_map_create (vm, "buffers",
 985                                                vlib_buffer_physmem_sz, 1,
 986                                                &physmem_map_index)))
 987     return error;
 988
 989   pool_index = vlib_buffer_register_physmem_map (vm, physmem_map_index);
 990   vlib_buffer_pool_t *bp = vlib_buffer_pool_get (pool_index);
 991   clib_spinlock_init (&bp->lock);
 992   bp->buffer_size = VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES +
 993     sizeof (vlib_buffer_t);
 994
 995   return 0;
 996 }
 997
 998 static clib_error_t *
 999 vlib_buffers_configure (vlib_main_t * vm, unformat_input_t * input)
1000 {
1001   u32 size_in_mb;
1002
1003   while (unformat_check_input (input) != UNFORMAT_END_OF_INPUT)
1004     {
1005       if (unformat (input, "memory-size-in-mb %d", &size_in_mb))
1006         vlib_buffer_physmem_sz = size_in_mb << 20;
1007       else
1008         return unformat_parse_error (input);
1009     }
1010
1011   unformat_free (input);
1012   return 0;
1013 }
1014
1015 VLIB_EARLY_CONFIG_FUNCTION (vlib_buffers_configure, "buffers");
1016
1017
1018 /** @endcond */
1019 /*
1020  * fd.io coding-style-patch-verification: ON
1021  *
1022  * Local Variables:
1023  * eval: (c-set-style "gnu")
1024  * End:
1025  */