mbuf: remove build option to disable refcnt
[dpdk.git] / lib / librte_ip_frag / rte_ip_frag.h
index 31b194c..f673728 100644 (file)
 
 /**
  * @file
- * RTE IPv4 Fragmentation and Reassembly
+ * RTE IP Fragmentation and Reassembly
  *
- * Implementation of IPv4 packet fragmentation and reassembly.
+ * Implementation of IP packet fragmentation and reassembly.
  */
 
+#ifdef __cplusplus
+extern "C" {
+#endif
+
 #include <stdint.h>
 #include <stdio.h>
 
 #include <rte_malloc.h>
 #include <rte_mbuf.h>
+#include <rte_memory.h>
 #include <rte_ip.h>
+#include <rte_byteorder.h>
 
 enum {
        IP_LAST_FRAG_IDX,    /**< index of last fragment */
@@ -65,16 +71,17 @@ struct ip_frag {
 
 /** @internal <src addr, dst_addr, id> to uniquely indetify fragmented datagram. */
 struct ip_frag_key {
-       uint64_t src_dst;      /**< src address */
+       uint64_t src_dst[4];      /**< src address, first 8 bytes used for IPv4 */
        uint32_t id;           /**< dst address */
+       uint32_t key_len;      /**< src/dst key length */
 };
 
 /*
  * @internal Fragmented packet to reassemble.
  * First two entries in the frags[] array are for the last and first fragments.
  */
-struct rte_ip_frag_pkt {
-       TAILQ_ENTRY(rte_ip_frag_pkt) lru;   /**< LRU list */
+struct ip_frag_pkt {
+       TAILQ_ENTRY(ip_frag_pkt) lru;   /**< LRU list */
        struct ip_frag_key key;           /**< fragmentation key */
        uint64_t             start;       /**< creation timestamp */
        uint32_t             total_size;  /**< expected reassembled size */
@@ -92,10 +99,10 @@ struct rte_ip_frag_death_row {
        /**< mbufs to be freed */
 };
 
-TAILQ_HEAD(rte_ip_pkt_list, rte_ip_frag_pkt); /**< @internal fragments tailq */
+TAILQ_HEAD(ip_pkt_list, ip_frag_pkt); /**< @internal fragments tailq */
 
 /** fragmentation table statistics */
-struct rte_ip_frag_tbl_stat {
+struct ip_frag_tbl_stat {
        uint64_t find_num;      /**< total # of find/insert attempts. */
        uint64_t add_num;       /**< # of add ops. */
        uint64_t del_num;       /**< # of del ops. */
@@ -113,10 +120,10 @@ struct rte_ip_frag_tbl {
        uint32_t             bucket_entries;  /**< hash assocaitivity. */
        uint32_t             nb_entries;      /**< total size of the table. */
        uint32_t             nb_buckets;      /**< num of associativity lines. */
-       struct rte_ip_frag_pkt *last;         /**< last used entry. */
-       struct rte_ip_pkt_list lru;           /**< LRU list for table entries. */
-       struct rte_ip_frag_tbl_stat stat;     /**< statistics counters. */
-       struct rte_ip_frag_pkt pkt[0];        /**< hash table. */
+       struct ip_frag_pkt *last;         /**< last used entry. */
+       struct ip_pkt_list lru;           /**< LRU list for table entries. */
+       struct ip_frag_tbl_stat stat;     /**< statistics counters. */
+       struct ip_frag_pkt pkt[0];        /**< hash table. */
 };
 
 /** IPv6 fragment extension header */
@@ -173,6 +180,82 @@ rte_ip_frag_table_destroy( struct rte_ip_frag_tbl *tbl)
        rte_free(tbl);
 }
 
+/**
+ * This function implements the fragmentation of IPv6 packets.
+ *
+ * @param pkt_in
+ *   The input packet.
+ * @param pkts_out
+ *   Array storing the output fragments.
+ * @param nb_pkts_out
+ *   Number of fragments.
+ * @param mtu_size
+ *   Size in bytes of the Maximum Transfer Unit (MTU) for the outgoing IPv6
+ *   datagrams. This value includes the size of the IPv6 header.
+ * @param pool_direct
+ *   MBUF pool used for allocating direct buffers for the output fragments.
+ * @param pool_indirect
+ *   MBUF pool used for allocating indirect buffers for the output fragments.
+ * @return
+ *   Upon successful completion - number of output fragments placed
+ *   in the pkts_out array.
+ *   Otherwise - (-1) * errno.
+ */
+int32_t
+rte_ipv6_fragment_packet(struct rte_mbuf *pkt_in,
+               struct rte_mbuf **pkts_out,
+               uint16_t nb_pkts_out,
+               uint16_t mtu_size,
+               struct rte_mempool *pool_direct,
+               struct rte_mempool *pool_indirect);
+
+/*
+ * This function implements reassembly of fragmented IPv6 packets.
+ * Incoming mbuf should have its l2_len/l3_len fields setup correctly.
+ *
+ * @param tbl
+ *   Table where to lookup/add the fragmented packet.
+ * @param dr
+ *   Death row to free buffers to
+ * @param mb
+ *   Incoming mbuf with IPv6 fragment.
+ * @param tms
+ *   Fragment arrival timestamp.
+ * @param ip_hdr
+ *   Pointer to the IPv6 header.
+ * @param frag_hdr
+ *   Pointer to the IPv6 fragment extension header.
+ * @return
+ *   Pointer to mbuf for reassembled packet, or NULL if:
+ *   - an error occured.
+ *   - not all fragments of the packet are collected yet.
+ */
+struct rte_mbuf *rte_ipv6_frag_reassemble_packet(struct rte_ip_frag_tbl *tbl,
+               struct rte_ip_frag_death_row *dr,
+               struct rte_mbuf *mb, uint64_t tms, struct ipv6_hdr *ip_hdr,
+               struct ipv6_extension_fragment *frag_hdr);
+
+/*
+ * Return a pointer to the packet's fragment header, if found.
+ * It only looks at the extension header that's right after the fixed IPv6
+ * header, and doesn't follow the whole chain of extension headers.
+ *
+ * @param hdr
+ *   Pointer to the IPv6 header.
+ * @return
+ *   Pointer to the IPv6 fragment extension header, or NULL if it's not
+ *   present.
+ */
+static inline struct ipv6_extension_fragment *
+rte_ipv6_frag_get_ipv6_fragment_header(struct ipv6_hdr *hdr)
+{
+       if (hdr->proto == IPPROTO_FRAGMENT) {
+               return (struct ipv6_extension_fragment *) ++hdr;
+       }
+       else
+               return NULL;
+}
+
 /**
  * IPv4 fragmentation.
  *
@@ -196,7 +279,7 @@ rte_ip_frag_table_destroy( struct rte_ip_frag_tbl *tbl)
  *   in the pkts_out array.
  *   Otherwise - (-1) * errno.
  */
-int32_t rte_ipv4_fragmentation(struct rte_mbuf *pkt_in,
+int32_t rte_ipv4_fragment_packet(struct rte_mbuf *pkt_in,
                        struct rte_mbuf **pkts_out,
                        uint16_t nb_pkts_out, uint16_t mtu_size,
                        struct rte_mempool *pool_direct,
@@ -267,4 +350,8 @@ void rte_ip_frag_free_death_row(struct rte_ip_frag_death_row *dr,
 void
 rte_ip_frag_table_statistics_dump(FILE * f, const struct rte_ip_frag_tbl *tbl);
 
+#ifdef __cplusplus
+}
+#endif
+
 #endif /* _RTE_IP_FRAG_H_ */