mbuf: add pool create helper for specific mempool ops
[dpdk.git] / lib / librte_mbuf / rte_mbuf.c
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
5  *   Copyright 2014 6WIND S.A.
6  *   All rights reserved.
7  *
8  *   Redistribution and use in source and binary forms, with or without
9  *   modification, are permitted provided that the following conditions
10  *   are met:
11  *
12  *     * Redistributions of source code must retain the above copyright
13  *       notice, this list of conditions and the following disclaimer.
14  *     * Redistributions in binary form must reproduce the above copyright
15  *       notice, this list of conditions and the following disclaimer in
16  *       the documentation and/or other materials provided with the
17  *       distribution.
18  *     * Neither the name of Intel Corporation nor the names of its
19  *       contributors may be used to endorse or promote products derived
20  *       from this software without specific prior written permission.
21  *
22  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
34
35 #include <string.h>
36 #include <stdio.h>
37 #include <stdlib.h>
38 #include <stdint.h>
39 #include <stdarg.h>
40 #include <inttypes.h>
41 #include <errno.h>
42 #include <ctype.h>
43 #include <sys/queue.h>
44
45 #include <rte_debug.h>
46 #include <rte_common.h>
47 #include <rte_log.h>
48 #include <rte_memory.h>
49 #include <rte_launch.h>
50 #include <rte_eal.h>
51 #include <rte_per_lcore.h>
52 #include <rte_lcore.h>
53 #include <rte_atomic.h>
54 #include <rte_branch_prediction.h>
55 #include <rte_mempool.h>
56 #include <rte_mbuf.h>
57 #include <rte_mbuf_pool_ops.h>
58 #include <rte_string_fns.h>
59 #include <rte_hexdump.h>
60 #include <rte_errno.h>
61 #include <rte_memcpy.h>
62
63 /*
64  * ctrlmbuf constructor, given as a callback function to
65  * rte_mempool_obj_iter() or rte_mempool_create()
66  */
67 void
68 rte_ctrlmbuf_init(struct rte_mempool *mp,
69                 __attribute__((unused)) void *opaque_arg,
70                 void *_m,
71                 __attribute__((unused)) unsigned i)
72 {
73         struct rte_mbuf *m = _m;
74         rte_pktmbuf_init(mp, opaque_arg, _m, i);
75         m->ol_flags |= CTRL_MBUF_FLAG;
76 }
77
78 /*
79  * pktmbuf pool constructor, given as a callback function to
80  * rte_mempool_create(), or called directly if using
81  * rte_mempool_create_empty()/rte_mempool_populate()
82  */
83 void
84 rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg)
85 {
86         struct rte_pktmbuf_pool_private *user_mbp_priv, *mbp_priv;
87         struct rte_pktmbuf_pool_private default_mbp_priv;
88         uint16_t roomsz;
89
90         RTE_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf));
91
92         /* if no structure is provided, assume no mbuf private area */
93         user_mbp_priv = opaque_arg;
94         if (user_mbp_priv == NULL) {
95                 default_mbp_priv.mbuf_priv_size = 0;
96                 if (mp->elt_size > sizeof(struct rte_mbuf))
97                         roomsz = mp->elt_size - sizeof(struct rte_mbuf);
98                 else
99                         roomsz = 0;
100                 default_mbp_priv.mbuf_data_room_size = roomsz;
101                 user_mbp_priv = &default_mbp_priv;
102         }
103
104         RTE_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf) +
105                 user_mbp_priv->mbuf_data_room_size +
106                 user_mbp_priv->mbuf_priv_size);
107
108         mbp_priv = rte_mempool_get_priv(mp);
109         memcpy(mbp_priv, user_mbp_priv, sizeof(*mbp_priv));
110 }
111
112 /*
113  * pktmbuf constructor, given as a callback function to
114  * rte_mempool_obj_iter() or rte_mempool_create().
115  * Set the fields of a packet mbuf to their default values.
116  */
117 void
118 rte_pktmbuf_init(struct rte_mempool *mp,
119                  __attribute__((unused)) void *opaque_arg,
120                  void *_m,
121                  __attribute__((unused)) unsigned i)
122 {
123         struct rte_mbuf *m = _m;
124         uint32_t mbuf_size, buf_len, priv_size;
125
126         priv_size = rte_pktmbuf_priv_size(mp);
127         mbuf_size = sizeof(struct rte_mbuf) + priv_size;
128         buf_len = rte_pktmbuf_data_room_size(mp);
129
130         RTE_ASSERT(RTE_ALIGN(priv_size, RTE_MBUF_PRIV_ALIGN) == priv_size);
131         RTE_ASSERT(mp->elt_size >= mbuf_size);
132         RTE_ASSERT(buf_len <= UINT16_MAX);
133
134         memset(m, 0, mbuf_size);
135         /* start of buffer is after mbuf structure and priv data */
136         m->priv_size = priv_size;
137         m->buf_addr = (char *)m + mbuf_size;
138         m->buf_iova = rte_mempool_virt2iova(m) + mbuf_size;
139         m->buf_len = (uint16_t)buf_len;
140
141         /* keep some headroom between start of buffer and data */
142         m->data_off = RTE_MIN(RTE_PKTMBUF_HEADROOM, (uint16_t)m->buf_len);
143
144         /* init some constant fields */
145         m->pool = mp;
146         m->nb_segs = 1;
147         m->port = MBUF_INVALID_PORT;
148         rte_mbuf_refcnt_set(m, 1);
149         m->next = NULL;
150 }
151
152 /* Helper to create a mbuf pool with given mempool ops name*/
153 struct rte_mempool *
154 rte_pktmbuf_pool_create_by_ops(const char *name, unsigned int n,
155         unsigned int cache_size, uint16_t priv_size, uint16_t data_room_size,
156         int socket_id, const char *ops_name)
157 {
158         struct rte_mempool *mp;
159         struct rte_pktmbuf_pool_private mbp_priv;
160         const char *mp_ops_name = ops_name;
161         unsigned elt_size;
162         int ret;
163
164         if (RTE_ALIGN(priv_size, RTE_MBUF_PRIV_ALIGN) != priv_size) {
165                 RTE_LOG(ERR, MBUF, "mbuf priv_size=%u is not aligned\n",
166                         priv_size);
167                 rte_errno = EINVAL;
168                 return NULL;
169         }
170         elt_size = sizeof(struct rte_mbuf) + (unsigned)priv_size +
171                 (unsigned)data_room_size;
172         mbp_priv.mbuf_data_room_size = data_room_size;
173         mbp_priv.mbuf_priv_size = priv_size;
174
175         mp = rte_mempool_create_empty(name, n, elt_size, cache_size,
176                  sizeof(struct rte_pktmbuf_pool_private), socket_id, 0);
177         if (mp == NULL)
178                 return NULL;
179
180         if (mp_ops_name == NULL)
181                 mp_ops_name = rte_mbuf_best_mempool_ops();
182         ret = rte_mempool_set_ops_byname(mp, mp_ops_name, NULL);
183         if (ret != 0) {
184                 RTE_LOG(ERR, MBUF, "error setting mempool handler\n");
185                 rte_mempool_free(mp);
186                 rte_errno = -ret;
187                 return NULL;
188         }
189         rte_pktmbuf_pool_init(mp, &mbp_priv);
190
191         ret = rte_mempool_populate_default(mp);
192         if (ret < 0) {
193                 rte_mempool_free(mp);
194                 rte_errno = -ret;
195                 return NULL;
196         }
197
198         rte_mempool_obj_iter(mp, rte_pktmbuf_init, NULL);
199
200         return mp;
201 }
202
203 /* helper to create a mbuf pool */
204 struct rte_mempool *
205 rte_pktmbuf_pool_create(const char *name, unsigned int n,
206         unsigned int cache_size, uint16_t priv_size, uint16_t data_room_size,
207         int socket_id)
208 {
209         return rte_pktmbuf_pool_create_by_ops(name, n, cache_size, priv_size,
210                         data_room_size, socket_id, NULL);
211 }
212
213 /* do some sanity checks on a mbuf: panic if it fails */
214 void
215 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header)
216 {
217         unsigned int nb_segs, pkt_len;
218
219         if (m == NULL)
220                 rte_panic("mbuf is NULL\n");
221
222         /* generic checks */
223         if (m->pool == NULL)
224                 rte_panic("bad mbuf pool\n");
225         if (m->buf_iova == 0)
226                 rte_panic("bad IO addr\n");
227         if (m->buf_addr == NULL)
228                 rte_panic("bad virt addr\n");
229
230         uint16_t cnt = rte_mbuf_refcnt_read(m);
231         if ((cnt == 0) || (cnt == UINT16_MAX))
232                 rte_panic("bad ref cnt\n");
233
234         /* nothing to check for sub-segments */
235         if (is_header == 0)
236                 return;
237
238         /* data_len is supposed to be not more than pkt_len */
239         if (m->data_len > m->pkt_len)
240                 rte_panic("bad data_len\n");
241
242         nb_segs = m->nb_segs;
243         pkt_len = m->pkt_len;
244
245         do {
246                 nb_segs -= 1;
247                 pkt_len -= m->data_len;
248         } while ((m = m->next) != NULL);
249
250         if (nb_segs)
251                 rte_panic("bad nb_segs\n");
252         if (pkt_len)
253                 rte_panic("bad pkt_len\n");
254 }
255
256 /* dump a mbuf on console */
257 void
258 rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len)
259 {
260         unsigned int len;
261         unsigned int nb_segs;
262
263         __rte_mbuf_sanity_check(m, 1);
264
265         fprintf(f, "dump mbuf at %p, iova=%"PRIx64", buf_len=%u\n",
266                m, (uint64_t)m->buf_iova, (unsigned)m->buf_len);
267         fprintf(f, "  pkt_len=%"PRIu32", ol_flags=%"PRIx64", nb_segs=%u, "
268                "in_port=%u\n", m->pkt_len, m->ol_flags,
269                (unsigned)m->nb_segs, (unsigned)m->port);
270         nb_segs = m->nb_segs;
271
272         while (m && nb_segs != 0) {
273                 __rte_mbuf_sanity_check(m, 0);
274
275                 fprintf(f, "  segment at %p, data=%p, data_len=%u\n",
276                         m, rte_pktmbuf_mtod(m, void *), (unsigned)m->data_len);
277                 len = dump_len;
278                 if (len > m->data_len)
279                         len = m->data_len;
280                 if (len != 0)
281                         rte_hexdump(f, NULL, rte_pktmbuf_mtod(m, void *), len);
282                 dump_len -= len;
283                 m = m->next;
284                 nb_segs --;
285         }
286 }
287
288 /* read len data bytes in a mbuf at specified offset (internal) */
289 const void *__rte_pktmbuf_read(const struct rte_mbuf *m, uint32_t off,
290         uint32_t len, void *buf)
291 {
292         const struct rte_mbuf *seg = m;
293         uint32_t buf_off = 0, copy_len;
294
295         if (off + len > rte_pktmbuf_pkt_len(m))
296                 return NULL;
297
298         while (off >= rte_pktmbuf_data_len(seg)) {
299                 off -= rte_pktmbuf_data_len(seg);
300                 seg = seg->next;
301         }
302
303         if (off + len <= rte_pktmbuf_data_len(seg))
304                 return rte_pktmbuf_mtod_offset(seg, char *, off);
305
306         /* rare case: header is split among several segments */
307         while (len > 0) {
308                 copy_len = rte_pktmbuf_data_len(seg) - off;
309                 if (copy_len > len)
310                         copy_len = len;
311                 rte_memcpy((char *)buf + buf_off,
312                         rte_pktmbuf_mtod_offset(seg, char *, off), copy_len);
313                 off = 0;
314                 buf_off += copy_len;
315                 len -= copy_len;
316                 seg = seg->next;
317         }
318
319         return buf;
320 }
321
322 /*
323  * Get the name of a RX offload flag. Must be kept synchronized with flag
324  * definitions in rte_mbuf.h.
325  */
326 const char *rte_get_rx_ol_flag_name(uint64_t mask)
327 {
328         switch (mask) {
329         case PKT_RX_VLAN: return "PKT_RX_VLAN";
330         case PKT_RX_RSS_HASH: return "PKT_RX_RSS_HASH";
331         case PKT_RX_FDIR: return "PKT_RX_FDIR";
332         case PKT_RX_L4_CKSUM_BAD: return "PKT_RX_L4_CKSUM_BAD";
333         case PKT_RX_L4_CKSUM_GOOD: return "PKT_RX_L4_CKSUM_GOOD";
334         case PKT_RX_L4_CKSUM_NONE: return "PKT_RX_L4_CKSUM_NONE";
335         case PKT_RX_IP_CKSUM_BAD: return "PKT_RX_IP_CKSUM_BAD";
336         case PKT_RX_IP_CKSUM_GOOD: return "PKT_RX_IP_CKSUM_GOOD";
337         case PKT_RX_IP_CKSUM_NONE: return "PKT_RX_IP_CKSUM_NONE";
338         case PKT_RX_EIP_CKSUM_BAD: return "PKT_RX_EIP_CKSUM_BAD";
339         case PKT_RX_VLAN_STRIPPED: return "PKT_RX_VLAN_STRIPPED";
340         case PKT_RX_IEEE1588_PTP: return "PKT_RX_IEEE1588_PTP";
341         case PKT_RX_IEEE1588_TMST: return "PKT_RX_IEEE1588_TMST";
342         case PKT_RX_QINQ_STRIPPED: return "PKT_RX_QINQ_STRIPPED";
343         case PKT_RX_LRO: return "PKT_RX_LRO";
344         case PKT_RX_TIMESTAMP: return "PKT_RX_TIMESTAMP";
345         case PKT_RX_SEC_OFFLOAD: return "PKT_RX_SEC_OFFLOAD";
346         case PKT_RX_SEC_OFFLOAD_FAILED: return "PKT_RX_SEC_OFFLOAD_FAILED";
347         default: return NULL;
348         }
349 }
350
351 struct flag_mask {
352         uint64_t flag;
353         uint64_t mask;
354         const char *default_name;
355 };
356
357 /* write the list of rx ol flags in buffer buf */
358 int
359 rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen)
360 {
361         const struct flag_mask rx_flags[] = {
362                 { PKT_RX_VLAN, PKT_RX_VLAN, NULL },
363                 { PKT_RX_RSS_HASH, PKT_RX_RSS_HASH, NULL },
364                 { PKT_RX_FDIR, PKT_RX_FDIR, NULL },
365                 { PKT_RX_L4_CKSUM_BAD, PKT_RX_L4_CKSUM_MASK, NULL },
366                 { PKT_RX_L4_CKSUM_GOOD, PKT_RX_L4_CKSUM_MASK, NULL },
367                 { PKT_RX_L4_CKSUM_NONE, PKT_RX_L4_CKSUM_MASK, NULL },
368                 { PKT_RX_L4_CKSUM_UNKNOWN, PKT_RX_L4_CKSUM_MASK,
369                   "PKT_RX_L4_CKSUM_UNKNOWN" },
370                 { PKT_RX_IP_CKSUM_BAD, PKT_RX_IP_CKSUM_MASK, NULL },
371                 { PKT_RX_IP_CKSUM_GOOD, PKT_RX_IP_CKSUM_MASK, NULL },
372                 { PKT_RX_IP_CKSUM_NONE, PKT_RX_IP_CKSUM_MASK, NULL },
373                 { PKT_RX_IP_CKSUM_UNKNOWN, PKT_RX_IP_CKSUM_MASK,
374                   "PKT_RX_IP_CKSUM_UNKNOWN" },
375                 { PKT_RX_EIP_CKSUM_BAD, PKT_RX_EIP_CKSUM_BAD, NULL },
376                 { PKT_RX_VLAN_STRIPPED, PKT_RX_VLAN_STRIPPED, NULL },
377                 { PKT_RX_IEEE1588_PTP, PKT_RX_IEEE1588_PTP, NULL },
378                 { PKT_RX_IEEE1588_TMST, PKT_RX_IEEE1588_TMST, NULL },
379                 { PKT_RX_QINQ_STRIPPED, PKT_RX_QINQ_STRIPPED, NULL },
380                 { PKT_RX_LRO, PKT_RX_LRO, NULL },
381                 { PKT_RX_TIMESTAMP, PKT_RX_TIMESTAMP, NULL },
382                 { PKT_RX_SEC_OFFLOAD, PKT_RX_SEC_OFFLOAD, NULL },
383                 { PKT_RX_SEC_OFFLOAD_FAILED, PKT_RX_SEC_OFFLOAD_FAILED, NULL },
384                 { PKT_RX_QINQ, PKT_RX_QINQ, NULL },
385         };
386         const char *name;
387         unsigned int i;
388         int ret;
389
390         if (buflen == 0)
391                 return -1;
392
393         buf[0] = '\0';
394         for (i = 0; i < RTE_DIM(rx_flags); i++) {
395                 if ((mask & rx_flags[i].mask) != rx_flags[i].flag)
396                         continue;
397                 name = rte_get_rx_ol_flag_name(rx_flags[i].flag);
398                 if (name == NULL)
399                         name = rx_flags[i].default_name;
400                 ret = snprintf(buf, buflen, "%s ", name);
401                 if (ret < 0)
402                         return -1;
403                 if ((size_t)ret >= buflen)
404                         return -1;
405                 buf += ret;
406                 buflen -= ret;
407         }
408
409         return 0;
410 }
411
412 /*
413  * Get the name of a TX offload flag. Must be kept synchronized with flag
414  * definitions in rte_mbuf.h.
415  */
416 const char *rte_get_tx_ol_flag_name(uint64_t mask)
417 {
418         switch (mask) {
419         case PKT_TX_VLAN_PKT: return "PKT_TX_VLAN_PKT";
420         case PKT_TX_IP_CKSUM: return "PKT_TX_IP_CKSUM";
421         case PKT_TX_TCP_CKSUM: return "PKT_TX_TCP_CKSUM";
422         case PKT_TX_SCTP_CKSUM: return "PKT_TX_SCTP_CKSUM";
423         case PKT_TX_UDP_CKSUM: return "PKT_TX_UDP_CKSUM";
424         case PKT_TX_IEEE1588_TMST: return "PKT_TX_IEEE1588_TMST";
425         case PKT_TX_TCP_SEG: return "PKT_TX_TCP_SEG";
426         case PKT_TX_IPV4: return "PKT_TX_IPV4";
427         case PKT_TX_IPV6: return "PKT_TX_IPV6";
428         case PKT_TX_OUTER_IP_CKSUM: return "PKT_TX_OUTER_IP_CKSUM";
429         case PKT_TX_OUTER_IPV4: return "PKT_TX_OUTER_IPV4";
430         case PKT_TX_OUTER_IPV6: return "PKT_TX_OUTER_IPV6";
431         case PKT_TX_TUNNEL_VXLAN: return "PKT_TX_TUNNEL_VXLAN";
432         case PKT_TX_TUNNEL_GRE: return "PKT_TX_TUNNEL_GRE";
433         case PKT_TX_TUNNEL_IPIP: return "PKT_TX_TUNNEL_IPIP";
434         case PKT_TX_TUNNEL_GENEVE: return "PKT_TX_TUNNEL_GENEVE";
435         case PKT_TX_TUNNEL_MPLSINUDP: return "PKT_TX_TUNNEL_MPLSINUDP";
436         case PKT_TX_MACSEC: return "PKT_TX_MACSEC";
437         case PKT_TX_SEC_OFFLOAD: return "PKT_TX_SEC_OFFLOAD";
438         default: return NULL;
439         }
440 }
441
442 /* write the list of tx ol flags in buffer buf */
443 int
444 rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen)
445 {
446         const struct flag_mask tx_flags[] = {
447                 { PKT_TX_VLAN_PKT, PKT_TX_VLAN_PKT, NULL },
448                 { PKT_TX_IP_CKSUM, PKT_TX_IP_CKSUM, NULL },
449                 { PKT_TX_TCP_CKSUM, PKT_TX_L4_MASK, NULL },
450                 { PKT_TX_SCTP_CKSUM, PKT_TX_L4_MASK, NULL },
451                 { PKT_TX_UDP_CKSUM, PKT_TX_L4_MASK, NULL },
452                 { PKT_TX_L4_NO_CKSUM, PKT_TX_L4_MASK, "PKT_TX_L4_NO_CKSUM" },
453                 { PKT_TX_IEEE1588_TMST, PKT_TX_IEEE1588_TMST, NULL },
454                 { PKT_TX_TCP_SEG, PKT_TX_TCP_SEG, NULL },
455                 { PKT_TX_IPV4, PKT_TX_IPV4, NULL },
456                 { PKT_TX_IPV6, PKT_TX_IPV6, NULL },
457                 { PKT_TX_OUTER_IP_CKSUM, PKT_TX_OUTER_IP_CKSUM, NULL },
458                 { PKT_TX_OUTER_IPV4, PKT_TX_OUTER_IPV4, NULL },
459                 { PKT_TX_OUTER_IPV6, PKT_TX_OUTER_IPV6, NULL },
460                 { PKT_TX_TUNNEL_VXLAN, PKT_TX_TUNNEL_MASK,
461                   "PKT_TX_TUNNEL_NONE" },
462                 { PKT_TX_TUNNEL_GRE, PKT_TX_TUNNEL_MASK,
463                   "PKT_TX_TUNNEL_NONE" },
464                 { PKT_TX_TUNNEL_IPIP, PKT_TX_TUNNEL_MASK,
465                   "PKT_TX_TUNNEL_NONE" },
466                 { PKT_TX_TUNNEL_GENEVE, PKT_TX_TUNNEL_MASK,
467                   "PKT_TX_TUNNEL_NONE" },
468                 { PKT_TX_TUNNEL_MPLSINUDP, PKT_TX_TUNNEL_MASK,
469                   "PKT_TX_TUNNEL_NONE" },
470                 { PKT_TX_MACSEC, PKT_TX_MACSEC, NULL },
471                 { PKT_TX_SEC_OFFLOAD, PKT_TX_SEC_OFFLOAD, NULL },
472         };
473         const char *name;
474         unsigned int i;
475         int ret;
476
477         if (buflen == 0)
478                 return -1;
479
480         buf[0] = '\0';
481         for (i = 0; i < RTE_DIM(tx_flags); i++) {
482                 if ((mask & tx_flags[i].mask) != tx_flags[i].flag)
483                         continue;
484                 name = rte_get_tx_ol_flag_name(tx_flags[i].flag);
485                 if (name == NULL)
486                         name = tx_flags[i].default_name;
487                 ret = snprintf(buf, buflen, "%s ", name);
488                 if (ret < 0)
489                         return -1;
490                 if ((size_t)ret >= buflen)
491                         return -1;
492                 buf += ret;
493                 buflen -= ret;
494         }
495
496         return 0;
497 }