src/vlib/buffer.c

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