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