FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
buffer.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2019 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 #include <unistd.h>
17 #include <errno.h>
18 
19 #include <rte_config.h>
20 #include <rte_mbuf.h>
21 #include <rte_ethdev.h>
22 #include <rte_vfio.h>
23 
24 #include <vlib/vlib.h>
25 #include <dpdk/buffer.h>
26 
27 STATIC_ASSERT (VLIB_BUFFER_PRE_DATA_SIZE == RTE_PKTMBUF_HEADROOM,
28  "VLIB_BUFFER_PRE_DATA_SIZE must be equal to RTE_PKTMBUF_HEADROOM");
29 
30 extern struct rte_mbuf *dpdk_mbuf_template_by_pool_index;
31 #ifndef CLIB_MARCH_VARIANT
32 struct rte_mempool **dpdk_mempool_by_buffer_pool_index = 0;
34 struct rte_mbuf *dpdk_mbuf_template_by_pool_index = 0;
35 
38 {
39  uword buffer_mem_start = vm->buffer_main->buffer_mem_start;
40  struct rte_mempool *mp, *nmp;
41  struct rte_pktmbuf_pool_private priv;
42  enum rte_iova_mode iova_mode;
43  u32 *bi;
44  u8 *name = 0;
45 
46  u32 elt_size =
47  sizeof (struct rte_mbuf) + sizeof (vlib_buffer_t) + bp->data_size;
48 
49  /* create empty mempools */
54 
55  /* normal mempool */
56  name = format (name, "vpp pool %u%c", bp->index, 0);
57  mp = rte_mempool_create_empty ((char *) name, vec_len (bp->buffers),
58  elt_size, 512, sizeof (priv),
59  bp->numa_node, 0);
60  vec_reset_length (name);
61 
62  /* non-cached mempool */
63  name = format (name, "vpp pool %u (no cache)%c", bp->index, 0);
64  nmp = rte_mempool_create_empty ((char *) name, vec_len (bp->buffers),
65  elt_size, 0, sizeof (priv),
66  bp->numa_node, 0);
67  vec_free (name);
68 
69  dpdk_mempool_by_buffer_pool_index[bp->index] = mp;
71 
72  mp->pool_id = nmp->pool_id = bp->index;
73 
74  rte_mempool_set_ops_byname (mp, "vpp", NULL);
75  rte_mempool_set_ops_byname (nmp, "vpp-no-cache", NULL);
76 
77  /* Call the mempool priv initializer */
78  priv.mbuf_data_room_size = VLIB_BUFFER_PRE_DATA_SIZE +
80  priv.mbuf_priv_size = VLIB_BUFFER_HDR_SIZE;
81  rte_pktmbuf_pool_init (mp, &priv);
82  rte_pktmbuf_pool_init (nmp, &priv);
83 
84  iova_mode = rte_eal_iova_mode ();
85 
86  /* populate mempool object buffer header */
87  /* *INDENT-OFF* */
88  vec_foreach (bi, bp->buffers)
89  {
90  struct rte_mempool_objhdr *hdr;
91  vlib_buffer_t *b = vlib_get_buffer (vm, *bi);
92  struct rte_mbuf *mb = rte_mbuf_from_vlib_buffer (b);
93  hdr = (struct rte_mempool_objhdr *) RTE_PTR_SUB (mb, sizeof (*hdr));
94  hdr->mp = mp;
95  hdr->iova = (iova_mode == RTE_IOVA_VA) ?
96  pointer_to_uword (mb) : vlib_physmem_get_pa (vm, mb);
97  STAILQ_INSERT_TAIL (&mp->elt_list, hdr, next);
98  STAILQ_INSERT_TAIL (&nmp->elt_list, hdr, next);
99  mp->populated_size++;
100  nmp->populated_size++;
101  }
102  /* *INDENT-ON* */
103 
104  /* call the object initializers */
105  rte_mempool_obj_iter (mp, rte_pktmbuf_init, 0);
106 
107  /* create mbuf header tempate from the first buffer in the pool */
112  (buffer_mem_start, *bp->buffers,
113  0)), sizeof (struct rte_mbuf));
114 
115  /* *INDENT-OFF* */
116  vec_foreach (bi, bp->buffers)
117  {
118  vlib_buffer_t *b;
119  b = vlib_buffer_ptr_from_index (buffer_mem_start, *bi, 0);
120  vlib_buffer_copy_template (b, &bp->buffer_template);
121  }
122  /* *INDENT-ON* */
123 
124  /* map DMA pages if at least one physical device exists */
125  if (rte_eth_dev_count_avail ())
126  {
127  uword i;
128  size_t page_sz;
129  vlib_physmem_map_t *pm;
130  int do_vfio_map = 1;
131 
132  pm = vlib_physmem_get_map (vm, bp->physmem_map_index);
133  page_sz = 1ULL << pm->log2_page_size;
134 
135  for (i = 0; i < pm->n_pages; i++)
136  {
137  char *va = ((char *) pm->base) + i * page_sz;
138  uword pa = (iova_mode == RTE_IOVA_VA) ?
139  pointer_to_uword (va) : pm->page_table[i];
140 
141  if (do_vfio_map &&
142  rte_vfio_dma_map (pointer_to_uword (va), pa, page_sz))
143  do_vfio_map = 0;
144 
145  struct rte_mempool_memhdr *memhdr;
146  memhdr = clib_mem_alloc (sizeof (*memhdr));
147  memhdr->mp = mp;
148  memhdr->addr = va;
149  memhdr->iova = pa;
150  memhdr->len = page_sz;
151  memhdr->free_cb = 0;
152  memhdr->opaque = 0;
153 
154  STAILQ_INSERT_TAIL (&mp->mem_list, memhdr, next);
155  mp->nb_mem_chunks++;
156  }
157  }
158 
159  return 0;
160 }
161 
162 static int
163 dpdk_ops_vpp_alloc (struct rte_mempool *mp)
164 {
165  clib_warning ("");
166  return 0;
167 }
168 
169 static void
170 dpdk_ops_vpp_free (struct rte_mempool *mp)
171 {
172  clib_warning ("");
173 }
174 
175 #endif
176 
179 {
180  /* Only non-replicated packets (b->ref_count == 1) expected */
181 
182  struct rte_mbuf *mb = obj;
184  ASSERT (b->ref_count == 1);
187 }
188 
189 int
190 CLIB_MULTIARCH_FN (dpdk_ops_vpp_enqueue) (struct rte_mempool * mp,
191  void *const *obj_table, unsigned n)
192 {
193  const int batch_size = 32;
195  vlib_buffer_t bt;
196  u8 buffer_pool_index = mp->pool_id;
197  vlib_buffer_pool_t *bp = vlib_get_buffer_pool (vm, buffer_pool_index);
198  u32 bufs[batch_size];
199  u32 n_left = n;
200  void *const *obj = obj_table;
201 
203 
204  while (n_left >= 4)
205  {
206  dpdk_ops_vpp_enqueue_one (&bt, obj[0]);
207  dpdk_ops_vpp_enqueue_one (&bt, obj[1]);
208  dpdk_ops_vpp_enqueue_one (&bt, obj[2]);
209  dpdk_ops_vpp_enqueue_one (&bt, obj[3]);
210  obj += 4;
211  n_left -= 4;
212  }
213 
214  while (n_left)
215  {
216  dpdk_ops_vpp_enqueue_one (&bt, obj[0]);
217  obj += 1;
218  n_left -= 1;
219  }
220 
221  while (n >= batch_size)
222  {
223  vlib_get_buffer_indices_with_offset (vm, (void **) obj_table, bufs,
224  batch_size,
225  sizeof (struct rte_mbuf));
226  vlib_buffer_pool_put (vm, buffer_pool_index, bufs, batch_size);
227  n -= batch_size;
228  obj_table += batch_size;
229  }
230 
231  if (n)
232  {
233  vlib_get_buffer_indices_with_offset (vm, (void **) obj_table, bufs,
234  n, sizeof (struct rte_mbuf));
235  vlib_buffer_pool_put (vm, buffer_pool_index, bufs, n);
236  }
237 
238  return 0;
239 }
240 
242 
245  struct rte_mempool *new, void *obj,
246  vlib_buffer_t * bt)
247 {
248  struct rte_mbuf *mb = obj;
250 
251  if (clib_atomic_sub_fetch (&b->ref_count, 1) == 0)
252  {
253  u32 bi = vlib_get_buffer_index (vm, b);
255  vlib_buffer_pool_put (vm, bt->buffer_pool_index, &bi, 1);
256  return;
257  }
258 }
259 
260 int
262  void *const *obj_table,
263  unsigned n)
264 {
266  vlib_buffer_t bt;
267  struct rte_mempool *mp;
268  mp = dpdk_mempool_by_buffer_pool_index[cmp->pool_id];
269  u8 buffer_pool_index = cmp->pool_id;
270  vlib_buffer_pool_t *bp = vlib_get_buffer_pool (vm, buffer_pool_index);
272 
273  while (n >= 4)
274  {
275  dpdk_ops_vpp_enqueue_no_cache_one (vm, cmp, mp, obj_table[0], &bt);
276  dpdk_ops_vpp_enqueue_no_cache_one (vm, cmp, mp, obj_table[1], &bt);
277  dpdk_ops_vpp_enqueue_no_cache_one (vm, cmp, mp, obj_table[2], &bt);
278  dpdk_ops_vpp_enqueue_no_cache_one (vm, cmp, mp, obj_table[3], &bt);
279  obj_table += 4;
280  n -= 4;
281  }
282 
283  while (n)
284  {
285  dpdk_ops_vpp_enqueue_no_cache_one (vm, cmp, mp, obj_table[0], &bt);
286  obj_table += 1;
287  n -= 1;
288  }
289 
290  return 0;
291 }
292 
294 
296 dpdk_mbuf_init_from_template (struct rte_mbuf **mba, struct rte_mbuf *mt,
297  int count)
298 {
299  /* Assumptions about rte_mbuf layout */
300  STATIC_ASSERT_OFFSET_OF (struct rte_mbuf, buf_addr, 0);
301  STATIC_ASSERT_OFFSET_OF (struct rte_mbuf, buf_iova, 8);
302  STATIC_ASSERT_SIZEOF_ELT (struct rte_mbuf, buf_iova, 8);
303  STATIC_ASSERT_SIZEOF_ELT (struct rte_mbuf, buf_iova, 8);
304  STATIC_ASSERT_SIZEOF (struct rte_mbuf, 128);
305 
306  while (count--)
307  {
308  struct rte_mbuf *mb = mba[0];
309  int i;
310  /* bytes 0 .. 15 hold buf_addr and buf_iova which we need to preserve */
311  /* copy bytes 16 .. 31 */
312  *((u8x16 *) mb + 1) = *((u8x16 *) mt + 1);
313 
314  /* copy bytes 32 .. 127 */
315 #ifdef CLIB_HAVE_VEC256
316  for (i = 1; i < 4; i++)
317  *((u8x32 *) mb + i) = *((u8x32 *) mt + i);
318 #else
319  for (i = 2; i < 8; i++)
320  *((u8x16 *) mb + i) = *((u8x16 *) mt + i);
321 #endif
322  mba++;
323  }
324 }
325 
326 int
327 CLIB_MULTIARCH_FN (dpdk_ops_vpp_dequeue) (struct rte_mempool * mp,
328  void **obj_table, unsigned n)
329 {
330  const int batch_size = 32;
332  u32 bufs[batch_size], total = 0, n_alloc = 0;
333  u8 buffer_pool_index = mp->pool_id;
334  void **obj = obj_table;
335  struct rte_mbuf t = dpdk_mbuf_template_by_pool_index[buffer_pool_index];
336 
337  while (n >= batch_size)
338  {
339  n_alloc = vlib_buffer_alloc_from_pool (vm, bufs, batch_size,
340  buffer_pool_index);
341  if (n_alloc != batch_size)
342  goto alloc_fail;
343 
344  vlib_get_buffers_with_offset (vm, bufs, obj, batch_size,
345  -(i32) sizeof (struct rte_mbuf));
346  dpdk_mbuf_init_from_template ((struct rte_mbuf **) obj, &t, batch_size);
347  total += batch_size;
348  obj += batch_size;
349  n -= batch_size;
350  }
351 
352  if (n)
353  {
354  n_alloc = vlib_buffer_alloc_from_pool (vm, bufs, n, buffer_pool_index);
355 
356  if (n_alloc != n)
357  goto alloc_fail;
358 
359  vlib_get_buffers_with_offset (vm, bufs, obj, n,
360  -(i32) sizeof (struct rte_mbuf));
361  dpdk_mbuf_init_from_template ((struct rte_mbuf **) obj, &t, n);
362  }
363 
364  return 0;
365 
366 alloc_fail:
367  /* dpdk doesn't support partial alloc, so we need to return what we
368  already got */
369  if (n_alloc)
370  vlib_buffer_pool_put (vm, buffer_pool_index, bufs, n_alloc);
371  obj = obj_table;
372  while (total)
373  {
374  vlib_get_buffer_indices_with_offset (vm, obj, bufs, batch_size,
375  sizeof (struct rte_mbuf));
376  vlib_buffer_pool_put (vm, buffer_pool_index, bufs, batch_size);
377 
378  obj += batch_size;
379  total -= batch_size;
380  }
381  return -ENOENT;
382 }
383 
385 
386 #ifndef CLIB_MARCH_VARIANT
387 
388 static int
389 dpdk_ops_vpp_dequeue_no_cache (struct rte_mempool *mp, void **obj_table,
390  unsigned n)
391 {
392  clib_error ("bug");
393  return 0;
394 }
395 
396 static unsigned
397 dpdk_ops_vpp_get_count (const struct rte_mempool *mp)
398 {
399  clib_warning ("");
400  return 0;
401 }
402 
403 static unsigned
404 dpdk_ops_vpp_get_count_no_cache (const struct rte_mempool *mp)
405 {
406  struct rte_mempool *cmp;
408  return dpdk_ops_vpp_get_count (cmp);
409 }
410 
411 clib_error_t *
413 {
414  clib_error_t *err;
415  vlib_buffer_pool_t *bp;
416 
417  struct rte_mempool_ops ops = { };
418 
419  strncpy (ops.name, "vpp", 4);
420  ops.alloc = dpdk_ops_vpp_alloc;
421  ops.free = dpdk_ops_vpp_free;
422  ops.get_count = dpdk_ops_vpp_get_count;
425  rte_mempool_register_ops (&ops);
426 
427  strncpy (ops.name, "vpp-no-cache", 13);
428  ops.get_count = dpdk_ops_vpp_get_count_no_cache;
430  ops.dequeue = dpdk_ops_vpp_dequeue_no_cache;
431  rte_mempool_register_ops (&ops);
432 
433  /* *INDENT-OFF* */
435  if (bp->start && (err = dpdk_buffer_pool_init (vm, bp)))
436  return err;
437  /* *INDENT-ON* */
438  return 0;
439 }
440 
441 VLIB_BUFFER_SET_EXT_HDR_SIZE (sizeof (struct rte_mempool_objhdr) +
442  sizeof (struct rte_mbuf));
443 
444 #endif
445 
446 /** @endcond */
447 /*
448  * fd.io coding-style-patch-verification: ON
449  *
450  * Local Variables:
451  * eval: (c-set-style "gnu")
452  * End:
453  */
#define vlib_buffer_from_rte_mbuf(x)
Definition: buffer.h:20
#define CLIB_MARCH_FN_POINTER(fn)
Definition: cpu.h:87
STATIC_ASSERT_OFFSET_OF(vlib_buffer_t, template_end, 64)
#define clib_error(format, args...)
Definition: error.h:62
static int dpdk_ops_vpp_alloc(struct rte_mempool *mp)
Definition: buffer.c:163
static_always_inline void dpdk_mbuf_init_from_template(struct rte_mbuf **mba, struct rte_mbuf *mt, int count)
Definition: buffer.c:296
static_always_inline vlib_buffer_pool_t * vlib_get_buffer_pool(vlib_main_t *vm, u8 buffer_pool_index)
Definition: buffer_funcs.h:478
#define NULL
Definition: clib.h:58
#define VLIB_BUFFER_PRE_DATA_SIZE
Definition: buffer.h:51
int i
vlib_buffer_main_t * buffer_main
Definition: main.h:129
uword * page_table
Definition: physmem.h:51
VLIB_BUFFER_SET_EXT_HDR_SIZE(sizeof(struct rte_mempool_objhdr)+sizeof(struct rte_mbuf))
static_always_inline void vlib_get_buffers_with_offset(vlib_main_t *vm, u32 *bi, void **b, int count, i32 offset)
Translate array of buffer indices into buffer pointers with offset.
Definition: buffer_funcs.h:178
u8 * format(u8 *s, const char *fmt,...)
Definition: format.c:424
vlib_physmem_map_t * vlib_physmem_get_map(vlib_main_t *vm, u32 index)
Definition: physmem.c:87
#define vec_validate_aligned(V, I, A)
Make sure vector is long enough for given index (no header, specified alignment)
Definition: vec.h:450
unsigned char u8
Definition: types.h:56
u8 buffer_pool_index
index of buffer pool this buffer belongs.
Definition: buffer.h:133
#define vec_reset_length(v)
Reset vector length to zero NULL-pointer tolerant.
#define clib_memcpy(d, s, n)
Definition: string.h:180
#define static_always_inline
Definition: clib.h:99
#define vec_elt_at_index(v, i)
Get vector value at index i checking that i is in bounds.
clib_error_t * dpdk_buffer_pool_init(vlib_main_t *vm, vlib_buffer_pool_t *bp)
Definition: buffer.c:37
unsigned int u32
Definition: types.h:88
static void dpdk_ops_vpp_free(struct rte_mempool *mp)
Definition: buffer.c:170
static u32 vlib_get_buffer_index(vlib_main_t *vm, void *p)
Translate buffer pointer into buffer index.
Definition: buffer_funcs.h:257
static_always_inline void dpdk_ops_vpp_enqueue_one(vlib_buffer_t *bt, void *obj)
Definition: buffer.c:178
static_always_inline void vlib_buffer_copy_template(vlib_buffer_t *b, vlib_buffer_t *bt)
Definition: buffer_funcs.h:145
#define rte_mbuf_from_vlib_buffer(x)
Definition: buffer.h:19
vlib_buffer_t buffer_template
Definition: buffer.h:401
vlib_buffer_pool_t * buffer_pools
Definition: buffer.h:413
static_always_inline void vlib_get_buffer_indices_with_offset(vlib_main_t *vm, void **b, u32 *bi, uword count, i32 offset)
Translate array of buffer pointers into buffer indices with offset.
Definition: buffer_funcs.h:276
STATIC_ASSERT(VLIB_BUFFER_PRE_DATA_SIZE==RTE_PKTMBUF_HEADROOM, "VLIB_BUFFER_PRE_DATA_SIZE must be equal to RTE_PKTMBUF_HEADROOM")
u8 name[64]
Definition: memclnt.api:152
#define clib_atomic_sub_fetch(a, b)
Definition: atomics.h:31
static_always_inline u32 vlib_buffer_get_default_data_size(vlib_main_t *vm)
Definition: buffer_funcs.h:96
#define STATIC_ASSERT_SIZEOF_ELT(d, e, s)
vlib_main_t * vm
Definition: buffer.c:312
static_always_inline void vlib_buffer_pool_put(vlib_main_t *vm, u8 buffer_pool_index, u32 *buffers, u32 n_buffers)
Definition: buffer_funcs.h:680
#define vec_free(V)
Free vector&#39;s memory (no header).
Definition: vec.h:341
#define clib_warning(format, args...)
Definition: error.h:59
int CLIB_MULTIARCH_FN() dpdk_ops_vpp_enqueue_no_cache(struct rte_mempool *cmp, void *const *obj_table, unsigned n)
Definition: buffer.c:261
int CLIB_MULTIARCH_FN() dpdk_ops_vpp_enqueue(struct rte_mempool *mp, void *const *obj_table, unsigned n)
Definition: buffer.c:190
CLIB_MARCH_FN_REGISTRATION(dpdk_ops_vpp_enqueue)
#define VLIB_BUFFER_HDR_SIZE
Definition: buffer.h:194
signed int i32
Definition: types.h:77
static u32 vlib_buffer_alloc_from_pool(vlib_main_t *vm, u32 *buffers, u32 n_buffers, u8 buffer_pool_index)
Allocate buffers from specific pool into supplied array.
Definition: buffer_funcs.h:523
struct rte_mbuf * dpdk_mbuf_template_by_pool_index
Definition: buffer.c:34
#define ASSERT(truth)
static_always_inline void dpdk_ops_vpp_enqueue_no_cache_one(vlib_main_t *vm, struct rte_mempool *old, struct rte_mempool *new, void *obj, vlib_buffer_t *bt)
Definition: buffer.c:244
size_t count
Definition: vapi.c:47
static void * vlib_buffer_ptr_from_index(uword buffer_mem_start, u32 buffer_index, uword offset)
Definition: buffer_funcs.h:71
static void * clib_mem_alloc(uword size)
Definition: mem.h:132
static uword pointer_to_uword(const void *p)
Definition: types.h:131
static vlib_main_t * vlib_get_main(void)
Definition: global_funcs.h:23
static u64 vlib_physmem_get_pa(vlib_main_t *vm, void *mem)
clib_error_t * dpdk_buffer_pools_create(vlib_main_t *vm)
Definition: buffer.c:412
#define vec_len(v)
Number of elements in vector (rvalue-only, NULL tolerant)
struct rte_mempool ** dpdk_no_cache_mempool_by_buffer_pool_index
Definition: buffer.c:33
VLIB buffer representation.
Definition: buffer.h:102
u64 uword
Definition: types.h:112
uword buffer_mem_start
Definition: buffer.h:411
static unsigned dpdk_ops_vpp_get_count_no_cache(const struct rte_mempool *mp)
Definition: buffer.c:404
static unsigned dpdk_ops_vpp_get_count(const struct rte_mempool *mp)
Definition: buffer.c:397
#define vec_foreach(var, vec)
Vector iterator.
static int dpdk_ops_vpp_dequeue_no_cache(struct rte_mempool *mp, void **obj_table, unsigned n)
Definition: buffer.c:389
struct rte_mempool ** dpdk_mempool_by_buffer_pool_index
Definition: buffer.c:32
#define CLIB_CACHE_LINE_BYTES
Definition: cache.h:59
#define STATIC_ASSERT_SIZEOF(d, s)
int CLIB_MULTIARCH_FN() dpdk_ops_vpp_dequeue(struct rte_mempool *mp, void **obj_table, unsigned n)
Definition: buffer.c:327
volatile u8 ref_count
Reference count for this buffer.
Definition: buffer.h:130
static vlib_buffer_t * vlib_get_buffer(vlib_main_t *vm, u32 buffer_index)
Translate buffer index into buffer pointer.
Definition: buffer_funcs.h:85
#define CLIB_MULTIARCH_FN(fn)
Definition: cpu.h:56