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