mbuf: check sanity of data and packet lengths
[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_string_fns.h>
58 #include <rte_hexdump.h>
59 #include <rte_errno.h>
60 #include <rte_memcpy.h>
61
62 /*
63  * ctrlmbuf constructor, given as a callback function to
64  * rte_mempool_obj_iter() or rte_mempool_create()
65  */
66 void
67 rte_ctrlmbuf_init(struct rte_mempool *mp,
68                 __attribute__((unused)) void *opaque_arg,
69                 void *_m,
70                 __attribute__((unused)) unsigned i)
71 {
72         struct rte_mbuf *m = _m;
73         rte_pktmbuf_init(mp, opaque_arg, _m, i);
74         m->ol_flags |= CTRL_MBUF_FLAG;
75 }
76
77 /*
78  * pktmbuf pool constructor, given as a callback function to
79  * rte_mempool_create(), or called directly if using
80  * rte_mempool_create_empty()/rte_mempool_populate()
81  */
82 void
83 rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg)
84 {
85         struct rte_pktmbuf_pool_private *user_mbp_priv, *mbp_priv;
86         struct rte_pktmbuf_pool_private default_mbp_priv;
87         uint16_t roomsz;
88
89         RTE_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf));
90
91         /* if no structure is provided, assume no mbuf private area */
92         user_mbp_priv = opaque_arg;
93         if (user_mbp_priv == NULL) {
94                 default_mbp_priv.mbuf_priv_size = 0;
95                 if (mp->elt_size > sizeof(struct rte_mbuf))
96                         roomsz = mp->elt_size - sizeof(struct rte_mbuf);
97                 else
98                         roomsz = 0;
99                 default_mbp_priv.mbuf_data_room_size = roomsz;
100                 user_mbp_priv = &default_mbp_priv;
101         }
102
103         RTE_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf) +
104                 user_mbp_priv->mbuf_data_room_size +
105                 user_mbp_priv->mbuf_priv_size);
106
107         mbp_priv = rte_mempool_get_priv(mp);
108         memcpy(mbp_priv, user_mbp_priv, sizeof(*mbp_priv));
109 }
110
111 /*
112  * pktmbuf constructor, given as a callback function to
113  * rte_mempool_obj_iter() or rte_mempool_create().
114  * Set the fields of a packet mbuf to their default values.
115  */
116 void
117 rte_pktmbuf_init(struct rte_mempool *mp,
118                  __attribute__((unused)) void *opaque_arg,
119                  void *_m,
120                  __attribute__((unused)) unsigned i)
121 {
122         struct rte_mbuf *m = _m;
123         uint32_t mbuf_size, buf_len, priv_size;
124
125         priv_size = rte_pktmbuf_priv_size(mp);
126         mbuf_size = sizeof(struct rte_mbuf) + priv_size;
127         buf_len = rte_pktmbuf_data_room_size(mp);
128
129         RTE_ASSERT(RTE_ALIGN(priv_size, RTE_MBUF_PRIV_ALIGN) == priv_size);
130         RTE_ASSERT(mp->elt_size >= mbuf_size);
131         RTE_ASSERT(buf_len <= UINT16_MAX);
132
133         memset(m, 0, mbuf_size);
134         /* start of buffer is after mbuf structure and priv data */
135         m->priv_size = priv_size;
136         m->buf_addr = (char *)m + mbuf_size;
137         m->buf_iova = rte_mempool_virt2iova(m) + mbuf_size;
138         m->buf_len = (uint16_t)buf_len;
139
140         /* keep some headroom between start of buffer and data */
141         m->data_off = RTE_MIN(RTE_PKTMBUF_HEADROOM, (uint16_t)m->buf_len);
142
143         /* init some constant fields */
144         m->pool = mp;
145         m->nb_segs = 1;
146         m->port = MBUF_INVALID_PORT;
147         rte_mbuf_refcnt_set(m, 1);
148         m->next = NULL;
149 }
150
151 /* helper to create a mbuf pool */
152 struct rte_mempool *
153 rte_pktmbuf_pool_create(const char *name, unsigned n,
154         unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
155         int socket_id)
156 {
157         struct rte_mempool *mp;
158         struct rte_pktmbuf_pool_private mbp_priv;
159         const char *mp_ops_name;
160         unsigned elt_size;
161         int ret;
162
163         if (RTE_ALIGN(priv_size, RTE_MBUF_PRIV_ALIGN) != priv_size) {
164                 RTE_LOG(ERR, MBUF, "mbuf priv_size=%u is not aligned\n",
165                         priv_size);
166                 rte_errno = EINVAL;
167                 return NULL;
168         }
169         elt_size = sizeof(struct rte_mbuf) + (unsigned)priv_size +
170                 (unsigned)data_room_size;
171         mbp_priv.mbuf_data_room_size = data_room_size;
172         mbp_priv.mbuf_priv_size = priv_size;
173
174         mp = rte_mempool_create_empty(name, n, elt_size, cache_size,
175                  sizeof(struct rte_pktmbuf_pool_private), socket_id, 0);
176         if (mp == NULL)
177                 return NULL;
178
179         mp_ops_name = rte_eal_mbuf_default_mempool_ops();
180         ret = rte_mempool_set_ops_byname(mp, mp_ops_name, NULL);
181         if (ret != 0) {
182                 RTE_LOG(ERR, MBUF, "error setting mempool handler\n");
183                 rte_mempool_free(mp);
184                 rte_errno = -ret;
185                 return NULL;
186         }
187         rte_pktmbuf_pool_init(mp, &mbp_priv);
188
189         ret = rte_mempool_populate_default(mp);
190         if (ret < 0) {
191                 rte_mempool_free(mp);
192                 rte_errno = -ret;
193                 return NULL;
194         }
195
196         rte_mempool_obj_iter(mp, rte_pktmbuf_init, NULL);
197
198         return mp;
199 }
200
201 /* do some sanity checks on a mbuf: panic if it fails */
202 void
203 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header)
204 {
205         unsigned int nb_segs, pkt_len;
206
207         if (m == NULL)
208                 rte_panic("mbuf is NULL\n");
209
210         /* generic checks */
211         if (m->pool == NULL)
212                 rte_panic("bad mbuf pool\n");
213         if (m->buf_iova == 0)
214                 rte_panic("bad IO addr\n");
215         if (m->buf_addr == NULL)
216                 rte_panic("bad virt addr\n");
217
218         uint16_t cnt = rte_mbuf_refcnt_read(m);
219         if ((cnt == 0) || (cnt == UINT16_MAX))
220                 rte_panic("bad ref cnt\n");
221
222         /* nothing to check for sub-segments */
223         if (is_header == 0)
224                 return;
225
226         /* data_len is supposed to be not more than pkt_len */
227         if (m->data_len > m->pkt_len)
228                 rte_panic("bad data_len\n");
229
230         nb_segs = m->nb_segs;
231         pkt_len = m->pkt_len;
232
233         do {
234                 nb_segs -= 1;
235                 pkt_len -= m->data_len;
236         } while ((m = m->next) != NULL);
237
238         if (nb_segs)
239                 rte_panic("bad nb_segs\n");
240         if (pkt_len)
241                 rte_panic("bad pkt_len\n");
242 }
243
244 /* dump a mbuf on console */
245 void
246 rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len)
247 {
248         unsigned int len;
249         unsigned int nb_segs;
250
251         __rte_mbuf_sanity_check(m, 1);
252
253         fprintf(f, "dump mbuf at %p, iova=%"PRIx64", buf_len=%u\n",
254                m, (uint64_t)m->buf_iova, (unsigned)m->buf_len);
255         fprintf(f, "  pkt_len=%"PRIu32", ol_flags=%"PRIx64", nb_segs=%u, "
256                "in_port=%u\n", m->pkt_len, m->ol_flags,
257                (unsigned)m->nb_segs, (unsigned)m->port);
258         nb_segs = m->nb_segs;
259
260         while (m && nb_segs != 0) {
261                 __rte_mbuf_sanity_check(m, 0);
262
263                 fprintf(f, "  segment at %p, data=%p, data_len=%u\n",
264                         m, rte_pktmbuf_mtod(m, void *), (unsigned)m->data_len);
265                 len = dump_len;
266                 if (len > m->data_len)
267                         len = m->data_len;
268                 if (len != 0)
269                         rte_hexdump(f, NULL, rte_pktmbuf_mtod(m, void *), len);
270                 dump_len -= len;
271                 m = m->next;
272                 nb_segs --;
273         }
274 }
275
276 /* read len data bytes in a mbuf at specified offset (internal) */
277 const void *__rte_pktmbuf_read(const struct rte_mbuf *m, uint32_t off,
278         uint32_t len, void *buf)
279 {
280         const struct rte_mbuf *seg = m;
281         uint32_t buf_off = 0, copy_len;
282
283         if (off + len > rte_pktmbuf_pkt_len(m))
284                 return NULL;
285
286         while (off >= rte_pktmbuf_data_len(seg)) {
287                 off -= rte_pktmbuf_data_len(seg);
288                 seg = seg->next;
289         }
290
291         if (off + len <= rte_pktmbuf_data_len(seg))
292                 return rte_pktmbuf_mtod_offset(seg, char *, off);
293
294         /* rare case: header is split among several segments */
295         while (len > 0) {
296                 copy_len = rte_pktmbuf_data_len(seg) - off;
297                 if (copy_len > len)
298                         copy_len = len;
299                 rte_memcpy((char *)buf + buf_off,
300                         rte_pktmbuf_mtod_offset(seg, char *, off), copy_len);
301                 off = 0;
302                 buf_off += copy_len;
303                 len -= copy_len;
304                 seg = seg->next;
305         }
306
307         return buf;
308 }
309
310 /*
311  * Get the name of a RX offload flag. Must be kept synchronized with flag
312  * definitions in rte_mbuf.h.
313  */
314 const char *rte_get_rx_ol_flag_name(uint64_t mask)
315 {
316         switch (mask) {
317         case PKT_RX_VLAN: return "PKT_RX_VLAN";
318         case PKT_RX_RSS_HASH: return "PKT_RX_RSS_HASH";
319         case PKT_RX_FDIR: return "PKT_RX_FDIR";
320         case PKT_RX_L4_CKSUM_BAD: return "PKT_RX_L4_CKSUM_BAD";
321         case PKT_RX_L4_CKSUM_GOOD: return "PKT_RX_L4_CKSUM_GOOD";
322         case PKT_RX_L4_CKSUM_NONE: return "PKT_RX_L4_CKSUM_NONE";
323         case PKT_RX_IP_CKSUM_BAD: return "PKT_RX_IP_CKSUM_BAD";
324         case PKT_RX_IP_CKSUM_GOOD: return "PKT_RX_IP_CKSUM_GOOD";
325         case PKT_RX_IP_CKSUM_NONE: return "PKT_RX_IP_CKSUM_NONE";
326         case PKT_RX_EIP_CKSUM_BAD: return "PKT_RX_EIP_CKSUM_BAD";
327         case PKT_RX_VLAN_STRIPPED: return "PKT_RX_VLAN_STRIPPED";
328         case PKT_RX_IEEE1588_PTP: return "PKT_RX_IEEE1588_PTP";
329         case PKT_RX_IEEE1588_TMST: return "PKT_RX_IEEE1588_TMST";
330         case PKT_RX_QINQ_STRIPPED: return "PKT_RX_QINQ_STRIPPED";
331         case PKT_RX_LRO: return "PKT_RX_LRO";
332         case PKT_RX_TIMESTAMP: return "PKT_RX_TIMESTAMP";
333         case PKT_RX_SEC_OFFLOAD: return "PKT_RX_SEC_OFFLOAD";
334         case PKT_RX_SEC_OFFLOAD_FAILED: return "PKT_RX_SEC_OFFLOAD_FAILED";
335         default: return NULL;
336         }
337 }
338
339 struct flag_mask {
340         uint64_t flag;
341         uint64_t mask;
342         const char *default_name;
343 };
344
345 /* write the list of rx ol flags in buffer buf */
346 int
347 rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen)
348 {
349         const struct flag_mask rx_flags[] = {
350                 { PKT_RX_VLAN, PKT_RX_VLAN, NULL },
351                 { PKT_RX_RSS_HASH, PKT_RX_RSS_HASH, NULL },
352                 { PKT_RX_FDIR, PKT_RX_FDIR, NULL },
353                 { PKT_RX_L4_CKSUM_BAD, PKT_RX_L4_CKSUM_MASK, NULL },
354                 { PKT_RX_L4_CKSUM_GOOD, PKT_RX_L4_CKSUM_MASK, NULL },
355                 { PKT_RX_L4_CKSUM_NONE, PKT_RX_L4_CKSUM_MASK, NULL },
356                 { PKT_RX_L4_CKSUM_UNKNOWN, PKT_RX_L4_CKSUM_MASK,
357                   "PKT_RX_L4_CKSUM_UNKNOWN" },
358                 { PKT_RX_IP_CKSUM_BAD, PKT_RX_IP_CKSUM_MASK, NULL },
359                 { PKT_RX_IP_CKSUM_GOOD, PKT_RX_IP_CKSUM_MASK, NULL },
360                 { PKT_RX_IP_CKSUM_NONE, PKT_RX_IP_CKSUM_MASK, NULL },
361                 { PKT_RX_IP_CKSUM_UNKNOWN, PKT_RX_IP_CKSUM_MASK,
362                   "PKT_RX_IP_CKSUM_UNKNOWN" },
363                 { PKT_RX_EIP_CKSUM_BAD, PKT_RX_EIP_CKSUM_BAD, NULL },
364                 { PKT_RX_VLAN_STRIPPED, PKT_RX_VLAN_STRIPPED, NULL },
365                 { PKT_RX_IEEE1588_PTP, PKT_RX_IEEE1588_PTP, NULL },
366                 { PKT_RX_IEEE1588_TMST, PKT_RX_IEEE1588_TMST, NULL },
367                 { PKT_RX_QINQ_STRIPPED, PKT_RX_QINQ_STRIPPED, NULL },
368                 { PKT_RX_LRO, PKT_RX_LRO, NULL },
369                 { PKT_RX_TIMESTAMP, PKT_RX_TIMESTAMP, NULL },
370                 { PKT_RX_SEC_OFFLOAD, PKT_RX_SEC_OFFLOAD, NULL },
371                 { PKT_RX_SEC_OFFLOAD_FAILED, PKT_RX_SEC_OFFLOAD_FAILED, NULL },
372                 { PKT_RX_QINQ, PKT_RX_QINQ, NULL },
373         };
374         const char *name;
375         unsigned int i;
376         int ret;
377
378         if (buflen == 0)
379                 return -1;
380
381         buf[0] = '\0';
382         for (i = 0; i < RTE_DIM(rx_flags); i++) {
383                 if ((mask & rx_flags[i].mask) != rx_flags[i].flag)
384                         continue;
385                 name = rte_get_rx_ol_flag_name(rx_flags[i].flag);
386                 if (name == NULL)
387                         name = rx_flags[i].default_name;
388                 ret = snprintf(buf, buflen, "%s ", name);
389                 if (ret < 0)
390                         return -1;
391                 if ((size_t)ret >= buflen)
392                         return -1;
393                 buf += ret;
394                 buflen -= ret;
395         }
396
397         return 0;
398 }
399
400 /*
401  * Get the name of a TX offload flag. Must be kept synchronized with flag
402  * definitions in rte_mbuf.h.
403  */
404 const char *rte_get_tx_ol_flag_name(uint64_t mask)
405 {
406         switch (mask) {
407         case PKT_TX_VLAN_PKT: return "PKT_TX_VLAN_PKT";
408         case PKT_TX_IP_CKSUM: return "PKT_TX_IP_CKSUM";
409         case PKT_TX_TCP_CKSUM: return "PKT_TX_TCP_CKSUM";
410         case PKT_TX_SCTP_CKSUM: return "PKT_TX_SCTP_CKSUM";
411         case PKT_TX_UDP_CKSUM: return "PKT_TX_UDP_CKSUM";
412         case PKT_TX_IEEE1588_TMST: return "PKT_TX_IEEE1588_TMST";
413         case PKT_TX_TCP_SEG: return "PKT_TX_TCP_SEG";
414         case PKT_TX_IPV4: return "PKT_TX_IPV4";
415         case PKT_TX_IPV6: return "PKT_TX_IPV6";
416         case PKT_TX_OUTER_IP_CKSUM: return "PKT_TX_OUTER_IP_CKSUM";
417         case PKT_TX_OUTER_IPV4: return "PKT_TX_OUTER_IPV4";
418         case PKT_TX_OUTER_IPV6: return "PKT_TX_OUTER_IPV6";
419         case PKT_TX_TUNNEL_VXLAN: return "PKT_TX_TUNNEL_VXLAN";
420         case PKT_TX_TUNNEL_GRE: return "PKT_TX_TUNNEL_GRE";
421         case PKT_TX_TUNNEL_IPIP: return "PKT_TX_TUNNEL_IPIP";
422         case PKT_TX_TUNNEL_GENEVE: return "PKT_TX_TUNNEL_GENEVE";
423         case PKT_TX_TUNNEL_MPLSINUDP: return "PKT_TX_TUNNEL_MPLSINUDP";
424         case PKT_TX_MACSEC: return "PKT_TX_MACSEC";
425         case PKT_TX_SEC_OFFLOAD: return "PKT_TX_SEC_OFFLOAD";
426         default: return NULL;
427         }
428 }
429
430 /* write the list of tx ol flags in buffer buf */
431 int
432 rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen)
433 {
434         const struct flag_mask tx_flags[] = {
435                 { PKT_TX_VLAN_PKT, PKT_TX_VLAN_PKT, NULL },
436                 { PKT_TX_IP_CKSUM, PKT_TX_IP_CKSUM, NULL },
437                 { PKT_TX_TCP_CKSUM, PKT_TX_L4_MASK, NULL },
438                 { PKT_TX_SCTP_CKSUM, PKT_TX_L4_MASK, NULL },
439                 { PKT_TX_UDP_CKSUM, PKT_TX_L4_MASK, NULL },
440                 { PKT_TX_L4_NO_CKSUM, PKT_TX_L4_MASK, "PKT_TX_L4_NO_CKSUM" },
441                 { PKT_TX_IEEE1588_TMST, PKT_TX_IEEE1588_TMST, NULL },
442                 { PKT_TX_TCP_SEG, PKT_TX_TCP_SEG, NULL },
443                 { PKT_TX_IPV4, PKT_TX_IPV4, NULL },
444                 { PKT_TX_IPV6, PKT_TX_IPV6, NULL },
445                 { PKT_TX_OUTER_IP_CKSUM, PKT_TX_OUTER_IP_CKSUM, NULL },
446                 { PKT_TX_OUTER_IPV4, PKT_TX_OUTER_IPV4, NULL },
447                 { PKT_TX_OUTER_IPV6, PKT_TX_OUTER_IPV6, NULL },
448                 { PKT_TX_TUNNEL_VXLAN, PKT_TX_TUNNEL_MASK,
449                   "PKT_TX_TUNNEL_NONE" },
450                 { PKT_TX_TUNNEL_GRE, PKT_TX_TUNNEL_MASK,
451                   "PKT_TX_TUNNEL_NONE" },
452                 { PKT_TX_TUNNEL_IPIP, PKT_TX_TUNNEL_MASK,
453                   "PKT_TX_TUNNEL_NONE" },
454                 { PKT_TX_TUNNEL_GENEVE, PKT_TX_TUNNEL_MASK,
455                   "PKT_TX_TUNNEL_NONE" },
456                 { PKT_TX_TUNNEL_MPLSINUDP, PKT_TX_TUNNEL_MASK,
457                   "PKT_TX_TUNNEL_NONE" },
458                 { PKT_TX_MACSEC, PKT_TX_MACSEC, NULL },
459                 { PKT_TX_SEC_OFFLOAD, PKT_TX_SEC_OFFLOAD, NULL },
460         };
461         const char *name;
462         unsigned int i;
463         int ret;
464
465         if (buflen == 0)
466                 return -1;
467
468         buf[0] = '\0';
469         for (i = 0; i < RTE_DIM(tx_flags); i++) {
470                 if ((mask & tx_flags[i].mask) != tx_flags[i].flag)
471                         continue;
472                 name = rte_get_tx_ol_flag_name(tx_flags[i].flag);
473                 if (name == NULL)
474                         name = tx_flags[i].default_name;
475                 ret = snprintf(buf, buflen, "%s ", name);
476                 if (ret < 0)
477                         return -1;
478                 if ((size_t)ret >= buflen)
479                         return -1;
480                 buf += ret;
481                 buflen -= ret;
482         }
483
484         return 0;
485 }