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