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 #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, mp->elt_size);
 135
 136         /* start of buffer is after mbuf structure and priv data */
 137         m->priv_size = priv_size;
 138         m->buf_addr = (char *)m + mbuf_size;
 139         m->buf_physaddr = rte_mempool_virt2phy(mp, m) + mbuf_size;
 140         m->buf_len = (uint16_t)buf_len;
 141
 142         /* keep some headroom between start of buffer and data */
 143         m->data_off = RTE_MIN(RTE_PKTMBUF_HEADROOM, (uint16_t)m->buf_len);
 144
 145         /* init some constant fields */
 146         m->pool = mp;
 147         m->nb_segs = 1;
 148         m->port = 0xff;
 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         unsigned elt_size;
 160         int ret;
 161
 162         if (RTE_ALIGN(priv_size, RTE_MBUF_PRIV_ALIGN) != priv_size) {
 163                 RTE_LOG(ERR, MBUF, "mbuf priv_size=%u is not aligned\n",
 164                         priv_size);
 165                 rte_errno = EINVAL;
 166                 return NULL;
 167         }
 168         elt_size = sizeof(struct rte_mbuf) + (unsigned)priv_size +
 169                 (unsigned)data_room_size;
 170         mbp_priv.mbuf_data_room_size = data_room_size;
 171         mbp_priv.mbuf_priv_size = priv_size;
 172
 173         mp = rte_mempool_create_empty(name, n, elt_size, cache_size,
 174                  sizeof(struct rte_pktmbuf_pool_private), socket_id, 0);
 175         if (mp == NULL)
 176                 return NULL;
 177
 178         ret = rte_mempool_set_ops_byname(mp,
 179                 RTE_MBUF_DEFAULT_MEMPOOL_OPS, NULL);
 180         if (ret != 0) {
 181                 RTE_LOG(ERR, MBUF, "error setting mempool handler\n");
 182                 rte_mempool_free(mp);
 183                 rte_errno = -ret;
 184                 return NULL;
 185         }
 186         rte_pktmbuf_pool_init(mp, &mbp_priv);
 187
 188         ret = rte_mempool_populate_default(mp);
 189         if (ret < 0) {
 190                 rte_mempool_free(mp);
 191                 rte_errno = -ret;
 192                 return NULL;
 193         }
 194
 195         rte_mempool_obj_iter(mp, rte_pktmbuf_init, NULL);
 196
 197         return mp;
 198 }
 199
 200 /* do some sanity checks on a mbuf: panic if it fails */
 201 void
 202 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header)
 203 {
 204         const struct rte_mbuf *m_seg;
 205         unsigned nb_segs;
 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_physaddr == 0)
 214                 rte_panic("bad phys 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         nb_segs = m->nb_segs;
 227         m_seg = m;
 228         while (m_seg && nb_segs != 0) {
 229                 m_seg = m_seg->next;
 230                 nb_segs--;
 231         }
 232         if (nb_segs != 0)
 233                 rte_panic("bad nb_segs\n");
 234 }
 235
 236 /* dump a mbuf on console */
 237 void
 238 rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len)
 239 {
 240         unsigned int len;
 241         unsigned nb_segs;
 242
 243         __rte_mbuf_sanity_check(m, 1);
 244
 245         fprintf(f, "dump mbuf at %p, phys=%"PRIx64", buf_len=%u\n",
 246                m, (uint64_t)m->buf_physaddr, (unsigned)m->buf_len);
 247         fprintf(f, "  pkt_len=%"PRIu32", ol_flags=%"PRIx64", nb_segs=%u, "
 248                "in_port=%u\n", m->pkt_len, m->ol_flags,
 249                (unsigned)m->nb_segs, (unsigned)m->port);
 250         nb_segs = m->nb_segs;
 251
 252         while (m && nb_segs != 0) {
 253                 __rte_mbuf_sanity_check(m, 0);
 254
 255                 fprintf(f, "  segment at %p, data=%p, data_len=%u\n",
 256                         m, rte_pktmbuf_mtod(m, void *), (unsigned)m->data_len);
 257                 len = dump_len;
 258                 if (len > m->data_len)
 259                         len = m->data_len;
 260                 if (len != 0)
 261                         rte_hexdump(f, NULL, rte_pktmbuf_mtod(m, void *), len);
 262                 dump_len -= len;
 263                 m = m->next;
 264                 nb_segs --;
 265         }
 266 }
 267
 268 /* read len data bytes in a mbuf at specified offset (internal) */
 269 const void *__rte_pktmbuf_read(const struct rte_mbuf *m, uint32_t off,
 270         uint32_t len, void *buf)
 271 {
 272         const struct rte_mbuf *seg = m;
 273         uint32_t buf_off = 0, copy_len;
 274
 275         if (off + len > rte_pktmbuf_pkt_len(m))
 276                 return NULL;
 277
 278         while (off >= rte_pktmbuf_data_len(seg)) {
 279                 off -= rte_pktmbuf_data_len(seg);
 280                 seg = seg->next;
 281         }
 282
 283         if (off + len <= rte_pktmbuf_data_len(seg))
 284                 return rte_pktmbuf_mtod_offset(seg, char *, off);
 285
 286         /* rare case: header is split among several segments */
 287         while (len > 0) {
 288                 copy_len = rte_pktmbuf_data_len(seg) - off;
 289                 if (copy_len > len)
 290                         copy_len = len;
 291                 rte_memcpy((char *)buf + buf_off,
 292                         rte_pktmbuf_mtod_offset(seg, char *, off), copy_len);
 293                 off = 0;
 294                 buf_off += copy_len;
 295                 len -= copy_len;
 296                 seg = seg->next;
 297         }
 298
 299         return buf;
 300 }
 301
 302 /*
 303  * Get the name of a RX offload flag. Must be kept synchronized with flag
 304  * definitions in rte_mbuf.h.
 305  */
 306 const char *rte_get_rx_ol_flag_name(uint64_t mask)
 307 {
 308         switch (mask) {
 309         case PKT_RX_VLAN_PKT: return "PKT_RX_VLAN_PKT";
 310         case PKT_RX_RSS_HASH: return "PKT_RX_RSS_HASH";
 311         case PKT_RX_FDIR: return "PKT_RX_FDIR";
 312         case PKT_RX_L4_CKSUM_BAD: return "PKT_RX_L4_CKSUM_BAD";
 313         case PKT_RX_L4_CKSUM_GOOD: return "PKT_RX_L4_CKSUM_GOOD";
 314         case PKT_RX_L4_CKSUM_NONE: return "PKT_RX_L4_CKSUM_NONE";
 315         case PKT_RX_IP_CKSUM_BAD: return "PKT_RX_IP_CKSUM_BAD";
 316         case PKT_RX_IP_CKSUM_GOOD: return "PKT_RX_IP_CKSUM_GOOD";
 317         case PKT_RX_IP_CKSUM_NONE: return "PKT_RX_IP_CKSUM_NONE";
 318         case PKT_RX_EIP_CKSUM_BAD: return "PKT_RX_EIP_CKSUM_BAD";
 319         case PKT_RX_VLAN_STRIPPED: return "PKT_RX_VLAN_STRIPPED";
 320         case PKT_RX_IEEE1588_PTP: return "PKT_RX_IEEE1588_PTP";
 321         case PKT_RX_IEEE1588_TMST: return "PKT_RX_IEEE1588_TMST";
 322         case PKT_RX_QINQ_STRIPPED: return "PKT_RX_QINQ_STRIPPED";
 323         case PKT_RX_LRO: return "PKT_RX_LRO";
 324         default: return NULL;
 325         }
 326 }
 327
 328 struct flag_mask {
 329         uint64_t flag;
 330         uint64_t mask;
 331         const char *default_name;
 332 };
 333
 334 /* write the list of rx ol flags in buffer buf */
 335 int
 336 rte_get_rx_ol_flag_list(uint64_t mask, char *buf, size_t buflen)
 337 {
 338         const struct flag_mask rx_flags[] = {
 339                 { PKT_RX_VLAN_PKT, PKT_RX_VLAN_PKT, NULL },
 340                 { PKT_RX_RSS_HASH, PKT_RX_RSS_HASH, NULL },
 341                 { PKT_RX_FDIR, PKT_RX_FDIR, NULL },
 342                 { PKT_RX_L4_CKSUM_BAD, PKT_RX_L4_CKSUM_MASK, NULL },
 343                 { PKT_RX_L4_CKSUM_GOOD, PKT_RX_L4_CKSUM_MASK, NULL },
 344                 { PKT_RX_L4_CKSUM_NONE, PKT_RX_L4_CKSUM_MASK, NULL },
 345                 { PKT_RX_L4_CKSUM_UNKNOWN, PKT_RX_L4_CKSUM_MASK,
 346                   "PKT_RX_L4_CKSUM_UNKNOWN" },
 347                 { PKT_RX_IP_CKSUM_BAD, PKT_RX_IP_CKSUM_MASK, NULL },
 348                 { PKT_RX_IP_CKSUM_GOOD, PKT_RX_IP_CKSUM_MASK, NULL },
 349                 { PKT_RX_IP_CKSUM_NONE, PKT_RX_IP_CKSUM_MASK, NULL },
 350                 { PKT_RX_IP_CKSUM_UNKNOWN, PKT_RX_IP_CKSUM_MASK,
 351                   "PKT_RX_IP_CKSUM_UNKNOWN" },
 352                 { PKT_RX_EIP_CKSUM_BAD, PKT_RX_EIP_CKSUM_BAD, NULL },
 353                 { PKT_RX_VLAN_STRIPPED, PKT_RX_VLAN_STRIPPED, NULL },
 354                 { PKT_RX_IEEE1588_PTP, PKT_RX_IEEE1588_PTP, NULL },
 355                 { PKT_RX_IEEE1588_TMST, PKT_RX_IEEE1588_TMST, NULL },
 356                 { PKT_RX_QINQ_STRIPPED, PKT_RX_QINQ_STRIPPED, NULL },
 357                 { PKT_RX_LRO, PKT_RX_LRO, NULL },
 358         };
 359         const char *name;
 360         unsigned int i;
 361         int ret;
 362
 363         if (buflen == 0)
 364                 return -1;
 365
 366         buf[0] = '\0';
 367         for (i = 0; i < RTE_DIM(rx_flags); i++) {
 368                 if ((mask & rx_flags[i].mask) != rx_flags[i].flag)
 369                         continue;
 370                 name = rte_get_rx_ol_flag_name(rx_flags[i].flag);
 371                 if (name == NULL)
 372                         name = rx_flags[i].default_name;
 373                 ret = snprintf(buf, buflen, "%s ", name);
 374                 if (ret < 0)
 375                         return -1;
 376                 if ((size_t)ret >= buflen)
 377                         return -1;
 378                 buf += ret;
 379                 buflen -= ret;
 380         }
 381
 382         return 0;
 383 }
 384
 385 /*
 386  * Get the name of a TX offload flag. Must be kept synchronized with flag
 387  * definitions in rte_mbuf.h.
 388  */
 389 const char *rte_get_tx_ol_flag_name(uint64_t mask)
 390 {
 391         switch (mask) {
 392         case PKT_TX_VLAN_PKT: return "PKT_TX_VLAN_PKT";
 393         case PKT_TX_IP_CKSUM: return "PKT_TX_IP_CKSUM";
 394         case PKT_TX_TCP_CKSUM: return "PKT_TX_TCP_CKSUM";
 395         case PKT_TX_SCTP_CKSUM: return "PKT_TX_SCTP_CKSUM";
 396         case PKT_TX_UDP_CKSUM: return "PKT_TX_UDP_CKSUM";
 397         case PKT_TX_IEEE1588_TMST: return "PKT_TX_IEEE1588_TMST";
 398         case PKT_TX_TCP_SEG: return "PKT_TX_TCP_SEG";
 399         case PKT_TX_IPV4: return "PKT_TX_IPV4";
 400         case PKT_TX_IPV6: return "PKT_TX_IPV6";
 401         case PKT_TX_OUTER_IP_CKSUM: return "PKT_TX_OUTER_IP_CKSUM";
 402         case PKT_TX_OUTER_IPV4: return "PKT_TX_OUTER_IPV4";
 403         case PKT_TX_OUTER_IPV6: return "PKT_TX_OUTER_IPV6";
 404         case PKT_TX_TUNNEL_VXLAN: return "PKT_TX_TUNNEL_VXLAN";
 405         case PKT_TX_TUNNEL_GRE: return "PKT_TX_TUNNEL_GRE";
 406         case PKT_TX_TUNNEL_IPIP: return "PKT_TX_TUNNEL_IPIP";
 407         case PKT_TX_TUNNEL_GENEVE: return "PKT_TX_TUNNEL_GENEVE";
 408         case PKT_TX_MACSEC: return "PKT_TX_MACSEC";
 409         default: return NULL;
 410         }
 411 }
 412
 413 /* write the list of tx ol flags in buffer buf */
 414 int
 415 rte_get_tx_ol_flag_list(uint64_t mask, char *buf, size_t buflen)
 416 {
 417         const struct flag_mask tx_flags[] = {
 418                 { PKT_TX_VLAN_PKT, PKT_TX_VLAN_PKT, NULL },
 419                 { PKT_TX_IP_CKSUM, PKT_TX_IP_CKSUM, NULL },
 420                 { PKT_TX_TCP_CKSUM, PKT_TX_L4_MASK, NULL },
 421                 { PKT_TX_SCTP_CKSUM, PKT_TX_L4_MASK, NULL },
 422                 { PKT_TX_UDP_CKSUM, PKT_TX_L4_MASK, NULL },
 423                 { PKT_TX_L4_NO_CKSUM, PKT_TX_L4_MASK, "PKT_TX_L4_NO_CKSUM" },
 424                 { PKT_TX_IEEE1588_TMST, PKT_TX_IEEE1588_TMST, NULL },
 425                 { PKT_TX_TCP_SEG, PKT_TX_TCP_SEG, NULL },
 426                 { PKT_TX_IPV4, PKT_TX_IPV4, NULL },
 427                 { PKT_TX_IPV6, PKT_TX_IPV6, NULL },
 428                 { PKT_TX_OUTER_IP_CKSUM, PKT_TX_OUTER_IP_CKSUM, NULL },
 429                 { PKT_TX_OUTER_IPV4, PKT_TX_OUTER_IPV4, NULL },
 430                 { PKT_TX_OUTER_IPV6, PKT_TX_OUTER_IPV6, NULL },
 431                 { PKT_TX_TUNNEL_VXLAN, PKT_TX_TUNNEL_MASK,
 432                   "PKT_TX_TUNNEL_NONE" },
 433                 { PKT_TX_TUNNEL_GRE, PKT_TX_TUNNEL_MASK,
 434                   "PKT_TX_TUNNEL_NONE" },
 435                 { PKT_TX_TUNNEL_IPIP, PKT_TX_TUNNEL_MASK,
 436                   "PKT_TX_TUNNEL_NONE" },
 437                 { PKT_TX_TUNNEL_GENEVE, PKT_TX_TUNNEL_MASK,
 438                   "PKT_TX_TUNNEL_NONE" },
 439                 { PKT_TX_MACSEC, PKT_TX_MACSEC, NULL },
 440         };
 441         const char *name;
 442         unsigned int i;
 443         int ret;
 444
 445         if (buflen == 0)
 446                 return -1;
 447
 448         buf[0] = '\0';
 449         for (i = 0; i < RTE_DIM(tx_flags); i++) {
 450                 if ((mask & tx_flags[i].mask) != tx_flags[i].flag)
 451                         continue;
 452                 name = rte_get_tx_ol_flag_name(tx_flags[i].flag);
 453                 if (name == NULL)
 454                         name = tx_flags[i].default_name;
 455                 ret = snprintf(buf, buflen, "%s ", name);
 456                 if (ret < 0)
 457                         return -1;
 458                 if ((size_t)ret >= buflen)
 459                         return -1;
 460                 buf += ret;
 461                 buflen -= ret;
 462         }
 463
 464         return 0;
 465 }