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