dpdk: use vpp physmem allocator for dpdk buffers
[vpp.git] / 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       b0 = vlib_buffer_from_rte_mbuf (mb0);
217       b1 = vlib_buffer_from_rte_mbuf (mb1);
218       b2 = vlib_buffer_from_rte_mbuf (mb2);
219       b3 = vlib_buffer_from_rte_mbuf (mb3);
220
221       bi0 = vlib_get_buffer_index (vm, b0);
222       bi1 = vlib_get_buffer_index (vm, b1);
223       bi2 = vlib_get_buffer_index (vm, b2);
224       bi3 = vlib_get_buffer_index (vm, b3);
225
226       vec_add1_aligned (fl->buffers, bi0, CLIB_CACHE_LINE_BYTES);
227       vec_add1_aligned (fl->buffers, bi1, CLIB_CACHE_LINE_BYTES);
228       vec_add1_aligned (fl->buffers, bi2, CLIB_CACHE_LINE_BYTES);
229       vec_add1_aligned (fl->buffers, bi3, CLIB_CACHE_LINE_BYTES);
230
231       vlib_buffer_init_for_free_list (b0, fl);
232       vlib_buffer_init_for_free_list (b1, fl);
233       vlib_buffer_init_for_free_list (b2, fl);
234       vlib_buffer_init_for_free_list (b3, fl);
235
236       if (fl->buffer_init_function)
237         {
238           fl->buffer_init_function (vm, fl, &bi0, 1);
239           fl->buffer_init_function (vm, fl, &bi1, 1);
240           fl->buffer_init_function (vm, fl, &bi2, 1);
241           fl->buffer_init_function (vm, fl, &bi3, 1);
242         }
243       i += 4;
244     }
245
246   while (i < n)
247     {
248       mb0 = vm->mbuf_alloc_list[i];
249
250       b0 = vlib_buffer_from_rte_mbuf (mb0);
251       bi0 = vlib_get_buffer_index (vm, b0);
252
253       vec_add1_aligned (fl->buffers, bi0, CLIB_CACHE_LINE_BYTES);
254
255       vlib_buffer_init_for_free_list (b0, fl);
256
257       if (fl->buffer_init_function)
258         fl->buffer_init_function (vm, fl, &bi0, 1);
259       i++;
260     }
261
262   fl->n_alloc += n;
263
264   return n;
265 }
266
267 static u32
268 alloc_from_free_list (vlib_main_t * vm,
269                       vlib_buffer_free_list_t * free_list,
270                       u32 * alloc_buffers, u32 n_alloc_buffers)
271 {
272   u32 *dst, *src;
273   uword len, n_filled;
274
275   dst = alloc_buffers;
276
277   n_filled = fill_free_list (vm, free_list, n_alloc_buffers);
278   if (n_filled == 0)
279     return 0;
280
281   len = vec_len (free_list->buffers);
282   ASSERT (len >= n_alloc_buffers);
283
284   src = free_list->buffers + len - n_alloc_buffers;
285   clib_memcpy (dst, src, n_alloc_buffers * sizeof (u32));
286
287   _vec_len (free_list->buffers) -= n_alloc_buffers;
288
289   return n_alloc_buffers;
290 }
291
292 /* Allocate a given number of buffers into given array.
293    Returns number actually allocated which will be either zero or
294    number requested. */
295 u32
296 dpdk_buffer_alloc (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
297 {
298   vlib_buffer_main_t *bm = vm->buffer_main;
299
300   return alloc_from_free_list
301     (vm,
302      pool_elt_at_index (bm->buffer_free_list_pool,
303                         VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX),
304      buffers, n_buffers);
305 }
306
307
308 u32
309 dpdk_buffer_alloc_from_free_list (vlib_main_t * vm,
310                                   u32 * buffers,
311                                   u32 n_buffers, u32 free_list_index)
312 {
313   vlib_buffer_main_t *bm = vm->buffer_main;
314   vlib_buffer_free_list_t *f;
315   f = pool_elt_at_index (bm->buffer_free_list_pool, free_list_index);
316   return alloc_from_free_list (vm, f, buffers, n_buffers);
317 }
318
319 static_always_inline void
320 vlib_buffer_free_inline (vlib_main_t * vm,
321                          u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
322 {
323   vlib_buffer_main_t *bm = vm->buffer_main;
324   vlib_buffer_free_list_t *fl;
325   u32 fi;
326   int i;
327   u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
328              u32 follow_buffer_next);
329
330   cb = bm->buffer_free_callback;
331
332   if (PREDICT_FALSE (cb != 0))
333     n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
334
335   if (!n_buffers)
336     return;
337
338   for (i = 0; i < n_buffers; i++)
339     {
340       vlib_buffer_t *b;
341
342       b = vlib_get_buffer (vm, buffers[i]);
343       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b);
344       fl = vlib_buffer_get_buffer_free_list (vm, b, &fi);
345
346       /* The only current use of this callback: multicast recycle */
347       if (PREDICT_FALSE (fl->buffers_added_to_freelist_function != 0))
348         {
349           int j;
350
351           vlib_buffer_add_to_free_list
352             (vm, fl, buffers[i], (b->flags & VLIB_BUFFER_RECYCLE) == 0);
353
354           for (j = 0; j < vec_len (bm->announce_list); j++)
355             {
356               if (fl == bm->announce_list[j])
357                 goto already_announced;
358             }
359           vec_add1 (bm->announce_list, fl);
360         already_announced:
361           ;
362         }
363       else
364         {
365           if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_RECYCLE) == 0))
366             dpdk_rte_pktmbuf_free (vm, b);
367         }
368     }
369   if (vec_len (bm->announce_list))
370     {
371       vlib_buffer_free_list_t *fl;
372       for (i = 0; i < vec_len (bm->announce_list); i++)
373         {
374           fl = bm->announce_list[i];
375           fl->buffers_added_to_freelist_function (vm, fl);
376         }
377       _vec_len (bm->announce_list) = 0;
378     }
379 }
380
381 static void
382 dpdk_buffer_free (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
383 {
384   vlib_buffer_free_inline (vm, buffers, n_buffers,      /* follow_buffer_next */
385                            1);
386 }
387
388 static void
389 dpdk_buffer_free_no_next (vlib_main_t * vm, u32 * buffers, u32 n_buffers)
390 {
391   vlib_buffer_free_inline (vm, buffers, n_buffers,      /* follow_buffer_next */
392                            0);
393 }
394
395 static void
396 dpdk_packet_template_init (vlib_main_t * vm,
397                            void *vt,
398                            void *packet_data,
399                            uword n_packet_data_bytes,
400                            uword min_n_buffers_each_physmem_alloc, u8 * name)
401 {
402   vlib_packet_template_t *t = (vlib_packet_template_t *) vt;
403
404   vlib_worker_thread_barrier_sync (vm);
405   memset (t, 0, sizeof (t[0]));
406
407   vec_add (t->packet_data, packet_data, n_packet_data_bytes);
408
409   vlib_worker_thread_barrier_release (vm);
410 }
411
412 typedef struct
413 {
414   /* must be first */
415   struct rte_pktmbuf_pool_private mbp_priv;
416   vlib_physmem_region_index_t region_index;
417 } dpdk_mempool_private_t;
418
419 clib_error_t *
420 dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
421                          unsigned socket_id)
422 {
423   dpdk_main_t *dm = &dpdk_main;
424   struct rte_mempool *rmp;
425   dpdk_mempool_private_t priv;
426   vlib_physmem_region_t *pr;
427   vlib_physmem_region_index_t pri;
428   u8 *pool_name;
429   unsigned elt_size;
430   u32 size;
431   i32 i, ret;
432
433   vec_validate_aligned (dm->pktmbuf_pools, socket_id, CLIB_CACHE_LINE_BYTES);
434
435   /* pool already exists, nothing to do */
436   if (dm->pktmbuf_pools[socket_id])
437     return 0;
438
439   pool_name = format (0, "dpdk_mbuf_pool_socket%u%c", socket_id, 0);
440
441   elt_size = sizeof (struct rte_mbuf) +
442     VLIB_BUFFER_HDR_SIZE /* priv size */  +
443     VLIB_BUFFER_PRE_DATA_SIZE + VLIB_BUFFER_DATA_SIZE;  /*data room size */
444
445   size = rte_mempool_xmem_size (num_mbufs, elt_size, 21);
446
447   clib_error_t *error = 0;
448   error =
449     vlib_physmem_region_alloc (vm, (char *) pool_name, size, socket_id,
450                                VLIB_PHYSMEM_F_HAVE_BUFFERS, &pri);
451   if (error)
452     clib_error_report (error);
453
454   pr = vlib_physmem_get_region (vm, pri);
455
456   priv.mbp_priv.mbuf_data_room_size = VLIB_BUFFER_PRE_DATA_SIZE +
457     VLIB_BUFFER_DATA_SIZE;
458   priv.mbp_priv.mbuf_priv_size = VLIB_BUFFER_HDR_SIZE;
459
460 #if 0
461   /* Check that pg_shift parameter is valid. */
462   if (pg_shift > MEMPOOL_PG_SHIFT_MAX)
463     {
464       rte_errno = EINVAL;
465       return NULL;
466     }
467 #endif
468   rmp = rte_mempool_create_empty ((char *) pool_name,   /* pool name */
469                                   num_mbufs,    /* number of mbufs */
470                                   elt_size, 512,        /* cache size */
471                                   sizeof (dpdk_mempool_private_t),      /* private data size */
472                                   socket_id, 0);        /* flags */
473   if (rmp)
474     {
475       rte_mempool_set_ops_byname (rmp, RTE_MBUF_DEFAULT_MEMPOOL_OPS, NULL);
476
477       /* call the mempool priv initializer */
478       rte_pktmbuf_pool_init (rmp, &priv);
479
480       ret = rte_mempool_populate_phys_tab (rmp, pr->mem, pr->page_table,
481                                            pr->n_pages, pr->log2_page_size,
482                                            NULL, NULL);
483       if (ret == (i32) rmp->size)
484         {
485           /* call the object initializers */
486           rte_mempool_obj_iter (rmp, rte_pktmbuf_init, 0);
487
488           dpdk_mempool_private_t *privp = rte_mempool_get_priv (rmp);
489           privp->region_index = pri;
490
491           dm->pktmbuf_pools[socket_id] = rmp;
492
493           return 0;
494         }
495
496       rte_mempool_free (rmp);
497     }
498
499   vec_free (pool_name);
500
501   /* no usable pool for this socket, try to use pool from another one */
502   for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
503     {
504       if (dm->pktmbuf_pools[i])
505         {
506           clib_warning ("WARNING: Failed to allocate mempool for CPU socket "
507                         "%u. Threads running on socket %u will use socket %u "
508                         "mempool.", socket_id, socket_id, i);
509           dm->pktmbuf_pools[socket_id] = dm->pktmbuf_pools[i];
510           return 0;
511         }
512     }
513
514   return clib_error_return (0, "failed to allocate mempool on socket %u",
515                             socket_id);
516 }
517
518 #if CLIB_DEBUG > 0
519
520 u32 *vlib_buffer_state_validation_lock;
521 uword *vlib_buffer_state_validation_hash;
522 void *vlib_buffer_state_heap;
523
524 static clib_error_t *
525 buffer_state_validation_init (vlib_main_t * vm)
526 {
527   void *oldheap;
528
529   vlib_buffer_state_heap = mheap_alloc (0, 10 << 20);
530
531   oldheap = clib_mem_set_heap (vlib_buffer_state_heap);
532
533   vlib_buffer_state_validation_hash = hash_create (0, sizeof (uword));
534   vec_validate_aligned (vlib_buffer_state_validation_lock, 0,
535                         CLIB_CACHE_LINE_BYTES);
536   clib_mem_set_heap (oldheap);
537   return 0;
538 }
539
540 VLIB_INIT_FUNCTION (buffer_state_validation_init);
541 #endif
542
543 #if CLI_DEBUG
544 struct dpdk_validate_buf_result
545 {
546   u32 invalid;
547   u32 uninitialized;
548 };
549
550 #define DPDK_TRAJECTORY_POISON 31
551
552 static void
553 dpdk_buffer_validate_trajectory (struct rte_mempool *mp, void *opaque,
554                                  void *obj, unsigned obj_idx)
555 {
556   vlib_buffer_t *b;
557   struct dpdk_validate_buf_result *counter = opaque;
558   b = vlib_buffer_from_rte_mbuf ((struct rte_mbuf *) obj);
559   if (b->pre_data[0] != 0)
560     {
561       if (b->pre_data[0] == DPDK_TRAJECTORY_POISON)
562         counter->uninitialized++;
563       else
564         counter->invalid++;
565     }
566 }
567
568 int
569 dpdk_buffer_validate_trajectory_all (u32 * uninitialized)
570 {
571   dpdk_main_t *dm = &dpdk_main;
572   struct dpdk_validate_buf_result counter = { 0 };
573   int i;
574
575   for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
576     rte_mempool_obj_iter (dm->pktmbuf_pools[i],
577                           dpdk_buffer_validate_trajectory, &counter);
578   if (uninitialized)
579     *uninitialized = counter.uninitialized;
580   return counter.invalid;
581 }
582
583 static void
584 dpdk_buffer_poison_trajectory (struct rte_mempool *mp, void *opaque,
585                                void *obj, unsigned obj_idx)
586 {
587   vlib_buffer_t *b;
588   b = vlib_buffer_from_rte_mbuf ((struct rte_mbuf *) obj);
589   b->pre_data[0] = DPDK_TRAJECTORY_POISON;
590 }
591
592 void
593 dpdk_buffer_poison_trajectory_all (void)
594 {
595   dpdk_main_t *dm = &dpdk_main;
596   int i;
597
598   for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
599     rte_mempool_obj_iter (dm->pktmbuf_pools[i], dpdk_buffer_poison_trajectory,
600                           0);
601 }
602 #endif
603
604 /* *INDENT-OFF* */
605 VLIB_BUFFER_REGISTER_CALLBACKS (dpdk, static) = {
606   .vlib_buffer_alloc_cb = &dpdk_buffer_alloc,
607   .vlib_buffer_alloc_from_free_list_cb = &dpdk_buffer_alloc_from_free_list,
608   .vlib_buffer_free_cb = &dpdk_buffer_free,
609   .vlib_buffer_free_no_next_cb = &dpdk_buffer_free_no_next,
610   .vlib_packet_template_init_cb = &dpdk_packet_template_init,
611   .vlib_buffer_delete_free_list_cb = &dpdk_buffer_delete_free_list,
612 };
613 /* *INDENT-ON* */
614
615 /** @endcond */
616 /*
617  * fd.io coding-style-patch-verification: ON
618  *
619  * Local Variables:
620  * eval: (c-set-style "gnu")
621  * End:
622  */