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         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 *mbp_priv;
  85         uint16_t roomsz;
  86
  87         mbp_priv = rte_mempool_get_priv(mp);
  88         roomsz = (uint16_t)(uintptr_t)opaque_arg;
  89
  90         /* Use default data room size. */
  91         if (0 == roomsz)
  92                 roomsz = 2048 + RTE_PKTMBUF_HEADROOM;
  93
  94         mbp_priv->mbuf_data_room_size = roomsz;
  95 }
  96
  97 /*
  98  * pktmbuf constructor, given as a callback function to
  99  * rte_mempool_create().
 100  * Set the fields of a packet mbuf to their default values.
 101  */
 102 void
 103 rte_pktmbuf_init(struct rte_mempool *mp,
 104                  __attribute__((unused)) void *opaque_arg,
 105                  void *_m,
 106                  __attribute__((unused)) unsigned i)
 107 {
 108         struct rte_mbuf *m = _m;
 109         uint32_t buf_len = mp->elt_size - sizeof(struct rte_mbuf);
 110
 111         RTE_MBUF_ASSERT(mp->elt_size >= sizeof(struct rte_mbuf));
 112
 113         memset(m, 0, mp->elt_size);
 114
 115         /* start of buffer is just after mbuf structure */
 116         m->buf_addr = (char *)m + sizeof(struct rte_mbuf);
 117         m->buf_physaddr = rte_mempool_virt2phy(mp, m) +
 118                         sizeof(struct rte_mbuf);
 119         m->buf_len = (uint16_t)buf_len;
 120
 121         /* keep some headroom between start of buffer and data */
 122         m->data_off = RTE_MIN(RTE_PKTMBUF_HEADROOM, (uint16_t)m->buf_len);
 123
 124         /* init some constant fields */
 125         m->pool = mp;
 126         m->nb_segs = 1;
 127         m->port = 0xff;
 128 }
 129
 130 /* do some sanity checks on a mbuf: panic if it fails */
 131 void
 132 rte_mbuf_sanity_check(const struct rte_mbuf *m, int is_header)
 133 {
 134         const struct rte_mbuf *m_seg;
 135         unsigned nb_segs;
 136
 137         if (m == NULL)
 138                 rte_panic("mbuf is NULL\n");
 139
 140         /* generic checks */
 141         if (m->pool == NULL)
 142                 rte_panic("bad mbuf pool\n");
 143         if (m->buf_physaddr == 0)
 144                 rte_panic("bad phys addr\n");
 145         if (m->buf_addr == NULL)
 146                 rte_panic("bad virt addr\n");
 147
 148 #ifdef RTE_MBUF_REFCNT
 149         uint16_t cnt = rte_mbuf_refcnt_read(m);
 150         if ((cnt == 0) || (cnt == UINT16_MAX))
 151                 rte_panic("bad ref cnt\n");
 152 #endif
 153
 154         /* nothing to check for sub-segments */
 155         if (is_header == 0)
 156                 return;
 157
 158         nb_segs = m->nb_segs;
 159         m_seg = m;
 160         while (m_seg && nb_segs != 0) {
 161                 m_seg = m_seg->next;
 162                 nb_segs--;
 163         }
 164         if (nb_segs != 0)
 165                 rte_panic("bad nb_segs\n");
 166 }
 167
 168 /* dump a mbuf on console */
 169 void
 170 rte_pktmbuf_dump(FILE *f, const struct rte_mbuf *m, unsigned dump_len)
 171 {
 172         unsigned int len;
 173         unsigned nb_segs;
 174
 175         __rte_mbuf_sanity_check(m, 1);
 176
 177         fprintf(f, "dump mbuf at 0x%p, phys=%"PRIx64", buf_len=%u\n",
 178                m, (uint64_t)m->buf_physaddr, (unsigned)m->buf_len);
 179         fprintf(f, "  pkt_len=%"PRIu32", ol_flags=%"PRIx64", nb_segs=%u, "
 180                "in_port=%u\n", m->pkt_len, m->ol_flags,
 181                (unsigned)m->nb_segs, (unsigned)m->port);
 182         nb_segs = m->nb_segs;
 183
 184         while (m && nb_segs != 0) {
 185                 __rte_mbuf_sanity_check(m, 0);
 186
 187                 fprintf(f, "  segment at 0x%p, data=0x%p, data_len=%u\n",
 188                         m, rte_pktmbuf_mtod(m, void *), (unsigned)m->data_len);
 189                 len = dump_len;
 190                 if (len > m->data_len)
 191                         len = m->data_len;
 192                 if (len != 0)
 193                         rte_hexdump(f, NULL, rte_pktmbuf_mtod(m, void *), len);
 194                 dump_len -= len;
 195                 m = m->next;
 196                 nb_segs --;
 197         }
 198 }