mbuf: add a copy routine
[dpdk.git] / lib / librte_mbuf / rte_mbuf.h
index 9542488..fb0849a 100644 (file)
@@ -702,7 +702,18 @@ struct rte_mbuf {
                        uint64_t tso_segsz:RTE_MBUF_TSO_SEGSZ_BITS;
                        /**< TCP TSO segment size */
 
-                       /* fields for TX offloading of tunnels */
+                       /*
+                        * Fields for Tx offloading of tunnels.
+                        * These are undefined for packets which don't request
+                        * any tunnel offloads (outer IP or UDP checksum,
+                        * tunnel TSO).
+                        *
+                        * PMDs should not use these fields unconditionally
+                        * when calculating offsets.
+                        *
+                        * Applications are expected to set appropriate tunnel
+                        * offload flags when they fill in these fields.
+                        */
                        uint64_t outer_l3_len:RTE_MBUF_OUTL3_LEN_BITS;
                        /**< Outer L3 (IP) Hdr Length. */
                        uint64_t outer_l2_len:RTE_MBUF_OUTL2_LEN_BITS;
@@ -1673,6 +1684,19 @@ rte_pktmbuf_attach_extbuf(struct rte_mbuf *m, void *buf_addr,
  */
 #define rte_pktmbuf_detach_extbuf(m) rte_pktmbuf_detach(m)
 
+/* internal */
+static inline void
+__rte_pktmbuf_copy_hdr(struct rte_mbuf *mdst, const struct rte_mbuf *msrc)
+{
+       mdst->port = msrc->port;
+       mdst->vlan_tci = msrc->vlan_tci;
+       mdst->vlan_tci_outer = msrc->vlan_tci_outer;
+       mdst->tx_offload = msrc->tx_offload;
+       mdst->hash = msrc->hash;
+       mdst->packet_type = msrc->packet_type;
+       mdst->timestamp = msrc->timestamp;
+}
+
 /**
  * Attach packet mbuf to another packet mbuf.
  *
@@ -1710,23 +1734,17 @@ static inline void rte_pktmbuf_attach(struct rte_mbuf *mi, struct rte_mbuf *m)
                mi->ol_flags = m->ol_flags | IND_ATTACHED_MBUF;
        }
 
-       mi->buf_iova = m->buf_iova;
-       mi->buf_addr = m->buf_addr;
-       mi->buf_len = m->buf_len;
+       __rte_pktmbuf_copy_hdr(mi, m);
 
        mi->data_off = m->data_off;
        mi->data_len = m->data_len;
-       mi->port = m->port;
-       mi->vlan_tci = m->vlan_tci;
-       mi->vlan_tci_outer = m->vlan_tci_outer;
-       mi->tx_offload = m->tx_offload;
-       mi->hash = m->hash;
+       mi->buf_iova = m->buf_iova;
+       mi->buf_addr = m->buf_addr;
+       mi->buf_len = m->buf_len;
 
        mi->next = NULL;
        mi->pkt_len = mi->data_len;
        mi->nb_segs = 1;
-       mi->packet_type = m->packet_type;
-       mi->timestamp = m->timestamp;
 
        __rte_mbuf_sanity_check(mi, 1);
        __rte_mbuf_sanity_check(m, 0);
@@ -1897,7 +1915,7 @@ static inline void rte_pktmbuf_free(struct rte_mbuf *m)
 }
 
 /**
- * Creates a "clone" of the given packet mbuf.
+ * Create a "clone" of the given packet mbuf.
  *
  * Walks through all segments of the given packet mbuf, and for each of them:
  *  - Creates a new packet mbuf from the given pool.
@@ -1913,42 +1931,34 @@ static inline void rte_pktmbuf_free(struct rte_mbuf *m)
  *   - The pointer to the new "clone" mbuf on success.
  *   - NULL if allocation fails.
  */
-static inline struct rte_mbuf *rte_pktmbuf_clone(struct rte_mbuf *md,
-               struct rte_mempool *mp)
-{
-       struct rte_mbuf *mc, *mi, **prev;
-       uint32_t pktlen;
-       uint16_t nseg;
+struct rte_mbuf *
+rte_pktmbuf_clone(struct rte_mbuf *md, struct rte_mempool *mp);
 
-       if (unlikely ((mc = rte_pktmbuf_alloc(mp)) == NULL))
-               return NULL;
-
-       mi = mc;
-       prev = &mi->next;
-       pktlen = md->pkt_len;
-       nseg = 0;
-
-       do {
-               nseg++;
-               rte_pktmbuf_attach(mi, md);
-               *prev = mi;
-               prev = &mi->next;
-       } while ((md = md->next) != NULL &&
-           (mi = rte_pktmbuf_alloc(mp)) != NULL);
-
-       *prev = NULL;
-       mc->nb_segs = nseg;
-       mc->pkt_len = pktlen;
-
-       /* Allocation of new indirect segment failed */
-       if (unlikely (mi == NULL)) {
-               rte_pktmbuf_free(mc);
-               return NULL;
-       }
-
-       __rte_mbuf_sanity_check(mc, 1);
-       return mc;
-}
+/**
+ * Create a full copy of a given packet mbuf.
+ *
+ * Copies all the data from a given packet mbuf to a newly allocated
+ * set of mbufs. The private data are is not copied.
+ *
+ * @param m
+ *   The packet mbuf to be copiedd.
+ * @param mp
+ *   The mempool from which the "clone" mbufs are allocated.
+ * @param offset
+ *   The number of bytes to skip before copying.
+ *   If the mbuf does not have that many bytes, it is an error
+ *   and NULL is returned.
+ * @param length
+ *   The upper limit on bytes to copy.  Passing UINT32_MAX
+ *   means all data (after offset).
+ * @return
+ *   - The pointer to the new "clone" mbuf on success.
+ *   - NULL if allocation fails.
+ */
+__rte_experimental
+struct rte_mbuf *
+rte_pktmbuf_copy(const struct rte_mbuf *m, struct rte_mempool *mp,
+                uint32_t offset, uint32_t length);
 
 /**
  * Adds given value to the refcnt of all packet mbuf segments.
@@ -2389,6 +2399,11 @@ rte_validate_tx_offload(const struct rte_mbuf *m)
        return 0;
 }
 
+/**
+ * @internal used by rte_pktmbuf_linearize().
+ */
+int __rte_pktmbuf_linearize(struct rte_mbuf *mbuf);
+
 /**
  * Linearize data in mbuf.
  *
@@ -2404,40 +2419,9 @@ rte_validate_tx_offload(const struct rte_mbuf *m)
 static inline int
 rte_pktmbuf_linearize(struct rte_mbuf *mbuf)
 {
-       size_t seg_len, copy_len;
-       struct rte_mbuf *m;
-       struct rte_mbuf *m_next;
-       char *buffer;
-
        if (rte_pktmbuf_is_contiguous(mbuf))
                return 0;
-
-       /* Extend first segment to the total packet length */
-       copy_len = rte_pktmbuf_pkt_len(mbuf) - rte_pktmbuf_data_len(mbuf);
-
-       if (unlikely(copy_len > rte_pktmbuf_tailroom(mbuf)))
-               return -1;
-
-       buffer = rte_pktmbuf_mtod_offset(mbuf, char *, mbuf->data_len);
-       mbuf->data_len = (uint16_t)(mbuf->pkt_len);
-
-       /* Append data from next segments to the first one */
-       m = mbuf->next;
-       while (m != NULL) {
-               m_next = m->next;
-
-               seg_len = rte_pktmbuf_data_len(m);
-               rte_memcpy(buffer, rte_pktmbuf_mtod(m, char *), seg_len);
-               buffer += seg_len;
-
-               rte_pktmbuf_free_seg(m);
-               m = m_next;
-       }
-
-       mbuf->next = NULL;
-       mbuf->nb_segs = 1;
-
-       return 0;
+       return __rte_pktmbuf_linearize(mbuf);
 }
 
 /**