vlib/vlib/dpdk_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 #include <rte_config.h>
  41
  42 #include <rte_common.h>
  43 #include <rte_log.h>
  44 #include <rte_memory.h>
  45 #include <rte_memcpy.h>
  46 #include <rte_memzone.h>
  47 #include <rte_tailq.h>
  48 #include <rte_eal.h>
  49 #include <rte_per_lcore.h>
  50 #include <rte_launch.h>
  51 #include <rte_atomic.h>
  52 #include <rte_cycles.h>
  53 #include <rte_prefetch.h>
  54 #include <rte_lcore.h>
  55 #include <rte_per_lcore.h>
  56 #include <rte_branch_prediction.h>
  57 #include <rte_interrupts.h>
  58 #include <rte_pci.h>
  59 #include <rte_random.h>
  60 #include <rte_debug.h>
  61 #include <rte_ether.h>
  62 #include <rte_ethdev.h>
  63 #include <rte_ring.h>
  64 #include <rte_mempool.h>
  65 #include <rte_mbuf.h>
  66
  67 #include <vlib/vlib.h>
  68
  69 phys_addr_t          __attribute__ ((weak)) rte_mem_virt2phy();
  70 int                  __attribute__ ((weak)) rte_eal_has_hugepages();
  71 unsigned             __attribute__ ((weak)) rte_socket_id();
  72 struct rte_mempool * __attribute__ ((weak)) rte_mempool_create();
  73 void                 __attribute__ ((weak)) rte_pktmbuf_init();
  74 void                 __attribute__ ((weak)) rte_pktmbuf_pool_init();
  75
  76 uword vlib_buffer_length_in_chain_slow_path (vlib_main_t * vm, vlib_buffer_t * b_first)
  77 {
  78   vlib_buffer_t * b = b_first;
  79   uword l_first = b_first->current_length;
  80   uword l = 0;
  81   while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
  82     {
  83       b = vlib_get_buffer (vm, b->next_buffer);
  84       l += b->current_length;
  85     }
  86   b_first->total_length_not_including_first_buffer = l;
  87   b_first->flags |= VLIB_BUFFER_TOTAL_LENGTH_VALID;
  88   return l + l_first;
  89 }
  90
  91 u8 * format_vlib_buffer (u8 * s, va_list * args)
  92 {
  93   vlib_buffer_t * b = va_arg (*args, vlib_buffer_t *);
  94   uword indent = format_get_indent (s);
  95
  96   s = format (s, "current data %d, length %d, free-list %d",
  97               b->current_data, b->current_length,
  98               b->free_list_index);
  99
 100   if (b->flags & VLIB_BUFFER_TOTAL_LENGTH_VALID)
 101     s = format (s, ", totlen-nifb %d",
 102                 b->total_length_not_including_first_buffer);
 103
 104   if (b->flags & VLIB_BUFFER_IS_TRACED)
 105     s = format (s, ", trace 0x%x", b->trace_index);
 106
 107   while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
 108     {
 109       vlib_main_t * vm = vlib_get_main();
 110       u32 next_buffer = b->next_buffer;
 111       b = vlib_get_buffer(vm, next_buffer);
 112
 113       s = format (s, "\n%Unext-buffer 0x%x, segment length %d",
 114                   format_white_space, indent, next_buffer, b->current_length);
 115     }
 116
 117
 118   return s;
 119 }
 120
 121 u8 * format_vlib_buffer_and_data (u8 * s, va_list * args)
 122 {
 123   vlib_buffer_t * b = va_arg (*args, vlib_buffer_t *);
 124
 125   s = format (s, "%U, %U",
 126               format_vlib_buffer, b,
 127               format_hex_bytes, vlib_buffer_get_current (b), 64);
 128
 129   return s;
 130 }
 131
 132 u8 * format_vlib_buffer_contents (u8 * s, va_list * va)
 133 {
 134   vlib_main_t * vm = va_arg (*va, vlib_main_t *);
 135   vlib_buffer_t * b = va_arg (*va, vlib_buffer_t *);
 136
 137   while (1)
 138     {
 139       vec_add (s, vlib_buffer_get_current (b),
 140                b->current_length);
 141       if (! (b->flags & VLIB_BUFFER_NEXT_PRESENT))
 142         break;
 143       b = vlib_get_buffer (vm, b->next_buffer);
 144     }
 145
 146   return s;
 147 }
 148
 149 vlib_main_t **vlib_mains;
 150
 151 /* Aligned copy routine. */
 152 void
 153 vlib_aligned_memcpy (void * _dst, void * _src, int n_bytes)
 154 {
 155   vlib_copy_unit_t * dst = _dst;
 156   vlib_copy_unit_t * src = _src;
 157
 158   /* Arguments must be naturally aligned. */
 159   ASSERT (pointer_to_uword (dst) % sizeof (dst[0]) == 0);
 160   ASSERT (pointer_to_uword (src) % sizeof (src[0]) == 0);
 161   ASSERT (n_bytes % sizeof (dst[0]) == 0);
 162
 163   if (4 * sizeof (dst[0]) == CLIB_CACHE_LINE_BYTES)
 164     {
 165       CLIB_PREFETCH (dst + 0, 4 * sizeof (dst[0]), WRITE);
 166       CLIB_PREFETCH (src + 0, 4 * sizeof (src[0]), READ);
 167
 168       while (n_bytes >= 4 * sizeof (dst[0]))
 169         {
 170           dst += 4;
 171           src += 4;
 172           n_bytes -= 4 * sizeof (dst[0]);
 173           CLIB_PREFETCH (dst, 4 * sizeof (dst[0]), WRITE);
 174           CLIB_PREFETCH (src, 4 * sizeof (src[0]), READ);
 175           dst[-4] = src[-4];
 176           dst[-3] = src[-3];
 177           dst[-2] = src[-2];
 178           dst[-1] = src[-1];
 179         }
 180     }
 181   else if (8 * sizeof (dst[0]) == CLIB_CACHE_LINE_BYTES)
 182     {
 183       CLIB_PREFETCH (dst + 0, 8 * sizeof (dst[0]), WRITE);
 184       CLIB_PREFETCH (src + 0, 8 * sizeof (src[0]), READ);
 185
 186       while (n_bytes >= 8 * sizeof (dst[0]))
 187         {
 188           dst += 8;
 189           src += 8;
 190           n_bytes -= 8 * sizeof (dst[0]);
 191           CLIB_PREFETCH (dst, 8 * sizeof (dst[0]), WRITE);
 192           CLIB_PREFETCH (src, 8 * sizeof (src[0]), READ);
 193           dst[-8] = src[-8];
 194           dst[-7] = src[-7];
 195           dst[-6] = src[-6];
 196           dst[-5] = src[-5];
 197           dst[-4] = src[-4];
 198           dst[-3] = src[-3];
 199           dst[-2] = src[-2];
 200           dst[-1] = src[-1];
 201         }
 202     }
 203   else
 204     /* Cache line size unknown: fall back to slow version. */;
 205
 206   while (n_bytes > 0)
 207     {
 208       *dst++ = *src++;
 209       n_bytes -= 1 * sizeof (dst[0]);
 210     }
 211 }
 212
 213 #define BUFFERS_PER_COPY (sizeof (vlib_copy_unit_t) / sizeof (u32))
 214
 215 /* Make sure we have at least given number of unaligned buffers. */
 216 static void
 217 fill_unaligned (vlib_main_t * vm,
 218                 vlib_buffer_free_list_t * free_list,
 219                 uword n_unaligned_buffers)
 220 {
 221   word la = vec_len (free_list->aligned_buffers);
 222   word lu = vec_len (free_list->unaligned_buffers);
 223
 224   /* Aligned come in aligned copy-sized chunks. */
 225   ASSERT (la % BUFFERS_PER_COPY == 0);
 226
 227   ASSERT (la >= n_unaligned_buffers);
 228
 229   while (lu < n_unaligned_buffers)
 230     {
 231       /* Copy 4 buffers from end of aligned vector to unaligned vector. */
 232       vec_add (free_list->unaligned_buffers,
 233                free_list->aligned_buffers + la - BUFFERS_PER_COPY,
 234                BUFFERS_PER_COPY);
 235       la -= BUFFERS_PER_COPY;
 236       lu += BUFFERS_PER_COPY;
 237     }
 238   _vec_len (free_list->aligned_buffers) = la;
 239 }
 240
 241 /* After free aligned buffers may not contain even sized chunks. */
 242 static void
 243 trim_aligned (vlib_buffer_free_list_t * f)
 244 {
 245   uword l, n_trim;
 246
 247   /* Add unaligned to aligned before trim. */
 248   l = vec_len (f->unaligned_buffers);
 249   if (l > 0)
 250     {
 251       vec_add_aligned (f->aligned_buffers, f->unaligned_buffers, l,
 252                        /* align */ sizeof (vlib_copy_unit_t));
 253
 254       _vec_len (f->unaligned_buffers) = 0;
 255     }
 256
 257   /* Remove unaligned buffers from end of aligned vector and save for next trim. */
 258   l = vec_len (f->aligned_buffers);
 259   n_trim = l % BUFFERS_PER_COPY;
 260   if (n_trim)
 261     {
 262       /* Trim aligned -> unaligned. */
 263       vec_add (f->unaligned_buffers, f->aligned_buffers + l - n_trim, n_trim);
 264
 265       /* Remove from aligned. */
 266       _vec_len (f->aligned_buffers) = l - n_trim;
 267     }
 268 }
 269
 270 static void
 271 merge_free_lists (vlib_buffer_free_list_t * dst,
 272                   vlib_buffer_free_list_t * src)
 273 {
 274   uword l;
 275   u32 * d;
 276
 277   trim_aligned (src);
 278   trim_aligned (dst);
 279
 280   l = vec_len (src->aligned_buffers);
 281   if (l > 0)
 282     {
 283       vec_add2_aligned (dst->aligned_buffers, d, l,
 284                         /* align */ sizeof (vlib_copy_unit_t));
 285       vlib_aligned_memcpy (d, src->aligned_buffers, l * sizeof (d[0]));
 286       vec_free (src->aligned_buffers);
 287     }
 288
 289   l = vec_len (src->unaligned_buffers);
 290   if (l > 0)
 291     {
 292       vec_add (dst->unaligned_buffers, src->unaligned_buffers, l);
 293       vec_free (src->unaligned_buffers);
 294     }
 295 }
 296
 297 always_inline u32
 298 vlib_buffer_get_free_list_with_size (vlib_main_t * vm, u32 size)
 299 {
 300   vlib_buffer_main_t * bm = vm->buffer_main;
 301
 302   size = vlib_buffer_round_size (size);
 303   uword * p = hash_get (bm->free_list_by_size, size);
 304   return p ? p[0] : ~0;
 305 }
 306
 307 /* Add buffer free list. */
 308 static u32
 309 vlib_buffer_create_free_list_helper (vlib_main_t * vm,
 310                                      u32 n_data_bytes,
 311                                      u32 is_public,
 312                                      u32 is_default,
 313                                      u8 * name)
 314 {
 315   vlib_buffer_main_t * bm = vm->buffer_main;
 316   vlib_buffer_free_list_t * f;
 317
 318   if (! is_default && pool_elts (bm->buffer_free_list_pool) == 0)
 319     {
 320       u32 default_free_free_list_index;
 321
 322       default_free_free_list_index =
 323         vlib_buffer_create_free_list_helper (vm,
 324                                              /* default buffer size */ VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES,
 325                                              /* is_public */ 1,
 326                                              /* is_default */ 1,
 327                                              (u8 *) "default");
 328       ASSERT (default_free_free_list_index == VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX);
 329
 330       if (n_data_bytes == VLIB_BUFFER_DEFAULT_FREE_LIST_BYTES && is_public)
 331         return default_free_free_list_index;
 332     }
 333
 334   pool_get_aligned (bm->buffer_free_list_pool, f, CLIB_CACHE_LINE_BYTES);
 335
 336   memset (f, 0, sizeof (f[0]));
 337   f->index = f - bm->buffer_free_list_pool;
 338   f->n_data_bytes = vlib_buffer_round_size (n_data_bytes);
 339   f->min_n_buffers_each_physmem_alloc = 16;
 340   f->name = clib_mem_is_heap_object (name) ? name : format (0, "%s", name);
 341
 342   /* Setup free buffer template. */
 343   f->buffer_init_template.free_list_index = f->index;
 344
 345   if (is_public)
 346     {
 347       uword * p = hash_get (bm->free_list_by_size, f->n_data_bytes);
 348       if (! p)
 349         hash_set (bm->free_list_by_size, f->n_data_bytes, f->index);
 350     }
 351
 352   return f->index;
 353 }
 354
 355 u32 vlib_buffer_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
 356                                   char * fmt, ...)
 357 {
 358   va_list va;
 359   u8 * name;
 360
 361   va_start (va, fmt);
 362   name = va_format (0, fmt, &va);
 363   va_end (va);
 364
 365   return vlib_buffer_create_free_list_helper (vm, n_data_bytes,
 366                                               /* is_public */ 0,
 367                                               /* is_default */ 0,
 368                                               name);
 369 }
 370
 371 u32 vlib_buffer_get_or_create_free_list (vlib_main_t * vm, u32 n_data_bytes,
 372                                          char * fmt, ...)
 373 {
 374   u32 i = vlib_buffer_get_free_list_with_size (vm, n_data_bytes);
 375
 376   if (i == ~0)
 377     {
 378       va_list va;
 379       u8 * name;
 380
 381       va_start (va, fmt);
 382       name = va_format (0, fmt, &va);
 383       va_end (va);
 384
 385       i = vlib_buffer_create_free_list_helper (vm, n_data_bytes,
 386                                                /* is_public */ 1,
 387                                                /* is_default */ 0,
 388                                                name);
 389     }
 390
 391   return i;
 392 }
 393
 394 static void
 395 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
 396 {
 397   u32 i;
 398   struct rte_mbuf *mb;
 399   vlib_buffer_t *b;
 400
 401   for (i = 0; i < vec_len (f->unaligned_buffers); i++) {
 402       b = vlib_get_buffer (vm, f->unaligned_buffers[i]);
 403       mb = ((struct rte_mbuf *)b)-1;
 404       rte_pktmbuf_free (mb);
 405   }
 406   for (i = 0; i < vec_len (f->aligned_buffers); i++) {
 407       b = vlib_get_buffer (vm, f->aligned_buffers[i]);
 408       mb = ((struct rte_mbuf *)b)-1;
 409       rte_pktmbuf_free (mb);
 410   }
 411   vec_free (f->name);
 412   vec_free (f->unaligned_buffers);
 413   vec_free (f->aligned_buffers);
 414 }
 415
 416 /* Add buffer free list. */
 417 void vlib_buffer_delete_free_list (vlib_main_t * vm, u32 free_list_index)
 418 {
 419   vlib_buffer_main_t * bm = vm->buffer_main;
 420   vlib_buffer_free_list_t * f;
 421   u32 merge_index;
 422
 423   f = vlib_buffer_get_free_list (vm, free_list_index);
 424
 425   merge_index = vlib_buffer_get_free_list_with_size (vm, f->n_data_bytes);
 426   if (merge_index != ~0 && merge_index != free_list_index)
 427     {
 428       merge_free_lists (pool_elt_at_index (bm->buffer_free_list_pool,
 429                                            merge_index), f);
 430     }
 431
 432   del_free_list (vm, f);
 433
 434   /* Poison it. */
 435   memset (f, 0xab, sizeof (f[0]));
 436
 437   pool_put (bm->buffer_free_list_pool, f);
 438 }
 439
 440 /* Make sure free list has at least given number of free buffers. */
 441 static uword
 442 fill_free_list (vlib_main_t * vm,
 443                 vlib_buffer_free_list_t * fl,
 444                 uword min_free_buffers)
 445 {
 446   vlib_buffer_t * b;
 447   int n, i;
 448   u32 bi;
 449   u32 n_remaining, n_alloc;
 450   unsigned socket_id = rte_socket_id ? rte_socket_id() : 0;
 451   struct rte_mempool *rmp = vm->buffer_main->pktmbuf_pools[socket_id];
 452   struct rte_mbuf *mb;
 453
 454   /* Too early? */
 455   if (PREDICT_FALSE(rmp == 0))
 456     return 0;
 457
 458   trim_aligned (fl);
 459
 460   /* Already have enough free buffers on free list? */
 461   n = min_free_buffers - vec_len (fl->aligned_buffers);
 462   if (n <= 0)
 463     return min_free_buffers;
 464
 465   /* Always allocate round number of buffers. */
 466   n = round_pow2 (n, BUFFERS_PER_COPY);
 467
 468   /* Always allocate new buffers in reasonably large sized chunks. */
 469   n = clib_max (n, fl->min_n_buffers_each_physmem_alloc);
 470
 471   vec_validate (vm->mbuf_alloc_list, n-1);
 472
 473   if (rte_mempool_get_bulk (rmp, vm->mbuf_alloc_list, n) < 0)
 474     return 0;
 475
 476   _vec_len (vm->mbuf_alloc_list) = n;
 477
 478   for (i = 0; i < n; i++)
 479     {
 480       mb = vm->mbuf_alloc_list[i];
 481
 482       ASSERT(rte_mbuf_refcnt_read(mb) == 0);
 483       rte_mbuf_refcnt_set(mb, 1);
 484       mb->next = NULL;
 485       mb->data_off = RTE_PKTMBUF_HEADROOM;
 486       mb->nb_segs = 1;
 487
 488       b = (vlib_buffer_t *)(mb+1);
 489       bi = vlib_get_buffer_index (vm, b);
 490
 491       vec_add1_aligned (fl->aligned_buffers, bi, sizeof (vlib_copy_unit_t));
 492       n_alloc++;
 493       n_remaining--;
 494
 495       vlib_buffer_init_for_free_list (b, fl);
 496
 497       if (fl->buffer_init_function)
 498         fl->buffer_init_function (vm, fl, &bi, 1);
 499     }
 500
 501   fl->n_alloc += n;
 502
 503   return n;
 504 }
 505
 506 always_inline uword
 507 copy_alignment (u32 * x)
 508 { return (pointer_to_uword (x) / sizeof (x[0])) % BUFFERS_PER_COPY; }
 509
 510 static u32
 511 alloc_from_free_list (vlib_main_t * vm,
 512                       vlib_buffer_free_list_t * free_list,
 513                       u32 * alloc_buffers,
 514                       u32 n_alloc_buffers)
 515 {
 516   u32 * dst, * u_src;
 517   uword u_len, n_left;
 518   uword n_unaligned_start, n_unaligned_end, n_filled;
 519
 520   n_left = n_alloc_buffers;
 521   dst = alloc_buffers;
 522   n_unaligned_start = ((BUFFERS_PER_COPY - copy_alignment (dst))
 523                        & (BUFFERS_PER_COPY - 1));
 524
 525   n_filled = fill_free_list (vm, free_list, n_alloc_buffers);
 526   if (n_filled == 0)
 527     return 0;
 528
 529   n_left = n_filled < n_left ? n_filled : n_left;
 530   n_alloc_buffers = n_left;
 531
 532   if (n_unaligned_start >= n_left)
 533     {
 534       n_unaligned_start = n_left;
 535       n_unaligned_end = 0;
 536     }
 537   else
 538     n_unaligned_end = copy_alignment (dst + n_alloc_buffers);
 539
 540   fill_unaligned (vm, free_list, n_unaligned_start + n_unaligned_end);
 541
 542   u_len = vec_len (free_list->unaligned_buffers);
 543   u_src = free_list->unaligned_buffers + u_len - 1;
 544
 545   if (n_unaligned_start)
 546     {
 547       uword n_copy = n_unaligned_start;
 548       if (n_copy > n_left)
 549         n_copy = n_left;
 550       n_left -= n_copy;
 551
 552       while (n_copy > 0)
 553         {
 554           *dst++ = *u_src--;
 555           n_copy--;
 556           u_len--;
 557         }
 558
 559       /* Now dst should be aligned. */
 560       if (n_left > 0)
 561         ASSERT (pointer_to_uword (dst) % sizeof (vlib_copy_unit_t) == 0);
 562     }
 563
 564   /* Aligned copy. */
 565   {
 566     vlib_copy_unit_t * d, * s;
 567     uword n_copy;
 568
 569     if (vec_len(free_list->aligned_buffers) < ((n_left/BUFFERS_PER_COPY)*BUFFERS_PER_COPY))
 570         abort();
 571
 572     n_copy = n_left / BUFFERS_PER_COPY;
 573     n_left = n_left % BUFFERS_PER_COPY;
 574
 575     /* Remove buffers from aligned free list. */
 576     _vec_len (free_list->aligned_buffers) -= n_copy * BUFFERS_PER_COPY;
 577
 578     s = (vlib_copy_unit_t *) vec_end (free_list->aligned_buffers);
 579     d = (vlib_copy_unit_t *) dst;
 580
 581     /* Fast path loop. */
 582     while (n_copy >= 4)
 583       {
 584         d[0] = s[0];
 585         d[1] = s[1];
 586         d[2] = s[2];
 587         d[3] = s[3];
 588         n_copy -= 4;
 589         s += 4;
 590         d += 4;
 591       }
 592
 593     while (n_copy >= 1)
 594       {
 595         d[0] = s[0];
 596         n_copy -= 1;
 597         s += 1;
 598         d += 1;
 599       }
 600
 601     dst = (void *) d;
 602   }
 603
 604   /* Unaligned copy. */
 605   ASSERT (n_unaligned_end == n_left);
 606   while (n_left > 0)
 607     {
 608       *dst++ = *u_src--;
 609       n_left--;
 610       u_len--;
 611     }
 612
 613   if (! free_list->unaligned_buffers)
 614     ASSERT (u_len == 0);
 615   else
 616     _vec_len (free_list->unaligned_buffers) = u_len;
 617
 618   return n_alloc_buffers;
 619 }
 620
 621 /* Allocate a given number of buffers into given array.
 622    Returns number actually allocated which will be either zero or
 623    number requested. */
 624 u32 vlib_buffer_alloc (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
 625 {
 626   vlib_buffer_main_t * bm = vm->buffer_main;
 627
 628   return alloc_from_free_list
 629     (vm,
 630      pool_elt_at_index (bm->buffer_free_list_pool,
 631                         VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX),
 632      buffers, n_buffers);
 633 }
 634
 635 u32 vlib_buffer_alloc_from_free_list (vlib_main_t * vm,
 636                                       u32 * buffers,
 637                                       u32 n_buffers,
 638                                       u32 free_list_index)
 639 {
 640   vlib_buffer_main_t * bm = vm->buffer_main;
 641   vlib_buffer_free_list_t * f;
 642   f = pool_elt_at_index (bm->buffer_free_list_pool, free_list_index);
 643   return alloc_from_free_list (vm, f, buffers, n_buffers);
 644 }
 645
 646 always_inline void
 647 add_buffer_to_free_list (vlib_main_t * vm,
 648                          vlib_buffer_free_list_t * f,
 649                          u32 buffer_index, u8 do_init)
 650 {
 651   vlib_buffer_t * b;
 652   b = vlib_get_buffer (vm, buffer_index);
 653   if (PREDICT_TRUE(do_init))
 654       vlib_buffer_init_for_free_list (b, f);
 655   vec_add1_aligned (f->aligned_buffers, buffer_index, sizeof (vlib_copy_unit_t));
 656 }
 657
 658 always_inline vlib_buffer_free_list_t *
 659 buffer_get_free_list (vlib_main_t * vm, vlib_buffer_t * b, u32 * index)
 660 {
 661   vlib_buffer_main_t * bm = vm->buffer_main;
 662   u32 i;
 663
 664   *index = i = b->free_list_index;
 665   return pool_elt_at_index (bm->buffer_free_list_pool, i);
 666 }
 667
 668 void *vlib_set_buffer_free_callback (vlib_main_t *vm, void *fp)
 669 {
 670   vlib_buffer_main_t * bm = vm->buffer_main;
 671   void * rv = bm->buffer_free_callback;
 672
 673   bm->buffer_free_callback = fp;
 674   return rv;
 675 }
 676
 677 static_always_inline void
 678 vlib_buffer_free_inline (vlib_main_t * vm,
 679                          u32 * buffers,
 680                          u32 n_buffers,
 681                          u32 follow_buffer_next)
 682 {
 683   vlib_buffer_main_t * bm = vm->buffer_main;
 684   vlib_buffer_free_list_t * fl;
 685   u32 fi;
 686   int i;
 687   u32 (*cb)(vlib_main_t * vm, u32 * buffers, u32 n_buffers,
 688             u32 follow_buffer_next);
 689
 690   cb = bm->buffer_free_callback;
 691
 692   if (PREDICT_FALSE (cb != 0))
 693     n_buffers = (*cb)(vm, buffers, n_buffers, follow_buffer_next);
 694
 695   if (! n_buffers)
 696     return;
 697
 698   for (i = 0; i < n_buffers; i++)
 699     {
 700       vlib_buffer_t * b;
 701       struct rte_mbuf * mb;
 702
 703       b = vlib_get_buffer (vm, buffers[i]);
 704
 705       fl = buffer_get_free_list (vm, b, &fi);
 706
 707       /* The only current use of this callback: multicast recycle */
 708       if (PREDICT_FALSE (fl->buffers_added_to_freelist_function != 0))
 709         {
 710           int j;
 711
 712           add_buffer_to_free_list (vm, fl, buffers[i], b->clone_count == 0);
 713
 714           for (j = 0; j < vec_len (bm->announce_list); j++)
 715             {
 716               if (fl == bm->announce_list[j])
 717                 goto already_announced;
 718             }
 719           vec_add1 (bm->announce_list, fl);
 720         already_announced:
 721           ;
 722         }
 723       else
 724         {
 725           mb = ((struct rte_mbuf *)b)-1;
 726           rte_pktmbuf_free (mb);
 727         }
 728     }
 729   if (vec_len(bm->announce_list))
 730     {
 731       vlib_buffer_free_list_t * fl;
 732       for (i = 0; i < vec_len (bm->announce_list); i++)
 733         {
 734           fl = bm->announce_list[i];
 735           fl->buffers_added_to_freelist_function (vm, fl);
 736         }
 737       _vec_len(bm->announce_list) = 0;
 738     }
 739 }
 740
 741 void vlib_buffer_free (vlib_main_t * vm,
 742                        u32 * buffers,
 743                        u32 n_buffers)
 744 {
 745   vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */ 1);
 746 }
 747
 748 void vlib_buffer_free_no_next (vlib_main_t * vm,
 749                                u32 * buffers,
 750                                u32 n_buffers)
 751 {
 752   vlib_buffer_free_inline (vm, buffers, n_buffers, /* follow_buffer_next */ 0);
 753 }
 754
 755 /* Copy template packet data into buffers as they are allocated. */
 756 __attribute__((unused)) static void
 757 vlib_packet_template_buffer_init (vlib_main_t * vm,
 758                                   vlib_buffer_free_list_t * fl,
 759                                   u32 * buffers,
 760                                   u32 n_buffers)
 761 {
 762   vlib_packet_template_t * t = uword_to_pointer (fl->buffer_init_function_opaque,
 763                                                  vlib_packet_template_t *);
 764   uword i;
 765
 766   for (i = 0; i < n_buffers; i++)
 767     {
 768       vlib_buffer_t * b = vlib_get_buffer (vm, buffers[i]);
 769       ASSERT (b->current_length == vec_len (t->packet_data));
 770       memcpy (vlib_buffer_get_current (b), t->packet_data, b->current_length);
 771     }
 772 }
 773
 774 void vlib_packet_template_init (vlib_main_t * vm,
 775                                 vlib_packet_template_t * t,
 776                                 void * packet_data,
 777                                 uword n_packet_data_bytes,
 778                                 uword min_n_buffers_each_physmem_alloc,
 779                                 char * fmt,
 780                                 ...)
 781 {
 782   va_list va;
 783   __attribute__((unused)) u8 * name;
 784
 785   va_start (va, fmt);
 786   name = va_format (0, fmt, &va);
 787   va_end (va);
 788
 789   vlib_worker_thread_barrier_sync(vm);
 790   memset (t, 0, sizeof (t[0]));
 791
 792   vec_add (t->packet_data, packet_data, n_packet_data_bytes);
 793
 794   vlib_worker_thread_barrier_release(vm);
 795 }
 796
 797 void *
 798 vlib_packet_template_get_packet (vlib_main_t * vm,
 799                                  vlib_packet_template_t * t,
 800                                  u32 * bi_result)
 801 {
 802   u32 bi;
 803   vlib_buffer_t * b;
 804
 805   if (vlib_buffer_alloc (vm, &bi, 1) != 1)
 806     return 0;
 807
 808   *bi_result = bi;
 809
 810   b = vlib_get_buffer (vm, bi);
 811   memcpy (vlib_buffer_get_current (b),
 812           t->packet_data, vec_len(t->packet_data));
 813   b->current_length = vec_len(t->packet_data);
 814
 815   /* Fix up mbuf header length fields */
 816   struct rte_mbuf * mb;
 817   mb = ((struct rte_mbuf *)b) - 1;
 818   mb->data_len = b->current_length;
 819   mb->pkt_len = b->current_length;
 820
 821   return b->data;
 822 }
 823
 824 /* Append given data to end of buffer, possibly allocating new buffers. */
 825 u32 vlib_buffer_add_data (vlib_main_t * vm,
 826                           u32 free_list_index,
 827                           u32 buffer_index,
 828                           void * data, u32 n_data_bytes)
 829 {
 830   u32 n_buffer_bytes, n_left, n_left_this_buffer, bi;
 831   vlib_buffer_t * b;
 832   void * d;
 833
 834   bi = buffer_index;
 835   if (bi == 0
 836       && 1 != vlib_buffer_alloc_from_free_list (vm, &bi, 1, free_list_index))
 837     goto out_of_buffers;
 838
 839   d = data;
 840   n_left = n_data_bytes;
 841   n_buffer_bytes = vlib_buffer_free_list_buffer_size (vm, free_list_index);
 842
 843   b = vlib_get_buffer (vm, bi);
 844   b->flags &= ~VLIB_BUFFER_TOTAL_LENGTH_VALID;
 845
 846   /* Get to the end of the chain before we try to append data...*/
 847   while (b->flags & VLIB_BUFFER_NEXT_PRESENT)
 848     b = vlib_get_buffer (vm, b->next_buffer);
 849
 850   while (1)
 851     {
 852       u32 n;
 853
 854       ASSERT (n_buffer_bytes >= b->current_length);
 855       n_left_this_buffer = n_buffer_bytes - (b->current_data + b->current_length);
 856       n = clib_min (n_left_this_buffer, n_left);
 857       memcpy (vlib_buffer_get_current (b) + b->current_length, d, n);
 858       b->current_length += n;
 859       n_left -= n;
 860       if (n_left == 0)
 861         break;
 862
 863       d += n;
 864       if (1 != vlib_buffer_alloc_from_free_list (vm, &b->next_buffer, 1, free_list_index))
 865         goto out_of_buffers;
 866
 867       b->flags |= VLIB_BUFFER_NEXT_PRESENT;
 868
 869       b = vlib_get_buffer (vm, b->next_buffer);
 870     }
 871
 872   return bi;
 873
 874  out_of_buffers:
 875   clib_error ("out of buffers");
 876   return bi;
 877 }
 878
 879 clib_error_t *
 880 vlib_buffer_pool_create(vlib_main_t * vm, unsigned num_mbufs,
 881                         unsigned mbuf_size, unsigned socket_id)
 882 {
 883   vlib_buffer_main_t * bm = vm->buffer_main;
 884   vlib_physmem_main_t * vpm = &vm->physmem_main;
 885   struct rte_mempool * rmp;
 886   uword new_start, new_size;
 887   int i;
 888
 889   if (!rte_mempool_create)
 890     return clib_error_return (0, "not linked with DPDK");
 891
 892   vec_validate_aligned(bm->pktmbuf_pools, socket_id, CLIB_CACHE_LINE_BYTES);
 893
 894   /* pool already exists, nothing to do */
 895   if (bm->pktmbuf_pools[socket_id])
 896     return 0;
 897
 898   u8 * pool_name = format(0, "mbuf_pool_socket%u%c",socket_id, 0);
 899   rmp = rte_mempool_create((char *) pool_name,
 900                            num_mbufs, mbuf_size, 512,
 901                            sizeof(struct rte_pktmbuf_pool_private),
 902                            rte_pktmbuf_pool_init, NULL,
 903                            rte_pktmbuf_init, NULL,
 904                            socket_id, 0);
 905   vec_free(pool_name);
 906
 907   if (rmp)
 908     {
 909       new_start = pointer_to_uword(rmp);
 910       new_size = rmp->elt_va_end - new_start;
 911
 912       if (vpm->virtual.size > 0)
 913         {
 914           ASSERT(new_start != vpm->virtual.start);
 915           if (new_start < vpm->virtual.start)
 916             {
 917               new_size = vpm->virtual.size + vpm->virtual.start - new_start;
 918             }
 919           else
 920             {
 921               new_size += new_start - vpm->virtual.start;
 922               new_start = vpm->virtual.start;
 923             }
 924
 925           /* check if fits into buffer index range */
 926           if (new_size > ( (uword) 1 << (32 + CLIB_LOG2_CACHE_LINE_BYTES)))
 927             rmp = 0;
 928         }
 929     }
 930
 931   if (rmp)
 932     {
 933       bm->pktmbuf_pools[socket_id] = rmp;
 934       vpm->virtual.start = new_start;
 935       vpm->virtual.size = new_size;
 936       vpm->virtual.end = new_start + new_size;
 937       return 0;
 938     }
 939
 940   /* no usable pool for this socket, try to use pool from another one */
 941   for (i = 0; i < vec_len(bm->pktmbuf_pools); i++)
 942     {
 943       if(bm->pktmbuf_pools[i])
 944        {
 945           clib_warning("WARNING: Failed to allocate mempool for CPU socket %u. "
 946                        "Threads running on socket %u will use socket %u mempool.",
 947                        socket_id, socket_id, i);
 948           bm->pktmbuf_pools[socket_id] = bm->pktmbuf_pools[i];
 949           return 0;
 950        }
 951     }
 952
 953   return clib_error_return (0, "failed to allocate mempool on socket %u",
 954                             socket_id);
 955 }
 956
 957
 958 static void vlib_serialize_tx (serialize_main_header_t * m, serialize_stream_t * s)
 959 {
 960   vlib_main_t * vm;
 961   vlib_serialize_buffer_main_t * sm;
 962   uword n, n_bytes_to_write;
 963   vlib_buffer_t * last;
 964
 965   n_bytes_to_write = s->current_buffer_index;
 966   sm = uword_to_pointer (s->data_function_opaque, vlib_serialize_buffer_main_t *);
 967   vm = sm->vlib_main;
 968
 969   ASSERT (sm->tx.max_n_data_bytes_per_chain > 0);
 970   if (serialize_stream_is_end_of_stream (s)
 971       || sm->tx.n_total_data_bytes + n_bytes_to_write > sm->tx.max_n_data_bytes_per_chain)
 972     {
 973       vlib_process_t * p = vlib_get_current_process (vm);
 974
 975       last = vlib_get_buffer (vm, sm->last_buffer);
 976       last->current_length = n_bytes_to_write;
 977
 978       vlib_set_next_frame_buffer (vm, &p->node_runtime, sm->tx.next_index, sm->first_buffer);
 979
 980       sm->first_buffer = sm->last_buffer = ~0;
 981       sm->tx.n_total_data_bytes = 0;
 982     }
 983
 984   else if (n_bytes_to_write == 0 && s->n_buffer_bytes == 0)
 985     {
 986       ASSERT (sm->first_buffer == ~0);
 987       ASSERT (sm->last_buffer == ~0);
 988       n = vlib_buffer_alloc_from_free_list (vm, &sm->first_buffer, 1, sm->tx.free_list_index);
 989       if (n != 1)
 990         serialize_error (m, clib_error_create ("vlib_buffer_alloc_from_free_list fails"));
 991       sm->last_buffer = sm->first_buffer;
 992       s->n_buffer_bytes = vlib_buffer_free_list_buffer_size (vm, sm->tx.free_list_index);
 993     }
 994
 995   if (n_bytes_to_write > 0)
 996     {
 997       vlib_buffer_t * prev = vlib_get_buffer (vm, sm->last_buffer);
 998       n = vlib_buffer_alloc_from_free_list (vm, &sm->last_buffer, 1, sm->tx.free_list_index);
 999       if (n != 1)
1000         serialize_error (m, clib_error_create ("vlib_buffer_alloc_from_free_list fails"));
1001       sm->tx.n_total_data_bytes += n_bytes_to_write;
1002       prev->current_length = n_bytes_to_write;
1003       prev->next_buffer = sm->last_buffer;
1004       prev->flags |= VLIB_BUFFER_NEXT_PRESENT;
1005     }
1006
1007   if (sm->last_buffer != ~0)
1008     {
1009       last = vlib_get_buffer (vm, sm->last_buffer);
1010       s->buffer = vlib_buffer_get_current (last);
1011       s->current_buffer_index = 0;
1012       ASSERT (last->current_data == s->current_buffer_index);
1013     }
1014 }
1015
1016 static void vlib_serialize_rx (serialize_main_header_t * m, serialize_stream_t * s)
1017 {
1018   vlib_main_t * vm;
1019   vlib_serialize_buffer_main_t * sm;
1020   vlib_buffer_t * last;
1021
1022   sm = uword_to_pointer (s->data_function_opaque, vlib_serialize_buffer_main_t *);
1023   vm = sm->vlib_main;
1024
1025   if (serialize_stream_is_end_of_stream (s))
1026     return;
1027
1028   if (sm->last_buffer != ~0)
1029     {
1030       last = vlib_get_buffer (vm, sm->last_buffer);
1031
1032       if (last->flags & VLIB_BUFFER_NEXT_PRESENT)
1033         sm->last_buffer = last->next_buffer;
1034       else
1035         {
1036           vlib_buffer_free (vm, &sm->first_buffer, /* count */ 1);
1037           sm->first_buffer = sm->last_buffer = ~0;
1038         }
1039     }
1040
1041   if (sm->last_buffer == ~0)
1042     {
1043       while (clib_fifo_elts (sm->rx.buffer_fifo) == 0)
1044         {
1045           sm->rx.ready_one_time_event = vlib_process_create_one_time_event (vm, vlib_current_process (vm), ~0);
1046           vlib_process_wait_for_one_time_event (vm, /* no event data */ 0, sm->rx.ready_one_time_event);
1047         }
1048
1049       clib_fifo_sub1 (sm->rx.buffer_fifo, sm->first_buffer);
1050       sm->last_buffer = sm->first_buffer;
1051     }
1052
1053   ASSERT (sm->last_buffer != ~0);
1054
1055   last = vlib_get_buffer (vm, sm->last_buffer);
1056   s->current_buffer_index = 0;
1057   s->buffer = vlib_buffer_get_current (last);
1058   s->n_buffer_bytes = last->current_length;
1059 }
1060
1061 static void
1062 serialize_open_vlib_helper (serialize_main_t * m,
1063                             vlib_main_t * vm,
1064                             vlib_serialize_buffer_main_t * sm,
1065                             uword is_read)
1066 {
1067   /* Initialize serialize main but save overflow buffer for re-use between calls. */
1068   {
1069     u8 * save = m->stream.overflow_buffer;
1070     memset (m, 0, sizeof (m[0]));
1071     m->stream.overflow_buffer = save;
1072     if (save)
1073       _vec_len (save) = 0;
1074   }
1075
1076   sm->first_buffer = sm->last_buffer = ~0;
1077   if (is_read)
1078     clib_fifo_reset (sm->rx.buffer_fifo);
1079   else
1080     sm->tx.n_total_data_bytes = 0;
1081   sm->vlib_main = vm;
1082   m->header.data_function = is_read ? vlib_serialize_rx : vlib_serialize_tx;
1083   m->stream.data_function_opaque = pointer_to_uword (sm);
1084 }
1085
1086 void serialize_open_vlib_buffer (serialize_main_t * m, vlib_main_t * vm, vlib_serialize_buffer_main_t * sm)
1087 { serialize_open_vlib_helper (m, vm, sm, /* is_read */ 0); }
1088
1089 void unserialize_open_vlib_buffer (serialize_main_t * m, vlib_main_t * vm, vlib_serialize_buffer_main_t * sm)
1090 { serialize_open_vlib_helper (m, vm, sm, /* is_read */ 1); }
1091
1092 u32 serialize_close_vlib_buffer (serialize_main_t * m)
1093 {
1094   vlib_serialize_buffer_main_t * sm
1095     = uword_to_pointer (m->stream.data_function_opaque, vlib_serialize_buffer_main_t *);
1096   vlib_buffer_t * last;
1097   serialize_stream_t * s = &m->stream;
1098
1099   last = vlib_get_buffer (sm->vlib_main, sm->last_buffer);
1100   last->current_length = s->current_buffer_index;
1101
1102   if (vec_len (s->overflow_buffer) > 0)
1103     {
1104       sm->last_buffer
1105         = vlib_buffer_add_data (sm->vlib_main, sm->tx.free_list_index,
1106                                 sm->last_buffer == ~0 ? 0 : sm->last_buffer,
1107                                 s->overflow_buffer,
1108                                 vec_len (s->overflow_buffer));
1109       _vec_len (s->overflow_buffer) = 0;
1110     }
1111
1112   return sm->first_buffer;
1113 }
1114
1115 void unserialize_close_vlib_buffer (serialize_main_t * m)
1116 {
1117   vlib_serialize_buffer_main_t * sm
1118     = uword_to_pointer (m->stream.data_function_opaque, vlib_serialize_buffer_main_t *);
1119   if (sm->first_buffer != ~0)
1120     vlib_buffer_free_one (sm->vlib_main, sm->first_buffer);
1121   clib_fifo_reset (sm->rx.buffer_fifo);
1122   if (m->stream.overflow_buffer)
1123     _vec_len (m->stream.overflow_buffer) = 0;
1124 }
1125
1126 static u8 * format_vlib_buffer_free_list (u8 * s, va_list * va)
1127 {
1128   vlib_buffer_free_list_t * f = va_arg (*va, vlib_buffer_free_list_t *);
1129   u32 threadnum= va_arg (*va, u32);
1130   uword bytes_alloc, bytes_free, n_free, size;
1131
1132   if (! f)
1133     return format (s, "%=7s%=30s%=12s%=12s%=12s%=12s%=12s%=12s",
1134                    "Thread", "Name", "Index", "Size", "Alloc", "Free", "#Alloc", "#Free");
1135
1136   size = sizeof (vlib_buffer_t) + f->n_data_bytes;
1137   n_free = vec_len (f->aligned_buffers) + vec_len (f->unaligned_buffers);
1138   bytes_alloc = size * f->n_alloc;
1139   bytes_free = size * n_free;
1140
1141   s = format (s, "%7d%30s%12d%12d%=12U%=12U%=12d%=12d",
1142               threadnum,
1143               f->name, f->index, f->n_data_bytes,
1144               format_memory_size, bytes_alloc,
1145               format_memory_size, bytes_free,
1146               f->n_alloc, n_free);
1147
1148   return s;
1149 }
1150
1151 static clib_error_t *
1152 show_buffers (vlib_main_t * vm,
1153               unformat_input_t * input,
1154               vlib_cli_command_t * cmd)
1155 {
1156   vlib_buffer_main_t * bm;
1157   vlib_buffer_free_list_t * f;
1158   vlib_main_t *curr_vm;
1159   u32 vm_index = 0;
1160
1161   vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, 0, 0);
1162
1163   do {
1164     curr_vm = vec_len(vlib_mains) ? vlib_mains[vm_index] : vm;
1165     bm = curr_vm->buffer_main;
1166
1167     pool_foreach (f, bm->buffer_free_list_pool, ({
1168       vlib_cli_output (vm, "%U", format_vlib_buffer_free_list, f, vm_index);
1169     }));
1170
1171     vm_index++;
1172   } while (vm_index < vec_len(vlib_mains));
1173
1174   return 0;
1175 }
1176
1177 VLIB_CLI_COMMAND (show_buffers_command, static) = {
1178   .path = "show buffers",
1179   .short_help = "Show packet buffer allocation",
1180   .function = show_buffers,
1181 };
1182
1183 #if CLIB_DEBUG > 0
1184
1185 u32 * vlib_buffer_state_validation_lock;
1186 uword * vlib_buffer_state_validation_hash;
1187 void * vlib_buffer_state_heap;
1188
1189 static clib_error_t *
1190 buffer_state_validation_init (vlib_main_t * vm)
1191 {
1192   void * oldheap;
1193
1194   vlib_buffer_state_heap = mheap_alloc (0, 10<<20);
1195
1196   oldheap = clib_mem_set_heap (vlib_buffer_state_heap);
1197
1198   vlib_buffer_state_validation_hash = hash_create (0, sizeof(uword));
1199   vec_validate_aligned (vlib_buffer_state_validation_lock, 0,
1200                         CLIB_CACHE_LINE_BYTES);
1201   clib_mem_set_heap (oldheap);
1202   return 0;
1203 }
1204
1205 VLIB_INIT_FUNCTION (buffer_state_validation_init);
1206 #endif