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_mempool.h>
  57 #include <rte_mbuf.h>
  58 #include <rte_string_fns.h>
  59 #include <rte_hexdump.h>
  60 #include <rte_errno.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_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_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, priv_size;
 123
 124         priv_size = rte_pktmbuf_priv_size(mp);
 125         mbuf_size = sizeof(struct rte_mbuf) + priv_size;
 126         buf_len = rte_pktmbuf_data_room_size(mp);
 127
 128         RTE_ASSERT(RTE_ALIGN(priv_size, RTE_MBUF_PRIV_ALIGN) == priv_size);
 129         RTE_ASSERT(mp->elt_size >= mbuf_size);
 130         RTE_ASSERT(buf_len <= UINT16_MAX);
 131
 132         memset(m, 0, mp->elt_size);
 133
 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_physaddr = rte_mempool_virt2phy(mp, 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 = 0xff;
 147 }
 148
 149 /* helper to create a mbuf pool */
 150 struct rte_mempool *
 151 rte_pktmbuf_pool_create(const char *name, unsigned n,
 152         unsigned cache_size, uint16_t priv_size, uint16_t data_room_size,
 153         int socket_id)
 154 {
 155         struct rte_mempool *mp;
 156         struct rte_pktmbuf_pool_private mbp_priv;
 157         unsigned elt_size;
 158         int ret;
 159
 160         if (RTE_ALIGN(priv_size, RTE_MBUF_PRIV_ALIGN) != priv_size) {
 161                 RTE_LOG(ERR, MBUF, "mbuf priv_size=%u is not aligned\n",
 162                         priv_size);
 163                 rte_errno = EINVAL;
 164                 return NULL;
 165         }
 166         elt_size = sizeof(struct rte_mbuf) + (unsigned)priv_size +
 167                 (unsigned)data_room_size;
 168         mbp_priv.mbuf_data_room_size = data_room_size;
 169         mbp_priv.mbuf_priv_size = priv_size;
 170
 171         mp = rte_mempool_create_empty(name, n, elt_size, cache_size,
 172                  sizeof(struct rte_pktmbuf_pool_private), socket_id, 0);
 173         if (mp == NULL)
 174                 return NULL;
 175
 176         ret = rte_mempool_set_ops_byname(mp,
 177                 RTE_MBUF_DEFAULT_MEMPOOL_OPS, NULL);
 178         if (ret != 0) {
 179                 RTE_LOG(ERR, MBUF, "error setting mempool handler\n");
 180                 rte_mempool_free(mp);
 181                 rte_errno = -ret;
 182                 return NULL;
 183         }
 184         rte_pktmbuf_pool_init(mp, &mbp_priv);
 185
 186         ret = rte_mempool_populate_default(mp);
 187         if (ret < 0) {
 188                 rte_mempool_free(mp);
 189                 rte_errno = -ret;
 190                 return NULL;
 191         }
 192
 193         rte_mempool_obj_iter(mp, rte_pktmbuf_init, NULL);
 194
 195         return mp;
 196 }
 197
 198 /* do some sanity checks on a mbuf: panic if it fails */
 199 void
 200 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header)
 201 {
 202         const struct rte_mbuf *m_seg;
 203         unsigned nb_segs;
 204
 205         if (m == NULL)
 206                 rte_panic("mbuf is NULL\n");
 207
 208         /* generic checks */
 209         if (m->pool == NULL)
 210                 rte_panic("bad mbuf pool\n");
 211         if (m->buf_physaddr == 0)
 212                 rte_panic("bad phys addr\n");
 213         if (m->buf_addr == NULL)
 214                 rte_panic("bad virt addr\n");
 215
 216         uint16_t cnt = rte_mbuf_refcnt_read(m);
 217         if ((cnt == 0) || (cnt == UINT16_MAX))
 218                 rte_panic("bad ref cnt\n");
 219
 220         /* nothing to check for sub-segments */
 221         if (is_header == 0)
 222                 return;
 223
 224         nb_segs = m->nb_segs;
 225         m_seg = m;
 226         while (m_seg && nb_segs != 0) {
 227                 m_seg = m_seg->next;
 228                 nb_segs--;
 229         }
 230         if (nb_segs != 0)
 231                 rte_panic("bad nb_segs\n");
 232 }
 233
 234 /* dump a mbuf on console */
 235 void
 236 rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len)
 237 {
 238         unsigned int len;
 239         unsigned nb_segs;
 240
 241         __rte_mbuf_sanity_check(m, 1);
 242
 243         fprintf(f, "dump mbuf at %p, phys=%"PRIx64", buf_len=%u\n",
 244                m, (uint64_t)m->buf_physaddr, (unsigned)m->buf_len);
 245         fprintf(f, "  pkt_len=%"PRIu32", ol_flags=%"PRIx64", nb_segs=%u, "
 246                "in_port=%u\n", m->pkt_len, m->ol_flags,
 247                (unsigned)m->nb_segs, (unsigned)m->port);
 248         nb_segs = m->nb_segs;
 249
 250         while (m && nb_segs != 0) {
 251                 __rte_mbuf_sanity_check(m, 0);
 252
 253                 fprintf(f, "  segment at %p, data=%p, data_len=%u\n",
 254                         m, rte_pktmbuf_mtod(m, void *), (unsigned)m->data_len);
 255                 len = dump_len;
 256                 if (len > m->data_len)
 257                         len = m->data_len;
 258                 if (len != 0)
 259                         rte_hexdump(f, NULL, rte_pktmbuf_mtod(m, void *), len);
 260                 dump_len -= len;
 261                 m = m->next;
 262                 nb_segs --;
 263         }
 264 }
 265
 266 /*
 267  * Get the name of a RX offload flag. Must be kept synchronized with flag
 268  * definitions in rte_mbuf.h.
 269  */
 270 const char *rte_get_rx_ol_flag_name(uint64_t mask)
 271 {
 272         switch (mask) {
 273         case PKT_RX_VLAN_PKT: return "PKT_RX_VLAN_PKT";
 274         case PKT_RX_RSS_HASH: return "PKT_RX_RSS_HASH";
 275         case PKT_RX_FDIR: return "PKT_RX_FDIR";
 276         case PKT_RX_L4_CKSUM_BAD: return "PKT_RX_L4_CKSUM_BAD";
 277         case PKT_RX_IP_CKSUM_BAD: return "PKT_RX_IP_CKSUM_BAD";
 278         case PKT_RX_EIP_CKSUM_BAD: return "PKT_RX_EIP_CKSUM_BAD";
 279         case PKT_RX_VLAN_STRIPPED: return "PKT_RX_VLAN_STRIPPED";
 280         case PKT_RX_IEEE1588_PTP: return "PKT_RX_IEEE1588_PTP";
 281         case PKT_RX_IEEE1588_TMST: return "PKT_RX_IEEE1588_TMST";
 282         case PKT_RX_QINQ_STRIPPED: return "PKT_RX_QINQ_STRIPPED";
 283         default: return NULL;
 284         }
 285 }
 286
 287 /*
 288  * Get the name of a TX offload flag. Must be kept synchronized with flag
 289  * definitions in rte_mbuf.h.
 290  */
 291 const char *rte_get_tx_ol_flag_name(uint64_t mask)
 292 {
 293         switch (mask) {
 294         case PKT_TX_VLAN_PKT: return "PKT_TX_VLAN_PKT";
 295         case PKT_TX_IP_CKSUM: return "PKT_TX_IP_CKSUM";
 296         case PKT_TX_TCP_CKSUM: return "PKT_TX_TCP_CKSUM";
 297         case PKT_TX_SCTP_CKSUM: return "PKT_TX_SCTP_CKSUM";
 298         case PKT_TX_UDP_CKSUM: return "PKT_TX_UDP_CKSUM";
 299         case PKT_TX_IEEE1588_TMST: return "PKT_TX_IEEE1588_TMST";
 300         case PKT_TX_TCP_SEG: return "PKT_TX_TCP_SEG";
 301         case PKT_TX_IPV4: return "PKT_TX_IPV4";
 302         case PKT_TX_IPV6: return "PKT_TX_IPV6";
 303         case PKT_TX_OUTER_IP_CKSUM: return "PKT_TX_OUTER_IP_CKSUM";
 304         case PKT_TX_OUTER_IPV4: return "PKT_TX_OUTER_IPV4";
 305         case PKT_TX_OUTER_IPV6: return "PKT_TX_OUTER_IPV6";
 306         default: return NULL;
 307         }
 308 }