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