dpdk: fix potential crash in buffer free function
[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 typedef struct
83 {
84   struct rte_mbuf ***mbuf_pending_free_list;
85
86   /* cached last pool */
87   struct rte_mempool *last_pool;
88   u8 last_buffer_pool_index;
89 } dpdk_buffer_per_thread_data;
90
91 typedef struct
92 {
93   dpdk_buffer_per_thread_data *ptd;
94 } dpdk_buffer_main_t;
95
96 dpdk_buffer_main_t dpdk_buffer_main;
97
98 static_always_inline void
99 dpdk_rte_pktmbuf_free (vlib_main_t * vm, u32 thread_index, vlib_buffer_t * b)
100 {
101   vlib_buffer_t *hb = b;
102   dpdk_buffer_main_t *dbm = &dpdk_buffer_main;
103   dpdk_buffer_per_thread_data *d = vec_elt_at_index (dbm->ptd, thread_index);
104   struct rte_mbuf *mb;
105   u32 next, flags;
106   mb = rte_mbuf_from_vlib_buffer (hb);
107
108 next:
109   flags = b->flags;
110   next = b->next_buffer;
111   mb = rte_mbuf_from_vlib_buffer (b);
112
113   if (PREDICT_FALSE (b->n_add_refs))
114     {
115       rte_mbuf_refcnt_update (mb, b->n_add_refs);
116       b->n_add_refs = 0;
117     }
118
119   mb = rte_pktmbuf_prefree_seg (mb);
120   if (mb)
121     {
122       if (mb->pool != d->last_pool)
123         {
124           d->last_pool = mb->pool;
125           dpdk_mempool_private_t *privp = rte_mempool_get_priv (d->last_pool);
126           d->last_buffer_pool_index = privp->buffer_pool_index;
127           vec_validate_aligned (d->mbuf_pending_free_list,
128                                 d->last_buffer_pool_index,
129                                 CLIB_CACHE_LINE_BYTES);
130         }
131       vec_add1 (d->mbuf_pending_free_list[d->last_buffer_pool_index], mb);
132     }
133
134   if (flags & VLIB_BUFFER_NEXT_PRESENT)
135     {
136       b = vlib_get_buffer (vm, next);
137       goto next;
138     }
139 }
140
141 #ifndef CLIB_MULTIARCH_VARIANT
142 static void
143 del_free_list (vlib_main_t * vm, vlib_buffer_free_list_t * f)
144 {
145   u32 i;
146   vlib_buffer_t *b;
147   u32 thread_index = vlib_get_thread_index ();
148
149   for (i = 0; i < vec_len (f->buffers); i++)
150     {
151       b = vlib_get_buffer (vm, f->buffers[i]);
152       dpdk_rte_pktmbuf_free (vm, thread_index, b);
153     }
154
155   vec_free (f->name);
156   vec_free (f->buffers);
157 }
158
159 /* Add buffer free list. */
160 static void
161 dpdk_buffer_delete_free_list (vlib_main_t * vm, u32 free_list_index)
162 {
163   vlib_buffer_main_t *bm = vm->buffer_main;
164   vlib_buffer_free_list_t *f;
165   u32 merge_index;
166   int i;
167
168   ASSERT (vlib_get_thread_index () == 0);
169
170   f = vlib_buffer_get_free_list (vm, free_list_index);
171
172   merge_index = vlib_buffer_get_free_list_with_size (vm, f->n_data_bytes);
173   if (merge_index != ~0 && merge_index != free_list_index)
174     {
175       vlib_buffer_merge_free_lists (pool_elt_at_index
176                                     (bm->buffer_free_list_pool, merge_index),
177                                     f);
178     }
179
180   del_free_list (vm, f);
181
182   /* Poison it. */
183   memset (f, 0xab, sizeof (f[0]));
184
185   pool_put (bm->buffer_free_list_pool, f);
186
187   for (i = 1; i < vec_len (vlib_mains); i++)
188     {
189       bm = vlib_mains[i]->buffer_main;
190       f = vlib_buffer_get_free_list (vlib_mains[i], free_list_index);;
191       memset (f, 0xab, sizeof (f[0]));
192       pool_put (bm->buffer_free_list_pool, f);
193     }
194 }
195 #endif
196
197 /* Make sure free list has at least given number of free buffers. */
198 static uword
199 fill_free_list (vlib_main_t * vm,
200                 vlib_buffer_free_list_t * fl, uword min_free_buffers)
201 {
202   dpdk_main_t *dm = &dpdk_main;
203   vlib_buffer_t *b0, *b1, *b2, *b3;
204   int n, i;
205   u32 bi0, bi1, bi2, bi3;
206   unsigned socket_id = rte_socket_id ();
207   struct rte_mempool *rmp = dm->pktmbuf_pools[socket_id];
208   dpdk_mempool_private_t *privp = rte_mempool_get_priv (rmp);
209   struct rte_mbuf *mb0, *mb1, *mb2, *mb3;
210   vlib_buffer_t bt;
211
212   /* Too early? */
213   if (PREDICT_FALSE (rmp == 0))
214     return 0;
215
216   /* Already have enough free buffers on free list? */
217   n = min_free_buffers - vec_len (fl->buffers);
218   if (n <= 0)
219     return min_free_buffers;
220
221   /* Always allocate round number of buffers. */
222   n = round_pow2 (n, CLIB_CACHE_LINE_BYTES / sizeof (u32));
223
224   /* Always allocate new buffers in reasonably large sized chunks. */
225   n = clib_max (n, fl->min_n_buffers_each_physmem_alloc);
226
227   vec_validate_aligned (vm->mbuf_alloc_list, n - 1, CLIB_CACHE_LINE_BYTES);
228
229   if (rte_mempool_get_bulk (rmp, vm->mbuf_alloc_list, n) < 0)
230     return 0;
231
232   memset (&bt, 0, sizeof (vlib_buffer_t));
233   vlib_buffer_init_for_free_list (&bt, fl);
234   bt.buffer_pool_index = privp->buffer_pool_index;
235
236   _vec_len (vm->mbuf_alloc_list) = n;
237
238   i = 0;
239   int f = vec_len (fl->buffers);
240   vec_resize_aligned (fl->buffers, n, CLIB_CACHE_LINE_BYTES);
241
242   while (i < (n - 7))
243     {
244       vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf
245                                    (vm->mbuf_alloc_list[i + 4]), STORE);
246       vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf
247                                    (vm->mbuf_alloc_list[i + 5]), STORE);
248       vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf
249                                    (vm->mbuf_alloc_list[i + 6]), STORE);
250       vlib_prefetch_buffer_header (vlib_buffer_from_rte_mbuf
251                                    (vm->mbuf_alloc_list[i + 7]), STORE);
252
253       mb0 = vm->mbuf_alloc_list[i];
254       mb1 = vm->mbuf_alloc_list[i + 1];
255       mb2 = vm->mbuf_alloc_list[i + 2];
256       mb3 = vm->mbuf_alloc_list[i + 3];
257
258       b0 = vlib_buffer_from_rte_mbuf (mb0);
259       b1 = vlib_buffer_from_rte_mbuf (mb1);
260       b2 = vlib_buffer_from_rte_mbuf (mb2);
261       b3 = vlib_buffer_from_rte_mbuf (mb3);
262
263       bi0 = vlib_get_buffer_index (vm, b0);
264       bi1 = vlib_get_buffer_index (vm, b1);
265       bi2 = vlib_get_buffer_index (vm, b2);
266       bi3 = vlib_get_buffer_index (vm, b3);
267
268       fl->buffers[f++] = bi0;
269       fl->buffers[f++] = bi1;
270       fl->buffers[f++] = bi2;
271       fl->buffers[f++] = bi3;
272
273       clib_memcpy64_x4 (b0, b1, b2, b3, &bt);
274
275       if (fl->buffer_init_function)
276         {
277           fl->buffer_init_function (vm, fl, &bi0, 1);
278           fl->buffer_init_function (vm, fl, &bi1, 1);
279           fl->buffer_init_function (vm, fl, &bi2, 1);
280           fl->buffer_init_function (vm, fl, &bi3, 1);
281         }
282       i += 4;
283     }
284
285   while (i < n)
286     {
287       mb0 = vm->mbuf_alloc_list[i];
288
289       b0 = vlib_buffer_from_rte_mbuf (mb0);
290       bi0 = vlib_get_buffer_index (vm, b0);
291
292       fl->buffers[f++] = bi0;
293       clib_memcpy (b0, &bt, sizeof (vlib_buffer_t));
294
295       if (fl->buffer_init_function)
296         fl->buffer_init_function (vm, fl, &bi0, 1);
297       i++;
298     }
299
300   fl->n_alloc += n;
301
302   return n;
303 }
304
305 static u32
306 alloc_from_free_list (vlib_main_t * vm,
307                       vlib_buffer_free_list_t * free_list,
308                       u32 * alloc_buffers, u32 n_alloc_buffers)
309 {
310   u32 *dst, *src;
311   uword len, n_filled;
312
313   dst = alloc_buffers;
314
315   n_filled = fill_free_list (vm, free_list, n_alloc_buffers);
316   if (n_filled == 0)
317     return 0;
318
319   len = vec_len (free_list->buffers);
320   ASSERT (len >= n_alloc_buffers);
321
322   src = free_list->buffers + len - n_alloc_buffers;
323   clib_memcpy (dst, src, n_alloc_buffers * sizeof (u32));
324
325   _vec_len (free_list->buffers) -= n_alloc_buffers;
326
327   return n_alloc_buffers;
328 }
329
330 /* Allocate a given number of buffers into given array.
331    Returns number actually allocated which will be either zero or
332    number requested. */
333 u32
334 CLIB_MULTIARCH_FN (dpdk_buffer_alloc) (vlib_main_t * vm, u32 * buffers,
335                                        u32 n_buffers)
336 {
337   vlib_buffer_main_t *bm = vm->buffer_main;
338
339   return alloc_from_free_list
340     (vm,
341      pool_elt_at_index (bm->buffer_free_list_pool,
342                         VLIB_BUFFER_DEFAULT_FREE_LIST_INDEX),
343      buffers, n_buffers);
344 }
345
346
347 u32
348 CLIB_MULTIARCH_FN (dpdk_buffer_alloc_from_free_list) (vlib_main_t * vm,
349                                                       u32 * buffers,
350                                                       u32 n_buffers,
351                                                       u32 free_list_index)
352 {
353   vlib_buffer_main_t *bm = vm->buffer_main;
354   vlib_buffer_free_list_t *f;
355   f = pool_elt_at_index (bm->buffer_free_list_pool, free_list_index);
356   return alloc_from_free_list (vm, f, buffers, n_buffers);
357 }
358
359 static_always_inline void
360 dpdk_prefetch_buffer_by_index (vlib_main_t * vm, u32 bi)
361 {
362   vlib_buffer_t *b;
363   struct rte_mbuf *mb;
364   b = vlib_get_buffer (vm, bi);
365   mb = rte_mbuf_from_vlib_buffer (b);
366   CLIB_PREFETCH (mb, CLIB_CACHE_LINE_BYTES, STORE);
367   CLIB_PREFETCH (b, CLIB_CACHE_LINE_BYTES, LOAD);
368 }
369
370 static_always_inline void
371 recycle_or_free (vlib_main_t * vm, vlib_buffer_main_t * bm, u32 bi,
372                  vlib_buffer_t * b)
373 {
374   vlib_buffer_free_list_t *fl;
375   u32 thread_index = vlib_get_thread_index ();
376   u32 fi;
377   fl = vlib_buffer_get_buffer_free_list (vm, b, &fi);
378
379   /* The only current use of this callback: multicast recycle */
380   if (PREDICT_FALSE (fl->buffers_added_to_freelist_function != 0))
381     {
382       int j;
383
384       vlib_buffer_add_to_free_list (vm, fl, bi,
385                                     (b->flags & VLIB_BUFFER_RECYCLE) == 0);
386
387       for (j = 0; j < vec_len (bm->announce_list); j++)
388         {
389           if (fl == bm->announce_list[j])
390             goto already_announced;
391         }
392       vec_add1 (bm->announce_list, fl);
393     already_announced:
394       ;
395     }
396   else
397     {
398       if (PREDICT_TRUE ((b->flags & VLIB_BUFFER_RECYCLE) == 0))
399         dpdk_rte_pktmbuf_free (vm, thread_index, b);
400     }
401 }
402
403 static_always_inline void
404 vlib_buffer_free_inline (vlib_main_t * vm,
405                          u32 * buffers, u32 n_buffers, u32 follow_buffer_next)
406 {
407   vlib_buffer_main_t *bm = vm->buffer_main;
408   dpdk_buffer_main_t *dbm = &dpdk_buffer_main;
409   vlib_buffer_t *b0, *b1, *b2, *b3;
410   u32 thread_index = vlib_get_thread_index ();
411   dpdk_buffer_per_thread_data *d = vec_elt_at_index (dbm->ptd, thread_index);
412   int i = 0;
413   u32 (*cb) (vlib_main_t * vm, u32 * buffers, u32 n_buffers,
414              u32 follow_buffer_next);
415
416   cb = bm->buffer_free_callback;
417
418   if (PREDICT_FALSE (cb != 0))
419     n_buffers = (*cb) (vm, buffers, n_buffers, follow_buffer_next);
420
421   if (!n_buffers)
422     return;
423
424   while (i + 7 < n_buffers)
425     {
426       dpdk_prefetch_buffer_by_index (vm, buffers[i + 4]);
427       dpdk_prefetch_buffer_by_index (vm, buffers[i + 5]);
428       dpdk_prefetch_buffer_by_index (vm, buffers[i + 6]);
429       dpdk_prefetch_buffer_by_index (vm, buffers[i + 7]);
430
431       b0 = vlib_get_buffer (vm, buffers[i]);
432       b1 = vlib_get_buffer (vm, buffers[i + 1]);
433       b2 = vlib_get_buffer (vm, buffers[i + 2]);
434       b3 = vlib_get_buffer (vm, buffers[i + 3]);
435
436       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b0);
437       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b1);
438       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b2);
439       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b3);
440
441       recycle_or_free (vm, bm, buffers[i], b0);
442       recycle_or_free (vm, bm, buffers[i + 1], b1);
443       recycle_or_free (vm, bm, buffers[i + 2], b2);
444       recycle_or_free (vm, bm, buffers[i + 3], b3);
445
446       i += 4;
447     }
448   while (i < n_buffers)
449     {
450       b0 = vlib_get_buffer (vm, buffers[i]);
451       VLIB_BUFFER_TRACE_TRAJECTORY_INIT (b);
452       recycle_or_free (vm, bm, buffers[i], b0);
453       i++;
454     }
455   if (vec_len (bm->announce_list))
456     {
457       vlib_buffer_free_list_t *fl;
458       for (i = 0; i < vec_len (bm->announce_list); i++)
459         {
460           fl = bm->announce_list[i];
461           fl->buffers_added_to_freelist_function (vm, fl);
462         }
463       _vec_len (bm->announce_list) = 0;
464     }
465
466   vec_foreach_index (i, d->mbuf_pending_free_list)
467   {
468     int len = vec_len (d->mbuf_pending_free_list[i]);
469     if (len)
470       {
471         rte_mempool_put_bulk (d->mbuf_pending_free_list[i][len - 1]->pool,
472                               (void *) d->mbuf_pending_free_list[i], len);
473         vec_reset_length (d->mbuf_pending_free_list[i]);
474       }
475   }
476 }
477
478 void
479 CLIB_MULTIARCH_FN (dpdk_buffer_free) (vlib_main_t * vm, u32 * buffers,
480                                       u32 n_buffers)
481 {
482   vlib_buffer_free_inline (vm, buffers, n_buffers,      /* follow_buffer_next */
483                            1);
484 }
485
486 void
487 CLIB_MULTIARCH_FN (dpdk_buffer_free_no_next) (vlib_main_t * vm, u32 * buffers,
488                                               u32 n_buffers)
489 {
490   vlib_buffer_free_inline (vm, buffers, n_buffers,      /* follow_buffer_next */
491                            0);
492 }
493
494 #ifndef CLIB_MULTIARCH_VARIANT
495 static void
496 dpdk_packet_template_init (vlib_main_t * vm,
497                            void *vt,
498                            void *packet_data,
499                            uword n_packet_data_bytes,
500                            uword min_n_buffers_each_physmem_alloc, u8 * name)
501 {
502   vlib_packet_template_t *t = (vlib_packet_template_t *) vt;
503
504   vlib_worker_thread_barrier_sync (vm);
505   memset (t, 0, sizeof (t[0]));
506
507   vec_add (t->packet_data, packet_data, n_packet_data_bytes);
508
509   vlib_worker_thread_barrier_release (vm);
510 }
511
512 clib_error_t *
513 dpdk_pool_create (vlib_main_t * vm, u8 * pool_name, u32 elt_size,
514                   u32 num_elts, u32 pool_priv_size, u16 cache_size, u8 numa,
515                   struct rte_mempool **_mp, vlib_physmem_region_index_t * pri)
516 {
517   struct rte_mempool *mp;
518   vlib_physmem_region_t *pr;
519   clib_error_t *error = 0;
520   u32 size, obj_size;
521   i32 ret;
522
523   obj_size = rte_mempool_calc_obj_size (elt_size, 0, 0);
524 #if RTE_VERSION < RTE_VERSION_NUM(17, 11, 0, 0)
525   size = rte_mempool_xmem_size (num_elts, obj_size, 21);
526 #else
527   size = rte_mempool_xmem_size (num_elts, obj_size, 21, 0);
528 #endif
529
530   error =
531     vlib_physmem_region_alloc (vm, (i8 *) pool_name, size, numa, 0, pri);
532   if (error)
533     return error;
534
535   pr = vlib_physmem_get_region (vm, pri[0]);
536
537   mp =
538     rte_mempool_create_empty ((i8 *) pool_name, num_elts, elt_size,
539                               512, pool_priv_size, numa, 0);
540   if (!mp)
541     return clib_error_return (0, "failed to create %s", pool_name);
542
543   rte_mempool_set_ops_byname (mp, RTE_MBUF_DEFAULT_MEMPOOL_OPS, NULL);
544
545 #if RTE_VERSION < RTE_VERSION_NUM(17, 11, 0, 0)
546   ret =
547     rte_mempool_populate_phys_tab (mp, pr->mem, pr->page_table, pr->n_pages,
548                                    pr->log2_page_size, NULL, NULL);
549 #else
550   ret =
551     rte_mempool_populate_iova_tab (mp, pr->mem, pr->page_table, pr->n_pages,
552                                    pr->log2_page_size, NULL, NULL);
553 #endif
554   if (ret != (i32) mp->size)
555     {
556       rte_mempool_free (mp);
557       return clib_error_return (0, "failed to populate %s", pool_name);
558     }
559
560   _mp[0] = mp;
561
562   return 0;
563 }
564
565 clib_error_t *
566 dpdk_buffer_pool_create (vlib_main_t * vm, unsigned num_mbufs,
567                          unsigned socket_id)
568 {
569   dpdk_main_t *dm = &dpdk_main;
570   struct rte_mempool *rmp;
571   dpdk_mempool_private_t priv;
572   vlib_physmem_region_index_t pri;
573   clib_error_t *error = 0;
574   u8 *pool_name;
575   u32 elt_size, i;
576
577   vec_validate_aligned (dm->pktmbuf_pools, socket_id, CLIB_CACHE_LINE_BYTES);
578
579   /* pool already exists, nothing to do */
580   if (dm->pktmbuf_pools[socket_id])
581     return 0;
582
583   pool_name = format (0, "dpdk_mbuf_pool_socket%u%c", socket_id, 0);
584
585   elt_size = sizeof (struct rte_mbuf) +
586     VLIB_BUFFER_HDR_SIZE /* priv size */  +
587     VLIB_BUFFER_PRE_DATA_SIZE + VLIB_BUFFER_DATA_SIZE;  /*data room size */
588
589   error =
590     dpdk_pool_create (vm, pool_name, elt_size, num_mbufs,
591                       sizeof (dpdk_mempool_private_t), 512, socket_id,
592                       &rmp, &pri);
593
594   vec_free (pool_name);
595
596   if (!error)
597     {
598       priv.mbp_priv.mbuf_data_room_size = VLIB_BUFFER_PRE_DATA_SIZE +
599         VLIB_BUFFER_DATA_SIZE;
600       priv.mbp_priv.mbuf_priv_size = VLIB_BUFFER_HDR_SIZE;
601
602       /* call the mempool priv initializer */
603       rte_pktmbuf_pool_init (rmp, &priv);
604
605       /* call the object initializers */
606       rte_mempool_obj_iter (rmp, rte_pktmbuf_init, 0);
607
608       dpdk_mempool_private_t *privp = rte_mempool_get_priv (rmp);
609       privp->buffer_pool_index = vlib_buffer_add_physmem_region (vm, pri);
610
611       dm->pktmbuf_pools[socket_id] = rmp;
612
613       return 0;
614     }
615
616   clib_error_report (error);
617
618   /* no usable pool for this socket, try to use pool from another one */
619   for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
620     {
621       if (dm->pktmbuf_pools[i])
622         {
623           clib_warning ("WARNING: Failed to allocate mempool for CPU socket "
624                         "%u. Threads running on socket %u will use socket %u "
625                         "mempool.", socket_id, socket_id, i);
626           dm->pktmbuf_pools[socket_id] = dm->pktmbuf_pools[i];
627           return 0;
628         }
629     }
630
631   return clib_error_return (0, "failed to allocate mempool on socket %u",
632                             socket_id);
633 }
634
635 #if CLIB_DEBUG > 0
636
637 u32 *vlib_buffer_state_validation_lock;
638 uword *vlib_buffer_state_validation_hash;
639 void *vlib_buffer_state_heap;
640
641 static clib_error_t *
642 buffer_state_validation_init (vlib_main_t * vm)
643 {
644   void *oldheap;
645
646   vlib_buffer_state_heap = mheap_alloc (0, 10 << 20);
647
648   oldheap = clib_mem_set_heap (vlib_buffer_state_heap);
649
650   vlib_buffer_state_validation_hash = hash_create (0, sizeof (uword));
651   vec_validate_aligned (vlib_buffer_state_validation_lock, 0,
652                         CLIB_CACHE_LINE_BYTES);
653   clib_mem_set_heap (oldheap);
654   return 0;
655 }
656
657 VLIB_INIT_FUNCTION (buffer_state_validation_init);
658 #endif
659
660 #if CLI_DEBUG
661 struct dpdk_validate_buf_result
662 {
663   u32 invalid;
664   u32 uninitialized;
665 };
666
667 #define DPDK_TRAJECTORY_POISON 31
668
669 static void
670 dpdk_buffer_validate_trajectory (struct rte_mempool *mp, void *opaque,
671                                  void *obj, unsigned obj_idx)
672 {
673   vlib_buffer_t *b;
674   struct dpdk_validate_buf_result *counter = opaque;
675   b = vlib_buffer_from_rte_mbuf ((struct rte_mbuf *) obj);
676   if (b->pre_data[0] != 0)
677     {
678       if (b->pre_data[0] == DPDK_TRAJECTORY_POISON)
679         counter->uninitialized++;
680       else
681         counter->invalid++;
682     }
683 }
684
685 int
686 dpdk_buffer_validate_trajectory_all (u32 * uninitialized)
687 {
688   dpdk_main_t *dm = &dpdk_main;
689   struct dpdk_validate_buf_result counter = { 0 };
690   int i;
691
692   for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
693     rte_mempool_obj_iter (dm->pktmbuf_pools[i],
694                           dpdk_buffer_validate_trajectory, &counter);
695   if (uninitialized)
696     *uninitialized = counter.uninitialized;
697   return counter.invalid;
698 }
699
700 static void
701 dpdk_buffer_poison_trajectory (struct rte_mempool *mp, void *opaque,
702                                void *obj, unsigned obj_idx)
703 {
704   vlib_buffer_t *b;
705   b = vlib_buffer_from_rte_mbuf ((struct rte_mbuf *) obj);
706   b->pre_data[0] = DPDK_TRAJECTORY_POISON;
707 }
708
709 void
710 dpdk_buffer_poison_trajectory_all (void)
711 {
712   dpdk_main_t *dm = &dpdk_main;
713   int i;
714
715   for (i = 0; i < vec_len (dm->pktmbuf_pools); i++)
716     rte_mempool_obj_iter (dm->pktmbuf_pools[i], dpdk_buffer_poison_trajectory,
717                           0);
718 }
719 #endif
720
721 static clib_error_t *
722 dpdk_buffer_init (vlib_main_t * vm)
723 {
724   dpdk_buffer_main_t *dbm = &dpdk_buffer_main;
725   vlib_thread_main_t *tm = vlib_get_thread_main ();
726   vec_validate_aligned (dbm->ptd, tm->n_vlib_mains - 1,
727                         CLIB_CACHE_LINE_BYTES);
728   return 0;
729 }
730
731 VLIB_INIT_FUNCTION (dpdk_buffer_init);
732
733 /* *INDENT-OFF* */
734 VLIB_BUFFER_REGISTER_CALLBACKS (dpdk, static) = {
735   .vlib_buffer_alloc_cb = &dpdk_buffer_alloc,
736   .vlib_buffer_alloc_from_free_list_cb = &dpdk_buffer_alloc_from_free_list,
737   .vlib_buffer_free_cb = &dpdk_buffer_free,
738   .vlib_buffer_free_no_next_cb = &dpdk_buffer_free_no_next,
739   .vlib_packet_template_init_cb = &dpdk_packet_template_init,
740   .vlib_buffer_delete_free_list_cb = &dpdk_buffer_delete_free_list,
741 };
742 /* *INDENT-ON* */
743
744 #if __x86_64__
745 vlib_buffer_alloc_cb_t __clib_weak dpdk_buffer_alloc_avx512;
746 vlib_buffer_alloc_cb_t __clib_weak dpdk_buffer_alloc_avx2;
747 vlib_buffer_alloc_from_free_list_cb_t __clib_weak
748   dpdk_buffer_alloc_from_free_list_avx512;
749 vlib_buffer_alloc_from_free_list_cb_t __clib_weak
750   dpdk_buffer_alloc_from_free_list_avx2;
751 vlib_buffer_free_cb_t __clib_weak dpdk_buffer_free_avx512;
752 vlib_buffer_free_cb_t __clib_weak dpdk_buffer_free_avx2;
753 vlib_buffer_free_no_next_cb_t __clib_weak dpdk_buffer_free_no_next_avx512;
754 vlib_buffer_free_no_next_cb_t __clib_weak dpdk_buffer_free_no_next_avx2;
755
756 static void __clib_constructor
757 dpdk_input_multiarch_select (void)
758 {
759   vlib_buffer_callbacks_t *cb = &__dpdk_buffer_callbacks;
760   if (dpdk_buffer_alloc_avx512 && clib_cpu_supports_avx512f ())
761     {
762       cb->vlib_buffer_alloc_cb = dpdk_buffer_alloc_avx512;
763       cb->vlib_buffer_alloc_from_free_list_cb =
764         dpdk_buffer_alloc_from_free_list_avx512;
765       cb->vlib_buffer_free_cb = dpdk_buffer_free_avx512;
766       cb->vlib_buffer_free_no_next_cb = dpdk_buffer_free_no_next_avx512;
767     }
768   else if (dpdk_buffer_alloc_avx2 && clib_cpu_supports_avx2 ())
769     {
770       cb->vlib_buffer_alloc_cb = dpdk_buffer_alloc_avx2;
771       cb->vlib_buffer_alloc_from_free_list_cb =
772         dpdk_buffer_alloc_from_free_list_avx2;
773       cb->vlib_buffer_free_cb = dpdk_buffer_free_avx2;
774       cb->vlib_buffer_free_no_next_cb = dpdk_buffer_free_no_next_avx2;
775     }
776 }
777 #endif
778 #endif
779
780 /** @endcond */
781 /*
782  * fd.io coding-style-patch-verification: ON
783  *
784  * Local Variables:
785  * eval: (c-set-style "gnu")
786  * End:
787  */