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_memzone.h>
  50 #include <rte_launch.h>
  51 #include <rte_eal.h>
  52 #include <rte_per_lcore.h>
  53 #include <rte_lcore.h>
  54 #include <rte_atomic.h>
  55 #include <rte_branch_prediction.h>
  56 #include <rte_ring.h>
  57 #include <rte_mempool.h>
  58 #include <rte_mbuf.h>
  59 #include <rte_string_fns.h>
  60 #include <rte_hexdump.h>
  61
  62 /*
  63  * ctrlmbuf constructor, given as a callback function to
  64  * 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()
  80  */
  81 void
  82 rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg)
  83 {
  84         struct rte_pktmbuf_pool_private *user_mbp_priv, *mbp_priv;
  85         struct rte_pktmbuf_pool_private default_mbp_priv;
  86         uint16_t roomsz;
  87
  88         RTE_MBUF_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf));
  89
  90         /* if no structure is provided, assume no mbuf private area */
  91         user_mbp_priv = opaque_arg;
  92         if (user_mbp_priv == NULL) {
  93                 default_mbp_priv.mbuf_priv_size = 0;
  94                 if (mp->elt_size > sizeof(struct rte_mbuf))
  95                         roomsz = mp->elt_size - sizeof(struct rte_mbuf);
  96                 else
  97                         roomsz = 0;
  98                 default_mbp_priv.mbuf_data_room_size = roomsz;
  99                 user_mbp_priv = &default_mbp_priv;
 100         }
 101
 102         RTE_MBUF_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf) +
 103                 user_mbp_priv->mbuf_data_room_size +
 104                 user_mbp_priv->mbuf_priv_size);
 105
 106         mbp_priv = rte_mempool_get_priv(mp);
 107         memcpy(mbp_priv, user_mbp_priv, sizeof(*mbp_priv));
 108 }
 109
 110 /*
 111  * pktmbuf constructor, given as a callback function to
 112  * rte_mempool_create().
 113  * Set the fields of a packet mbuf to their default values.
 114  */
 115 void
 116 rte_pktmbuf_init(struct rte_mempool *mp,
 117                  __attribute__((unused)) void *opaque_arg,
 118                  void *_m,
 119                  __attribute__((unused)) unsigned i)
 120 {
 121         struct rte_mbuf *m = _m;
 122         uint32_t mbuf_size, buf_len;
 123
 124         mbuf_size = sizeof(struct rte_mbuf) + rte_pktmbuf_priv_size(mp);
 125         buf_len = rte_pktmbuf_data_room_size(mp);
 126
 127         RTE_MBUF_ASSERT(mp->elt_size >= mbuf_size);
 128         RTE_MBUF_ASSERT(buf_len <= UINT16_MAX);
 129
 130         memset(m, 0, mp->elt_size);
 131
 132         /* start of buffer is just after mbuf structure */
 133         m->buf_addr = (char *)m + mbuf_size;
 134         m->buf_physaddr = rte_mempool_virt2phy(mp, m) + mbuf_size;
 135         m->buf_len = (uint16_t)buf_len;
 136
 137         /* keep some headroom between start of buffer and data */
 138         m->data_off = RTE_MIN(RTE_PKTMBUF_HEADROOM, (uint16_t)m->buf_len);
 139
 140         /* init some constant fields */
 141         m->pool = mp;
 142         m->nb_segs = 1;
 143         m->port = 0xff;
 144 }
 145
 146 /* helper to create a mbuf pool */
 147 struct rte_mempool *
 148 rte_pktmbuf_pool_create(const char *name, unsigned n,
 149         unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
 150         int socket_id)
 151 {
 152         struct rte_pktmbuf_pool_private mbp_priv;
 153         unsigned elt_size;
 154
 155
 156         elt_size = sizeof(struct rte_mbuf) + (unsigned)priv_size +
 157                 (unsigned)data_room_size;
 158         mbp_priv.mbuf_data_room_size = data_room_size;
 159         mbp_priv.mbuf_priv_size = priv_size;
 160
 161         return rte_mempool_create(name, n, elt_size,
 162                 cache_size, sizeof(struct rte_pktmbuf_pool_private),
 163                 rte_pktmbuf_pool_init, &mbp_priv, rte_pktmbuf_init, NULL,
 164                 socket_id, 0);
 165 }
 166
 167 /* do some sanity checks on a mbuf: panic if it fails */
 168 void
 169 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header)
 170 {
 171         const struct rte_mbuf *m_seg;
 172         unsigned nb_segs;
 173
 174         if (m == NULL)
 175                 rte_panic("mbuf is NULL\n");
 176
 177         /* generic checks */
 178         if (m->pool == NULL)
 179                 rte_panic("bad mbuf pool\n");
 180         if (m->buf_physaddr == 0)
 181                 rte_panic("bad phys addr\n");
 182         if (m->buf_addr == NULL)
 183                 rte_panic("bad virt addr\n");
 184
 185         uint16_t cnt = rte_mbuf_refcnt_read(m);
 186         if ((cnt == 0) || (cnt == UINT16_MAX))
 187                 rte_panic("bad ref cnt\n");
 188
 189         /* nothing to check for sub-segments */
 190         if (is_header == 0)
 191                 return;
 192
 193         nb_segs = m->nb_segs;
 194         m_seg = m;
 195         while (m_seg && nb_segs != 0) {
 196                 m_seg = m_seg->next;
 197                 nb_segs--;
 198         }
 199         if (nb_segs != 0)
 200                 rte_panic("bad nb_segs\n");
 201 }
 202
 203 /* dump a mbuf on console */
 204 void
 205 rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len)
 206 {
 207         unsigned int len;
 208         unsigned nb_segs;
 209
 210         __rte_mbuf_sanity_check(m, 1);
 211
 212         fprintf(f, "dump mbuf at 0x%p, phys=%"PRIx64", buf_len=%u\n",
 213                m, (uint64_t)m->buf_physaddr, (unsigned)m->buf_len);
 214         fprintf(f, "  pkt_len=%"PRIu32", ol_flags=%"PRIx64", nb_segs=%u, "
 215                "in_port=%u\n", m->pkt_len, m->ol_flags,
 216                (unsigned)m->nb_segs, (unsigned)m->port);
 217         nb_segs = m->nb_segs;
 218
 219         while (m && nb_segs != 0) {
 220                 __rte_mbuf_sanity_check(m, 0);
 221
 222                 fprintf(f, "  segment at 0x%p, data=0x%p, data_len=%u\n",
 223                         m, rte_pktmbuf_mtod(m, void *), (unsigned)m->data_len);
 224                 len = dump_len;
 225                 if (len > m->data_len)
 226                         len = m->data_len;
 227                 if (len != 0)
 228                         rte_hexdump(f, NULL, rte_pktmbuf_mtod(m, void *), len);
 229                 dump_len -= len;
 230                 m = m->next;
 231                 nb_segs --;
 232         }
 233 }
 234
 235 /*
 236  * Get the name of a RX offload flag. Must be kept synchronized with flag
 237  * definitions in rte_mbuf.h.
 238  */
 239 const char *rte_get_rx_ol_flag_name(uint64_t mask)
 240 {
 241         switch (mask) {
 242         case PKT_RX_VLAN_PKT: return "PKT_RX_VLAN_PKT";
 243         case PKT_RX_RSS_HASH: return "PKT_RX_RSS_HASH";
 244         case PKT_RX_FDIR: return "PKT_RX_FDIR";
 245         case PKT_RX_L4_CKSUM_BAD: return "PKT_RX_L4_CKSUM_BAD";
 246         case PKT_RX_IP_CKSUM_BAD: return "PKT_RX_IP_CKSUM_BAD";
 247         /* case PKT_RX_EIP_CKSUM_BAD: return "PKT_RX_EIP_CKSUM_BAD"; */
 248         /* case PKT_RX_OVERSIZE: return "PKT_RX_OVERSIZE"; */
 249         /* case PKT_RX_HBUF_OVERFLOW: return "PKT_RX_HBUF_OVERFLOW"; */
 250         /* case PKT_RX_RECIP_ERR: return "PKT_RX_RECIP_ERR"; */
 251         /* case PKT_RX_MAC_ERR: return "PKT_RX_MAC_ERR"; */
 252         case PKT_RX_IPV4_HDR: return "PKT_RX_IPV4_HDR";
 253         case PKT_RX_IPV4_HDR_EXT: return "PKT_RX_IPV4_HDR_EXT";
 254         case PKT_RX_IPV6_HDR: return "PKT_RX_IPV6_HDR";
 255         case PKT_RX_IPV6_HDR_EXT: return "PKT_RX_IPV6_HDR_EXT";
 256         case PKT_RX_IEEE1588_PTP: return "PKT_RX_IEEE1588_PTP";
 257         case PKT_RX_IEEE1588_TMST: return "PKT_RX_IEEE1588_TMST";
 258         case PKT_RX_TUNNEL_IPV4_HDR: return "PKT_RX_TUNNEL_IPV4_HDR";
 259         case PKT_RX_TUNNEL_IPV6_HDR: return "PKT_RX_TUNNEL_IPV6_HDR";
 260         default: return NULL;
 261         }
 262 }
 263
 264 /*
 265  * Get the name of a TX offload flag. Must be kept synchronized with flag
 266  * definitions in rte_mbuf.h.
 267  */
 268 const char *rte_get_tx_ol_flag_name(uint64_t mask)
 269 {
 270         switch (mask) {
 271         case PKT_TX_VLAN_PKT: return "PKT_TX_VLAN_PKT";
 272         case PKT_TX_IP_CKSUM: return "PKT_TX_IP_CKSUM";
 273         case PKT_TX_TCP_CKSUM: return "PKT_TX_TCP_CKSUM";
 274         case PKT_TX_SCTP_CKSUM: return "PKT_TX_SCTP_CKSUM";
 275         case PKT_TX_UDP_CKSUM: return "PKT_TX_UDP_CKSUM";
 276         case PKT_TX_IEEE1588_TMST: return "PKT_TX_IEEE1588_TMST";
 277         case PKT_TX_TCP_SEG: return "PKT_TX_TCP_SEG";
 278         case PKT_TX_IPV4: return "PKT_TX_IPV4";
 279         case PKT_TX_IPV6: return "PKT_TX_IPV6";
 280         case PKT_TX_OUTER_IP_CKSUM: return "PKT_TX_OUTER_IP_CKSUM";
 281         case PKT_TX_OUTER_IPV4: return "PKT_TX_OUTER_IPV4";
 282         case PKT_TX_OUTER_IPV6: return "PKT_TX_OUTER_IPV6";
 283         default: return NULL;
 284         }
 285 }