lib/librte_mbuf/rte_mbuf.c

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #include <string.h>
  35 #include <stdio.h>
  36 #include <stdlib.h>
  37 #include <stdint.h>
  38 #include <stdarg.h>
  39 #include <inttypes.h>
  40 #include <errno.h>
  41 #include <ctype.h>
  42 #include <sys/queue.h>
  43
  44 #include <rte_debug.h>
  45 #include <rte_common.h>
  46 #include <rte_log.h>
  47 #include <rte_memory.h>
  48 #include <rte_memzone.h>
  49 #include <rte_launch.h>
  50 #include <rte_tailq.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
  74         memset(m, 0, mp->elt_size);
  75
  76         /* start of buffer is just after mbuf structure */
  77         m->buf_addr = (char *)m + sizeof(struct rte_mbuf);
  78         m->buf_physaddr = rte_mempool_virt2phy(mp, m) +
  79                         sizeof(struct rte_mbuf);
  80         m->buf_len = (uint16_t) (mp->elt_size - sizeof(struct rte_mbuf));
  81
  82         /* init some constant fields */
  83         m->type = RTE_MBUF_CTRL;
  84         m->ctrl.data = (char *)m->buf_addr;
  85         m->pool = (struct rte_mempool *)mp;
  86 }
  87
  88 /*
  89  * pktmbuf pool constructor, given as a callback function to
  90  * rte_mempool_create()
  91  */
  92 void
  93 rte_pktmbuf_pool_init(struct rte_mempool *mp, void *opaque_arg)
  94 {
  95         struct rte_pktmbuf_pool_private *mbp_priv;
  96         uint16_t roomsz;
  97
  98         mbp_priv = rte_mempool_get_priv(mp);
  99         roomsz = (uint16_t)(uintptr_t)opaque_arg;
 100
 101         /* Use default data room size. */
 102         if (0 == roomsz)
 103                 roomsz = 2048 + RTE_PKTMBUF_HEADROOM;
 104
 105         mbp_priv->mbuf_data_room_size = roomsz;
 106 }
 107
 108 /*
 109  * pktmbuf constructor, given as a callback function to
 110  * rte_mempool_create().
 111  * Set the fields of a packet mbuf to their default values.
 112  */
 113 void
 114 rte_pktmbuf_init(struct rte_mempool *mp,
 115                  __attribute__((unused)) void *opaque_arg,
 116                  void *_m,
 117                  __attribute__((unused)) unsigned i)
 118 {
 119         struct rte_mbuf *m = _m;
 120         uint32_t buf_len = mp->elt_size - sizeof(struct rte_mbuf);
 121
 122         RTE_MBUF_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf));
 123
 124         memset(m, 0, mp->elt_size);
 125
 126         /* start of buffer is just after mbuf structure */
 127         m->buf_addr = (char *)m + sizeof(struct rte_mbuf);
 128         m->buf_physaddr = rte_mempool_virt2phy(mp, m) +
 129                         sizeof(struct rte_mbuf);
 130         m->buf_len = (uint16_t)buf_len;
 131
 132         /* keep some headroom between start of buffer and data */
 133         m->pkt.data = (char*) m->buf_addr + RTE_MIN(RTE_PKTMBUF_HEADROOM, m->buf_len);
 134
 135         /* init some constant fields */
 136         m->type = RTE_MBUF_PKT;
 137         m->pool = mp;
 138         m->pkt.nb_segs = 1;
 139         m->pkt.in_port = 0xff;
 140 }
 141
 142 /* do some sanity checks on a mbuf: panic if it fails */
 143 void
 144 rte_mbuf_sanity_check(const struct rte_mbuf *m, enum rte_mbuf_type t,
 145                       int is_header)
 146 {
 147         const struct rte_mbuf *m_seg;
 148         unsigned nb_segs;
 149
 150         if (m == NULL)
 151                 rte_panic("mbuf is NULL\n");
 152         if (m->type != (uint8_t)t)
 153                 rte_panic("bad mbuf type\n");
 154
 155         /* generic checks */
 156         if (m->pool == NULL)
 157                 rte_panic("bad mbuf pool\n");
 158         if (m->buf_physaddr == 0)
 159                 rte_panic("bad phys addr\n");
 160         if (m->buf_addr == NULL)
 161                 rte_panic("bad virt addr\n");
 162
 163 #ifdef RTE_MBUF_SCATTER_GATHER
 164         uint16_t cnt = rte_mbuf_refcnt_read(m);
 165         if ((cnt == 0) || (cnt == UINT16_MAX))
 166                 rte_panic("bad ref cnt\n");
 167 #endif
 168
 169         /* nothing to check for ctrl messages */
 170         if (m->type == RTE_MBUF_CTRL)
 171                 return;
 172
 173         /* check pkt consistency */
 174         else if (m->type == RTE_MBUF_PKT) {
 175
 176                 /* nothing to check for sub-segments */
 177                 if (is_header == 0)
 178                         return;
 179
 180                 nb_segs = m->pkt.nb_segs;
 181                 m_seg = m;
 182                 while (m_seg && nb_segs != 0) {
 183                         m_seg = m_seg->pkt.next;
 184                         nb_segs --;
 185                 }
 186                 if (nb_segs != 0)
 187                         rte_panic("bad nb_segs\n");
 188                 return;
 189         }
 190
 191         rte_panic("unknown mbuf type\n");
 192 }
 193
 194 /* dump a mbuf on console */
 195 void
 196 rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len)
 197 {
 198         unsigned int len;
 199         unsigned nb_segs;
 200
 201         __rte_mbuf_sanity_check(m, RTE_MBUF_PKT, 1);
 202
 203         fprintf(f, "dump mbuf at 0x%p, phys=%"PRIx64", buf_len=%u\n",
 204                m, (uint64_t)m->buf_physaddr, (unsigned)m->buf_len);
 205         fprintf(f, "  pkt_len=%"PRIu32", ol_flags=%"PRIx16", nb_segs=%u, "
 206                "in_port=%u\n", m->pkt.pkt_len, m->ol_flags,
 207                (unsigned)m->pkt.nb_segs, (unsigned)m->pkt.in_port);
 208         nb_segs = m->pkt.nb_segs;
 209
 210         while (m && nb_segs != 0) {
 211                 __rte_mbuf_sanity_check(m, RTE_MBUF_PKT, 0);
 212
 213                 fprintf(f, "  segment at 0x%p, data=0x%p, data_len=%u\n",
 214                        m, m->pkt.data, (unsigned)m->pkt.data_len);
 215                 len = dump_len;
 216                 if (len > m->pkt.data_len)
 217                         len = m->pkt.data_len;
 218                 if (len != 0)
 219                         rte_hexdump(f, NULL, m->pkt.data, len);
 220                 dump_len -= len;
 221                 m = m->pkt.next;
 222                 nb_segs --;
 223         }
 224 }