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