mbuf: add pool ops selection functions
[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 */
153 struct rte_mempool *
154 rte_pktmbuf_pool_create(const char *name, unsigned n,
155         unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
156         int socket_id)
157 {
158         struct rte_mempool *mp;
159         struct rte_pktmbuf_pool_private mbp_priv;
160         const char *mp_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         mp_ops_name = rte_mbuf_best_mempool_ops();
181         ret = rte_mempool_set_ops_byname(mp, mp_ops_name, NULL);
182         if (ret != 0) {
183                 RTE_LOG(ERR, MBUF, "error setting mempool handler\n");
184                 rte_mempool_free(mp);
185                 rte_errno = -ret;
186                 return NULL;
187         }
188         rte_pktmbuf_pool_init(mp, &mbp_priv);
189
190         ret = rte_mempool_populate_default(mp);
191         if (ret < 0) {
192                 rte_mempool_free(mp);
193                 rte_errno = -ret;
194                 return NULL;
195         }
196
197         rte_mempool_obj_iter(mp, rte_pktmbuf_init, NULL);
198
199         return mp;
200 }
201
202 /* do some sanity checks on a mbuf: panic if it fails */
203 void
204 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header)
205 {
206         unsigned int nb_segs, pkt_len;
207
208         if (m == NULL)
209                 rte_panic("mbuf is NULL\n");
210
211         /* generic checks */
212         if (m->pool == NULL)
213                 rte_panic("bad mbuf pool\n");
214         if (m->buf_iova == 0)
215                 rte_panic("bad IO addr\n");
216         if (m->buf_addr == NULL)
217                 rte_panic("bad virt addr\n");
218
219         uint16_t cnt = rte_mbuf_refcnt_read(m);
220         if ((cnt == 0) || (cnt == UINT16_MAX))
221                 rte_panic("bad ref cnt\n");
222
223         /* nothing to check for sub-segments */
224         if (is_header == 0)
225                 return;
226
227         /* data_len is supposed to be not more than pkt_len */
228         if (m->data_len > m->pkt_len)
229                 rte_panic("bad data_len\n");
230
231         nb_segs = m->nb_segs;
232         pkt_len = m->pkt_len;
233
234         do {
235                 nb_segs -= 1;
236                 pkt_len -= m->data_len;
237         } while ((m = m->next) != NULL);
238
239         if (nb_segs)
240                 rte_panic("bad nb_segs\n");
241         if (pkt_len)
242                 rte_panic("bad pkt_len\n");
243 }
244
245 /* dump a mbuf on console */
246 void
247 rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len)
248 {
249         unsigned int len;
250         unsigned int nb_segs;
251
252         __rte_mbuf_sanity_check(m, 1);
253
254         fprintf(f, "dump mbuf at %p, iova=%"PRIx64", buf_len=%u\n",
255                m, (uint64_t)m->buf_iova, (unsigned)m->buf_len);
256         fprintf(f, "  pkt_len=%"PRIu32", ol_flags=%"PRIx64", nb_segs=%u, "
257                "in_port=%u\n", m->pkt_len, m->ol_flags,
258                (unsigned)m->nb_segs, (unsigned)m->port);
259         nb_segs = m->nb_segs;
260
261         while (m && nb_segs != 0) {
262                 __rte_mbuf_sanity_check(m, 0);
263
264                 fprintf(f, "  segment at %p, data=%p, data_len=%u\n",
265                         m, rte_pktmbuf_mtod(m, void *), (unsigned)m->data_len);
266                 len = dump_len;
267                 if (len > m->data_len)
268                         len = m->data_len;
269                 if (len != 0)
270                         rte_hexdump(f, NULL, rte_pktmbuf_mtod(m, void *), len);
271                 dump_len -= len;
272                 m = m->next;
273                 nb_segs --;
274         }
275 }
276
277 /* read len data bytes in a mbuf at specified offset (internal) */
278 const void *__rte_pktmbuf_read(const struct rte_mbuf *m, uint32_t off,
279         uint32_t len, void *buf)
280 {
281         const struct rte_mbuf *seg = m;
282         uint32_t buf_off = 0, copy_len;
283
284         if (off + len > rte_pktmbuf_pkt_len(m))
285                 return NULL;
286
287         while (off >= rte_pktmbuf_data_len(seg)) {
288                 off -= rte_pktmbuf_data_len(seg);
289                 seg = seg->next;
290         }
291
292         if (off + len <= rte_pktmbuf_data_len(seg))
293                 return rte_pktmbuf_mtod_offset(seg, char *, off);
294
295         /* rare case: header is split among several segments */
296         while (len > 0) {
297                 copy_len = rte_pktmbuf_data_len(seg) - off;
298                 if (copy_len > len)
299                         copy_len = len;
300                 rte_memcpy((char *)buf + buf_off,
301                         rte_pktmbuf_mtod_offset(seg, char *, off), copy_len);
302                 off = 0;
303                 buf_off += copy_len;
304                 len -= copy_len;
305                 seg = seg->next;
306         }
307
308         return buf;
309 }
310
311 /*
312  * Get the name of a RX offload flag. Must be kept synchronized with flag
313  * definitions in rte_mbuf.h.
314  */
315 const char *rte_get_rx_ol_flag_name(uint64_t mask)
316 {
317         switch (mask) {
318         case PKT_RX_VLAN: return "PKT_RX_VLAN";
319         case PKT_RX_RSS_HASH: return "PKT_RX_RSS_HASH";
320         case PKT_RX_FDIR: return "PKT_RX_FDIR";
321         case PKT_RX_L4_CKSUM_BAD: return "PKT_RX_L4_CKSUM_BAD";
322         case PKT_RX_L4_CKSUM_GOOD: return "PKT_RX_L4_CKSUM_GOOD";
323         case PKT_RX_L4_CKSUM_NONE: return "PKT_RX_L4_CKSUM_NONE";
324         case PKT_RX_IP_CKSUM_BAD: return "PKT_RX_IP_CKSUM_BAD";
325         case PKT_RX_IP_CKSUM_GOOD: return "PKT_RX_IP_CKSUM_GOOD";
326         case PKT_RX_IP_CKSUM_NONE: return "PKT_RX_IP_CKSUM_NONE";
327         case PKT_RX_EIP_CKSUM_BAD: return "PKT_RX_EIP_CKSUM_BAD";
328         case PKT_RX_VLAN_STRIPPED: return "PKT_RX_VLAN_STRIPPED";
329         case PKT_RX_IEEE1588_PTP: return "PKT_RX_IEEE1588_PTP";
330         case PKT_RX_IEEE1588_TMST: return "PKT_RX_IEEE1588_TMST";
331         case PKT_RX_QINQ_STRIPPED: return "PKT_RX_QINQ_STRIPPED";
332         case PKT_RX_LRO: return "PKT_RX_LRO";
333         case PKT_RX_TIMESTAMP: return "PKT_RX_TIMESTAMP";
334         case PKT_RX_SEC_OFFLOAD: return "PKT_RX_SEC_OFFLOAD";
335         case PKT_RX_SEC_OFFLOAD_FAILED: return "PKT_RX_SEC_OFFLOAD_FAILED";
336         default: return NULL;
337         }
338 }
339
340 struct flag_mask {
341         uint64_t flag;
342         uint64_t mask;
343         const char *default_name;
344 };
345
346 /* write the list of rx ol flags in buffer buf */
347 int
348 rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen)
349 {
350         const struct flag_mask rx_flags[] = {
351                 { PKT_RX_VLAN, PKT_RX_VLAN, NULL },
352                 { PKT_RX_RSS_HASH, PKT_RX_RSS_HASH, NULL },
353                 { PKT_RX_FDIR, PKT_RX_FDIR, NULL },
354                 { PKT_RX_L4_CKSUM_BAD, PKT_RX_L4_CKSUM_MASK, NULL },
355                 { PKT_RX_L4_CKSUM_GOOD, PKT_RX_L4_CKSUM_MASK, NULL },
356                 { PKT_RX_L4_CKSUM_NONE, PKT_RX_L4_CKSUM_MASK, NULL },
357                 { PKT_RX_L4_CKSUM_UNKNOWN, PKT_RX_L4_CKSUM_MASK,
358                   "PKT_RX_L4_CKSUM_UNKNOWN" },
359                 { PKT_RX_IP_CKSUM_BAD, PKT_RX_IP_CKSUM_MASK, NULL },
360                 { PKT_RX_IP_CKSUM_GOOD, PKT_RX_IP_CKSUM_MASK, NULL },
361                 { PKT_RX_IP_CKSUM_NONE, PKT_RX_IP_CKSUM_MASK, NULL },
362                 { PKT_RX_IP_CKSUM_UNKNOWN, PKT_RX_IP_CKSUM_MASK,
363                   "PKT_RX_IP_CKSUM_UNKNOWN" },
364                 { PKT_RX_EIP_CKSUM_BAD, PKT_RX_EIP_CKSUM_BAD, NULL },
365                 { PKT_RX_VLAN_STRIPPED, PKT_RX_VLAN_STRIPPED, NULL },
366                 { PKT_RX_IEEE1588_PTP, PKT_RX_IEEE1588_PTP, NULL },
367                 { PKT_RX_IEEE1588_TMST, PKT_RX_IEEE1588_TMST, NULL },
368                 { PKT_RX_QINQ_STRIPPED, PKT_RX_QINQ_STRIPPED, NULL },
369                 { PKT_RX_LRO, PKT_RX_LRO, NULL },
370                 { PKT_RX_TIMESTAMP, PKT_RX_TIMESTAMP, NULL },
371                 { PKT_RX_SEC_OFFLOAD, PKT_RX_SEC_OFFLOAD, NULL },
372                 { PKT_RX_SEC_OFFLOAD_FAILED, PKT_RX_SEC_OFFLOAD_FAILED, NULL },
373                 { PKT_RX_QINQ, PKT_RX_QINQ, NULL },
374         };
375         const char *name;
376         unsigned int i;
377         int ret;
378
379         if (buflen == 0)
380                 return -1;
381
382         buf[0] = '\0';
383         for (i = 0; i < RTE_DIM(rx_flags); i++) {
384                 if ((mask & rx_flags[i].mask) != rx_flags[i].flag)
385                         continue;
386                 name = rte_get_rx_ol_flag_name(rx_flags[i].flag);
387                 if (name == NULL)
388                         name = rx_flags[i].default_name;
389                 ret = snprintf(buf, buflen, "%s ", name);
390                 if (ret < 0)
391                         return -1;
392                 if ((size_t)ret >= buflen)
393                         return -1;
394                 buf += ret;
395                 buflen -= ret;
396         }
397
398         return 0;
399 }
400
401 /*
402  * Get the name of a TX offload flag. Must be kept synchronized with flag
403  * definitions in rte_mbuf.h.
404  */
405 const char *rte_get_tx_ol_flag_name(uint64_t mask)
406 {
407         switch (mask) {
408         case PKT_TX_VLAN_PKT: return "PKT_TX_VLAN_PKT";
409         case PKT_TX_IP_CKSUM: return "PKT_TX_IP_CKSUM";
410         case PKT_TX_TCP_CKSUM: return "PKT_TX_TCP_CKSUM";
411         case PKT_TX_SCTP_CKSUM: return "PKT_TX_SCTP_CKSUM";
412         case PKT_TX_UDP_CKSUM: return "PKT_TX_UDP_CKSUM";
413         case PKT_TX_IEEE1588_TMST: return "PKT_TX_IEEE1588_TMST";
414         case PKT_TX_TCP_SEG: return "PKT_TX_TCP_SEG";
415         case PKT_TX_IPV4: return "PKT_TX_IPV4";
416         case PKT_TX_IPV6: return "PKT_TX_IPV6";
417         case PKT_TX_OUTER_IP_CKSUM: return "PKT_TX_OUTER_IP_CKSUM";
418         case PKT_TX_OUTER_IPV4: return "PKT_TX_OUTER_IPV4";
419         case PKT_TX_OUTER_IPV6: return "PKT_TX_OUTER_IPV6";
420         case PKT_TX_TUNNEL_VXLAN: return "PKT_TX_TUNNEL_VXLAN";
421         case PKT_TX_TUNNEL_GRE: return "PKT_TX_TUNNEL_GRE";
422         case PKT_TX_TUNNEL_IPIP: return "PKT_TX_TUNNEL_IPIP";
423         case PKT_TX_TUNNEL_GENEVE: return "PKT_TX_TUNNEL_GENEVE";
424         case PKT_TX_TUNNEL_MPLSINUDP: return "PKT_TX_TUNNEL_MPLSINUDP";
425         case PKT_TX_MACSEC: return "PKT_TX_MACSEC";
426         case PKT_TX_SEC_OFFLOAD: return "PKT_TX_SEC_OFFLOAD";
427         default: return NULL;
428         }
429 }
430
431 /* write the list of tx ol flags in buffer buf */
432 int
433 rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen)
434 {
435         const struct flag_mask tx_flags[] = {
436                 { PKT_TX_VLAN_PKT, PKT_TX_VLAN_PKT, NULL },
437                 { PKT_TX_IP_CKSUM, PKT_TX_IP_CKSUM, NULL },
438                 { PKT_TX_TCP_CKSUM, PKT_TX_L4_MASK, NULL },
439                 { PKT_TX_SCTP_CKSUM, PKT_TX_L4_MASK, NULL },
440                 { PKT_TX_UDP_CKSUM, PKT_TX_L4_MASK, NULL },
441                 { PKT_TX_L4_NO_CKSUM, PKT_TX_L4_MASK, "PKT_TX_L4_NO_CKSUM" },
442                 { PKT_TX_IEEE1588_TMST, PKT_TX_IEEE1588_TMST, NULL },
443                 { PKT_TX_TCP_SEG, PKT_TX_TCP_SEG, NULL },
444                 { PKT_TX_IPV4, PKT_TX_IPV4, NULL },
445                 { PKT_TX_IPV6, PKT_TX_IPV6, NULL },
446                 { PKT_TX_OUTER_IP_CKSUM, PKT_TX_OUTER_IP_CKSUM, NULL },
447                 { PKT_TX_OUTER_IPV4, PKT_TX_OUTER_IPV4, NULL },
448                 { PKT_TX_OUTER_IPV6, PKT_TX_OUTER_IPV6, NULL },
449                 { PKT_TX_TUNNEL_VXLAN, PKT_TX_TUNNEL_MASK,
450                   "PKT_TX_TUNNEL_NONE" },
451                 { PKT_TX_TUNNEL_GRE, PKT_TX_TUNNEL_MASK,
452                   "PKT_TX_TUNNEL_NONE" },
453                 { PKT_TX_TUNNEL_IPIP, PKT_TX_TUNNEL_MASK,
454                   "PKT_TX_TUNNEL_NONE" },
455                 { PKT_TX_TUNNEL_GENEVE, PKT_TX_TUNNEL_MASK,
456                   "PKT_TX_TUNNEL_NONE" },
457                 { PKT_TX_TUNNEL_MPLSINUDP, PKT_TX_TUNNEL_MASK,
458                   "PKT_TX_TUNNEL_NONE" },
459                 { PKT_TX_MACSEC, PKT_TX_MACSEC, NULL },
460                 { PKT_TX_SEC_OFFLOAD, PKT_TX_SEC_OFFLOAD, NULL },
461         };
462         const char *name;
463         unsigned int i;
464         int ret;
465
466         if (buflen == 0)
467                 return -1;
468
469         buf[0] = '\0';
470         for (i = 0; i < RTE_DIM(tx_flags); i++) {
471                 if ((mask & tx_flags[i].mask) != tx_flags[i].flag)
472                         continue;
473                 name = rte_get_tx_ol_flag_name(tx_flags[i].flag);
474                 if (name == NULL)
475                         name = tx_flags[i].default_name;
476                 ret = snprintf(buf, buflen, "%s ", name);
477                 if (ret < 0)
478                         return -1;
479                 if ((size_t)ret >= buflen)
480                         return -1;
481                 buf += ret;
482                 buflen -= ret;
483         }
484
485         return 0;
486 }