src/plugins/dpdk/buffer.c

   1 /*
   2  * Copyright (c) 2017 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 <rte_config.h>
  47
  48 #include <rte_common.h>
  49 #include <rte_log.h>
  50 #include <rte_memory.h>
  51 #include <rte_memzone.h>
  52 #include <rte_tailq.h>
  53 #include <rte_eal.h>
  54 #include <rte_per_lcore.h>
  55 #include <rte_launch.h>
  56 #include <rte_atomic.h>
  57 #include <rte_cycles.h>
  58 #include <rte_prefetch.h>
  59 #include <rte_lcore.h>
  60 #include <rte_per_lcore.h>
  61 #include <rte_branch_prediction.h>
  62 #include <rte_interrupts.h>
  63 #include <rte_pci.h>
  64 #include <rte_random.h>
  65 #include <rte_debug.h>
  66 #include <rte_ether.h>
  67 #include <rte_ethdev.h>
  68 #include <rte_ring.h>
  69 #include <rte_mempool.h>
  70 #include <rte_mbuf.h>
  71 #include <rte_version.h>
  72
  73 #include <vlib/vlib.h>
  74 #include <vnet/vnet.h>
  75 #include <dpdk/device/dpdk.h>
  76 #include <dpdk/device/dpdk_priv.h>
  77
  78
  79 STATIC_ASSERT (VLIB_BUFFER_PRE_DATA_SIZE == RTE_PKTMBUF_HEADROOM,
  80                "VLIB_BUFFER_PRE_DATA_SIZE must be equal to RTE_PKTMBUF_HEADROOM");
  81
  82 static_always_inline void
  83 dpdk_rte_pktmbuf_free (vlib_main_t * vm, vlib_buffer_t * b)
  84 {
  85   vlib_buffer_t *hb = b;
  86   struct rte_mbuf *mb;
  87   u32 next, flags;
  88   mb = rte_mbuf_from_vlib_buffer (hb);
  89
  90 next:
  91   flags = b->flags;
  92   next = b->next_buffer;
  93   mb = rte_mbuf_from_vlib_buffer (b);
  94
  95   if (PREDICT_FALSE (b->n_add_refs))
  96     {
  97       rte_mbuf_refcnt_update (mb, b->n_add_refs);
  98       b->n_add_refs = 0;
  99     }
 100
 101   rte_pktmbuf_free_seg (mb);
 102
 103   if (flags & VLIB_BUFFER_NEXT_PRESENT)
 104     {
 105       b = vlib_get_buffer (vm, next);
 106       goto next;
 107     }
 108 }
 109
 110 static void
 111 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
 112 {
 113   u32 i;
 114   vlib_buffer_t *b;
 115
 116   for (i = 0; i < vec_len (f->buffers); i++)
 117     {
 118       b = vlib_get_buffer (vm, f->buffers[i]);
 119       dpdk_rte_pktmbuf_free (vm, b);
 120     }
 121
 122   vec_free (f->name);
 123   vec_free (f->buffers);
 124 }
 125
 126 /* Add buffer free list. */
 127 static void
 128 dpdk_buffer_delete_free_list (vlib_main_t * vm, u32 free_list_index)
 129 {
 130   vlib_buffer_main_t *bm = vm->buffer_main;
 131   vlib_buffer_free_list_t *f;
 132   u32 merge_index;
 133   int i;
 134
 135   ASSERT (vlib_get_thread_index () == 0);
 136
 137   f = vlib_buffer_get_free_list (vm, free_list_index);
 138
 139   merge_index = vlib_buffer_get_free_list_with_size (vm, f->n_data_bytes);
 140   if (merge_index != ~0 && merge_index != free_list_index)
 141     {
 142       vlib_buffer_merge_free_lists (pool_elt_at_index
 143                                     (bm->buffer_free_list_pool, merge_index),
 144                                     f);
 145     }
 146
 147   del_free_list (vm, f);
 148
 149   /* Poison it. */
 150   memset (f, 0xab, sizeof (f[0]));
 151
 152   pool_put (bm->buffer_free_list_pool, f);
 153
 154   for (i = 1; i < vec_len (vlib_mains); i++)
 155     {
 156       bm = vlib_mains[i]->buffer_main;
 157       f = vlib_buffer_get_free_list (vlib_mains[i], free_list_index);;
 158       memset (f, 0xab, sizeof (f[0]));
 159       pool_put (bm->buffer_free_list_pool, f);
 160     }
 161 }
 162
 163 /* Make sure free list has at least given number of free buffers. */
 164 static uword
 165 fill_free_list (vlib_main_t * vm,
 166                 vlib_buffer_free_list_t * fl, uword min_free_buffers)
 167 {
 168   dpdk_main_t *dm = &dpdk_main;
 169   vlib_buffer_t *b0, *b1, *b2, *b3;
 170   int n, i;
 171   u32 bi0, bi1, bi2, bi3;
 172   unsigned socket_id = rte_socket_id ();
 173   struct rte_mempool *rmp = dm->pktmbuf_pools[socket_id];
 174   struct rte_mbuf *mb0, *mb1, *mb2, *mb3;
 175
 176   /* Too early? */
 177   if (PREDICT_FALSE (rmp == 0))
 178     return 0;
 179
 180   /* Already have enough free buffers on free list? */
 181   n = min_free_buffers - vec_len (fl->buffers);
 182   if (n <= 0)
 183     return min_free_buffers;
 184
 185   /* Always allocate round number of buffers. */
 186   n = round_pow2 (n, CLIB_CACHE_LINE_BYTES / sizeof (u32));
 187
 188   /* Always allocate new buffers in reasonably large sized chunks. */
 189   n = clib_max (n, fl->min_n_buffers_each_physmem_alloc);
 190
 191   vec_validate (vm->mbuf_alloc_list, n - 1);
 192
 193   if (rte_mempool_get_bulk (rmp, vm->mbuf_alloc_list, n) < 0)
 194     return 0;
 195
 196   _vec_len (vm->mbuf_alloc_list) = n;
 197
 198   i = 0;
 199
 200   while (i < (n - 7))
 201     {
 202       vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf
 203                                    (vm->mbuf_alloc_list[i + 4]), STORE);
 204       vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf
 205                                    (vm->mbuf_alloc_list[i + 5]), STORE);
 206       vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf
 207                                    (vm->mbuf_alloc_list[i + 6]), STORE);
 208       vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf
 209                                    (vm->mbuf_alloc_list[i + 7]), STORE);
 210
 211       mb0 = vm->mbuf_alloc_list[i];
 212       mb1 = vm->mbuf_alloc_list[i + 1];
 213       mb2 = vm->mbuf_alloc_list[i + 2];
 214       mb3 = vm->mbuf_alloc_list[i + 3];
 215
 216 #if RTE_VERSION < RTE_VERSION_NUM(17, 5, 0, 0)
 217       ASSERT (rte_mbuf_refcnt_read (mb0) == 0);
 218       ASSERT (rte_mbuf_refcnt_read (mb1) == 0);
 219       ASSERT (rte_mbuf_refcnt_read (mb2) == 0);
 220       ASSERT (rte_mbuf_refcnt_read (mb3) == 0);
 221
 222       rte_mbuf_refcnt_set (mb0, 1);
 223       rte_mbuf_refcnt_set (mb1, 1);
 224       rte_mbuf_refcnt_set (mb2, 1);
 225       rte_mbuf_refcnt_set (mb3, 1);
 226 #endif
 227
 228       b0 = vlib_buffer_from_rte_mbuf (mb0);
 229       b1 = vlib_buffer_from_rte_mbuf (mb1);
 230       b2 = vlib_buffer_from_rte_mbuf (mb2);
 231       b3 = vlib_buffer_from_rte_mbuf (mb3);
 232
 233       bi0 = vlib_get_buffer_index (vm, b0);
 234       bi1 = vlib_get_buffer_index (vm, b1);
 235       bi2 = vlib_get_buffer_index (vm, b2);
 236       bi3 = vlib_get_buffer_index (vm, b3);
 237
 238       vec_add1_aligned (fl->buffers, bi0, CLIB_CACHE_LINE_BYTES);
 239       vec_add1_aligned (fl->buffers, bi1, CLIB_CACHE_LINE_BYTES);
 240       vec_add1_aligned (fl->buffers, bi2, CLIB_CACHE_LINE_BYTES);
 241       vec_add1_aligned (fl->buffers, bi3, CLIB_CACHE_LINE_BYTES);
 242
 243       vlib_buffer_init_for_free_list (b0, fl);
 244       vlib_buffer_init_for_free_list (b1, fl);
 245       vlib_buffer_init_for_free_list (b2, fl);
 246       vlib_buffer_init_for_free_list (b3, fl);
 247
 248       if (fl->buffer_init_function)
 249         {
 250           fl->buffer_init_function (vm, fl, &bi0, 1);
 251           fl->buffer_init_function (vm, fl, &bi1, 1);
 252           fl->buffer_init_function (vm, fl, &bi2, 1);
 253           fl->buffer_init_function (vm, fl, &bi3, 1);
 254         }
 255       i += 4;
 256     }
 257
 258   while (i < n)
 259     {
 260       mb0 = vm->mbuf_alloc_list[i];
 261
 262 #if RTE_VERSION < RTE_VERSION_NUM(17, 5, 0, 0)
 263       ASSERT (rte_mbuf_refcnt_read (mb0) == 0);
 264       rte_mbuf_refcnt_set (mb0, 1);
 265 #endif
 266
 267       b0 = vlib_buffer_from_rte_mbuf (mb0);
 268       bi0 = vlib_get_buffer_index (vm, b0);
 269
 270       vec_add1_aligned (fl->buffers, bi0, CLIB_CACHE_LINE_BYTES);
 271
 272       vlib_buffer_init_for_free_list (b0, fl);
 273
 274       if (fl->buffer_init_function)
 275         fl->buffer_init_function (vm, fl, &bi0, 1);
 276       i++;
 277     }
 278
 279   fl->n_alloc += n;
 280
 281   return n;
 282 }
 283
 284 static u32
 285 alloc_from_free_list (vlib_main_t * vm,
 286                       vlib_buffer_free_list_t * free_list,
 287                       u32 * alloc_buffers, u32 n_alloc_buffers)
 288 {
 289   u32 *dst, *src;
 290   uword len, n_filled;
 291
 292   dst = alloc_buffers;
 293
 294   n_filled = fill_free_list (vm, free_list, n_alloc_buffers);
 295   if (n_filled == 0)
 296     return 0;
 297
 298   len = vec_len (free_list->buffers);
 299   ASSERT (len >= n_alloc_buffers);
 300
 301   src = free_list->buffers + len - n_alloc_buffers;
 302   clib_memcpy (dst, src, n_alloc_buffers * sizeof (u32));
 303
 304   _vec_len (free_list->buffers) -= n_alloc_buffers;
 305
 306   return n_alloc_buffers;
 307 }
 308
 309 /* Allocate a given number of buffers into given array.
 310    Returns number actually allocated which will be either zero or
 311    number requested. */
 312 u32
 313 dpdk_buffer_alloc (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
 314 {
 315   vlib_buffer_main_t *bm = vm->buffer_main;
 316
 317   return alloc_from_free_list
 318     (vm,
 319      pool_elt_at_index (bm->buffer_free_list_pool,
 320                         VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX),
 321      buffers, n_buffers);
 322 }
 323
 324
 325 u32
 326 dpdk_buffer_alloc_from_free_list (vlib_main_t * vm,
 327                                   u32 * buffers,
 328                                   u32 n_buffers, u32 free_list_index)
 329 {
 330   vlib_buffer_main_t *bm = vm->buffer_main;
 331   vlib_buffer_free_list_t *f;
 332   f = pool_elt_at_index (bm->buffer_free_list_pool, free_list_index);
 333   return alloc_from_free_list (vm, f, buffers, n_buffers);
 334 }
 335
 336 static_always_inline void
 337 vlib_buffer_free_inline (vlib_main_t * vm,
 338                          u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
 339 {
 340   vlib_buffer_main_t *bm = vm->buffer_main;
 341   vlib_buffer_free_list_t *fl;
 342   u32 fi;
 343   int i;
 344   u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
 345              u32 follow_buffer_next);
 346
 347   cb = bm->buffer_free_callback;
 348
 349   if (PREDICT_FALSE (cb != 0))
 350     n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
 351
 352   if (!n_buffers)
 353     return;
 354
 355   for (i = 0; i < n_buffers; i++)
 356     {
 357       vlib_buffer_t *b;
 358
 359       b = vlib_get_buffer (vm, buffers[i]);
 360
 361       fl = vlib_buffer_get_buffer_free_list (vm, b, &fi);
 362
 363       /* The only current use of this callback: multicast recycle */
 364       if (PREDICT_FALSE (fl->buffers_added_to_freelist_function != 0))
 365         {
 366           int j;
 367
 368           vlib_buffer_add_to_free_list
 369             (vm, fl, buffers[i], (b->flags & VLIB_BUFFER_RECYCLE) == 0);
 370
 371           for (j = 0; j < vec_len (bm->announce_list); j++)
 372             {
 373               if (fl == bm->announce_list[j])
 374                 goto already_announced;
 375             }
 376           vec_add1 (bm->announce_list, fl);
 377         already_announced:
 378           ;
 379         }
 380       else
 381         {
 382           if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_RECYCLE) == 0))
 383             dpdk_rte_pktmbuf_free (vm, b);
 384         }
 385     }
 386   if (vec_len (bm->announce_list))
 387     {
 388       vlib_buffer_free_list_t *fl;
 389       for (i = 0; i < vec_len (bm->announce_list); i++)
 390         {
 391           fl = bm->announce_list[i];
 392           fl->buffers_added_to_freelist_function (vm, fl);
 393         }
 394       _vec_len (bm->announce_list) = 0;
 395     }
 396 }
 397
 398 static void
 399 dpdk_buffer_free (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
 400 {
 401   vlib_buffer_free_inline (vm, buffers, n_buffers,      /* follow_buffer_next */
 402                            1);
 403 }
 404
 405 static void
 406 dpdk_buffer_free_no_next (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
 407 {
 408   vlib_buffer_free_inline (vm, buffers, n_buffers,      /* follow_buffer_next */
 409                            0);
 410 }
 411
 412 static void
 413 dpdk_packet_template_init (vlib_main_t * vm,
 414                            void *vt,
 415                            void *packet_data,
 416                            uword n_packet_data_bytes,
 417                            uword min_n_buffers_each_physmem_alloc, u8 * name)
 418 {
 419   vlib_packet_template_t *t = (vlib_packet_template_t *) vt;
 420
 421   vlib_worker_thread_barrier_sync (vm);
 422   memset (t, 0, sizeof (t[0]));
 423
 424   vec_add (t->packet_data, packet_data, n_packet_data_bytes);
 425
 426   vlib_worker_thread_barrier_release (vm);
 427 }
 428
 429 clib_error_t *
 430 dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
 431                          unsigned socket_id)
 432 {
 433   dpdk_main_t *dm = &dpdk_main;
 434   struct rte_mempool *rmp;
 435   int i;
 436
 437   vec_validate_aligned (dm->pktmbuf_pools, socket_id, CLIB_CACHE_LINE_BYTES);
 438
 439   /* pool already exists, nothing to do */
 440   if (dm->pktmbuf_pools[socket_id])
 441     return 0;
 442
 443   u8 *pool_name = format (0, "mbuf_pool_socket%u%c", socket_id, 0);
 444
 445   rmp = rte_pktmbuf_pool_create ((char *) pool_name,    /* pool name */
 446                                  num_mbufs,     /* number of mbufs */
 447                                  512,   /* cache size */
 448                                  VLIB_BUFFER_HDR_SIZE,  /* priv size */
 449                                  VLIB_BUFFER_PRE_DATA_SIZE + VLIB_BUFFER_DATA_SIZE,     /* dataroom size */
 450                                  socket_id);    /* cpu socket */
 451
 452   if (rmp)
 453     {
 454       {
 455         struct rte_mempool_memhdr *memhdr;
 456
 457         STAILQ_FOREACH (memhdr, &rmp->mem_list, next)
 458           vlib_buffer_add_mem_range (vm, (uword) memhdr->addr, memhdr->len);
 459       }
 460       if (rmp)
 461         {
 462           dm->pktmbuf_pools[socket_id] = rmp;
 463           vec_free (pool_name);
 464           return 0;
 465         }
 466     }
 467
 468   vec_free (pool_name);
 469
 470   /* no usable pool for this socket, try to use pool from another one */
 471   for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
 472     {
 473       if (dm->pktmbuf_pools[i])
 474         {
 475           clib_warning
 476             ("WARNING: Failed to allocate mempool for CPU socket %u. "
 477              "Threads running on socket %u will use socket %u mempool.",
 478              socket_id, socket_id, i);
 479           dm->pktmbuf_pools[socket_id] = dm->pktmbuf_pools[i];
 480           return 0;
 481         }
 482     }
 483
 484   return clib_error_return (0, "failed to allocate mempool on socket %u",
 485                             socket_id);
 486 }
 487
 488 #if CLIB_DEBUG > 0
 489
 490 u32 *vlib_buffer_state_validation_lock;
 491 uword *vlib_buffer_state_validation_hash;
 492 void *vlib_buffer_state_heap;
 493
 494 static clib_error_t *
 495 buffer_state_validation_init (vlib_main_t * vm)
 496 {
 497   void *oldheap;
 498
 499   vlib_buffer_state_heap = mheap_alloc (0, 10 << 20);
 500
 501   oldheap = clib_mem_set_heap (vlib_buffer_state_heap);
 502
 503   vlib_buffer_state_validation_hash = hash_create (0, sizeof (uword));
 504   vec_validate_aligned (vlib_buffer_state_validation_lock, 0,
 505                         CLIB_CACHE_LINE_BYTES);
 506   clib_mem_set_heap (oldheap);
 507   return 0;
 508 }
 509
 510 VLIB_INIT_FUNCTION (buffer_state_validation_init);
 511 #endif
 512
 513 /* *INDENT-OFF* */
 514 VLIB_BUFFER_REGISTER_CALLBACKS (dpdk, static) = {
 515   .vlib_buffer_alloc_cb = &dpdk_buffer_alloc,
 516   .vlib_buffer_alloc_from_free_list_cb = &dpdk_buffer_alloc_from_free_list,
 517   .vlib_buffer_free_cb = &dpdk_buffer_free,
 518   .vlib_buffer_free_no_next_cb = &dpdk_buffer_free_no_next,
 519   .vlib_packet_template_init_cb = &dpdk_packet_template_init,
 520   .vlib_buffer_delete_free_list_cb = &dpdk_buffer_delete_free_list,
 521 };
 522 /* *INDENT-ON* */
 523
 524 /** @endcond */
 525 /*
 526  * fd.io coding-style-patch-verification: ON
 527  *
 528  * Local Variables:
 529  * eval: (c-set-style "gnu")
 530  * End:
 531  */