net: add rte prefix to IP defines
[dpdk.git] / lib / librte_ip_frag / rte_ip_frag.h
index 13249d3..2273f38 100644 (file)
@@ -1,34 +1,5 @@
-/*-
- *   BSD LICENSE
- *
- *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
- *   All rights reserved.
- *
- *   Redistribution and use in source and binary forms, with or without
- *   modification, are permitted provided that the following conditions
- *   are met:
- *
- *     * Redistributions of source code must retain the above copyright
- *       notice, this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *       notice, this list of conditions and the following disclaimer in
- *       the documentation and/or other materials provided with the
- *       distribution.
- *     * Neither the name of Intel Corporation nor the names of its
- *       contributors may be used to endorse or promote products derived
- *       from this software without specific prior written permission.
- *
- *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2010-2014 Intel Corporation
  */
 
 #ifndef _RTE_IP_FRAG_H_
 
 /**
  * @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_config.h>
 #include <rte_malloc.h>
-#include <rte_mbuf.h>
+#include <rte_memory.h>
 #include <rte_ip.h>
+#include <rte_byteorder.h>
+
+struct rte_mbuf;
 
 enum {
        IP_LAST_FRAG_IDX,    /**< index of last fragment */
@@ -63,19 +42,27 @@ struct ip_frag {
        struct rte_mbuf *mb;   /**< fragment mbuf */
 };
 
-/** @internal <src addr, dst_addr, id> to uniquely indetify fragmented datagram. */
+/** @internal <src addr, dst_addr, id> to uniquely identify fragmented datagram. */
 struct ip_frag_key {
-       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 */
+       uint64_t src_dst[4];
+       /**< src and dst address, only first 8 bytes used for IPv4 */
+       RTE_STD_C11
+       union {
+               uint64_t id_key_len; /**< combined for easy fetch */
+               __extension__
+               struct {
+                       uint32_t id;       /**< packet id */
+                       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 */
@@ -86,17 +73,20 @@ struct rte_ip_frag_pkt {
 
 #define IP_FRAG_DEATH_ROW_LEN 32 /**< death row size (in packets) */
 
+/* death row size in mbufs */
+#define IP_FRAG_DEATH_ROW_MBUF_LEN (IP_FRAG_DEATH_ROW_LEN * (IP_MAX_FRAG_NUM + 1))
+
 /** mbuf death row (packets to be freed) */
 struct rte_ip_frag_death_row {
        uint32_t cnt;          /**< number of mbufs currently on death row */
-       struct rte_mbuf *row[IP_FRAG_DEATH_ROW_LEN * (IP_MAX_FRAG_NUM + 1)];
+       struct rte_mbuf *row[IP_FRAG_DEATH_ROW_MBUF_LEN];
        /**< 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. */
@@ -111,35 +101,41 @@ struct rte_ip_frag_tbl {
        uint32_t             entry_mask;      /**< hash value mask. */
        uint32_t             max_entries;     /**< max entries allowed. */
        uint32_t             use_entries;     /**< entries in use. */
-       uint32_t             bucket_entries;  /**< hash assocaitivity. */
+       uint32_t             bucket_entries;  /**< hash associativity. */
        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. */
+       __extension__ struct ip_frag_pkt pkt[0]; /**< hash table. */
 };
 
 /** IPv6 fragment extension header */
+#define        RTE_IPV6_EHDR_MF_SHIFT                  0
+#define        RTE_IPV6_EHDR_MF_MASK                   1
+#define        RTE_IPV6_EHDR_FO_SHIFT                  3
+#define        RTE_IPV6_EHDR_FO_MASK                   (~((1 << RTE_IPV6_EHDR_FO_SHIFT) - 1))
+#define        RTE_IPV6_EHDR_FO_ALIGN                  (1 << RTE_IPV6_EHDR_FO_SHIFT)
+
+#define RTE_IPV6_FRAG_USED_MASK                        \
+       (RTE_IPV6_EHDR_MF_MASK | RTE_IPV6_EHDR_FO_MASK)
+
+#define RTE_IPV6_GET_MF(x)                             ((x) & RTE_IPV6_EHDR_MF_MASK)
+#define RTE_IPV6_GET_FO(x)                             ((x) >> RTE_IPV6_EHDR_FO_SHIFT)
+
+#define RTE_IPV6_SET_FRAG_DATA(fo, mf) \
+       (((fo) & RTE_IPV6_EHDR_FO_MASK) | ((mf) & RTE_IPV6_EHDR_MF_MASK))
+
 struct ipv6_extension_fragment {
        uint8_t next_header;            /**< Next header type */
-       uint8_t reserved1;              /**< Reserved */
-       union {
-               struct {
-                       uint16_t frag_offset:13; /**< Offset from the start of the packet */
-                       uint16_t reserved2:2; /**< Reserved */
-                       uint16_t more_frags:1;
-                       /**< 1 if more fragments left, 0 if last fragment */
-               };
-               uint16_t frag_data;
-               /**< union of all fragmentation data */
-       };
+       uint8_t reserved;               /**< Reserved */
+       uint16_t frag_data;             /**< All fragmentation data */
        uint32_t id;                    /**< Packet ID */
 } __attribute__((__packed__));
 
 
 
-/*
+/**
  * Create a new IP fragmentation table.
  *
  * @param bucket_num
@@ -162,17 +158,14 @@ struct rte_ip_frag_tbl * rte_ip_frag_table_create(uint32_t bucket_num,
                uint32_t bucket_entries,  uint32_t max_entries,
                uint64_t max_cycles, int socket_id);
 
-/*
+/**
  * Free allocated IP fragmentation table.
  *
- * @param btl
+ * @param tbl
  *   Fragmentation table to free.
  */
-static inline void
-rte_ip_frag_table_destroy( struct rte_ip_frag_tbl *tbl)
-{
-       rte_free(tbl);
-}
+void
+rte_ip_frag_table_destroy(struct rte_ip_frag_tbl *tbl);
 
 /**
  * This function implements the fragmentation of IPv6 packets.
@@ -203,8 +196,7 @@ rte_ipv6_fragment_packet(struct rte_mbuf *pkt_in,
                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.
  *
@@ -222,15 +214,15 @@ rte_ipv6_fragment_packet(struct rte_mbuf *pkt_in,
  *   Pointer to the IPv6 fragment extension header.
  * @return
  *   Pointer to mbuf for reassembled packet, or NULL if:
- *   - an error occured.
+ *   - an error occurred.
  *   - 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 rte_mbuf *mb, uint64_t tms, struct rte_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.
@@ -242,7 +234,7 @@ struct rte_mbuf *rte_ipv6_frag_reassemble_packet(struct rte_ip_frag_tbl *tbl,
  *   present.
  */
 static inline struct ipv6_extension_fragment *
-rte_ipv6_frag_get_ipv6_fragment_header(struct ipv6_hdr *hdr)
+rte_ipv6_frag_get_ipv6_fragment_header(struct rte_ipv6_hdr *hdr)
 {
        if (hdr->proto == IPPROTO_FRAGMENT) {
                return (struct ipv6_extension_fragment *) ++hdr;
@@ -280,9 +272,9 @@ int32_t rte_ipv4_fragment_packet(struct rte_mbuf *pkt_in,
                        struct rte_mempool *pool_direct,
                        struct rte_mempool *pool_indirect);
 
-/*
+/**
  * This function implements reassembly of fragmented IPv4 packets.
- * Incoming mbufs should have its l2_len/l3_len fields setup correclty.
+ * Incoming mbufs should have its l2_len/l3_len fields setup correctly.
  *
  * @param tbl
  *   Table where to lookup/add the fragmented packet.
@@ -295,15 +287,15 @@ int32_t rte_ipv4_fragment_packet(struct rte_mbuf *pkt_in,
  * @param ip_hdr
  *   Pointer to the IPV4 header inside the fragment.
  * @return
- *   Pointer to mbuf for reassebled packet, or NULL if:
- *   - an error occured.
+ *   Pointer to mbuf for reassembled packet, or NULL if:
+ *   - an error occurred.
  *   - not all fragments of the packet are collected yet.
  */
 struct rte_mbuf * rte_ipv4_frag_reassemble_packet(struct rte_ip_frag_tbl *tbl,
                struct rte_ip_frag_death_row *dr,
-               struct rte_mbuf *mb, uint64_t tms, struct ipv4_hdr *ip_hdr);
+               struct rte_mbuf *mb, uint64_t tms, struct rte_ipv4_hdr *ip_hdr);
 
-/*
+/**
  * Check if the IPv4 packet is fragmented
  *
  * @param hdr
@@ -312,17 +304,18 @@ struct rte_mbuf * rte_ipv4_frag_reassemble_packet(struct rte_ip_frag_tbl *tbl,
  *   1 if fragmented, 0 if not fragmented
  */
 static inline int
-rte_ipv4_frag_pkt_is_fragmented(const struct ipv4_hdr * hdr) {
+rte_ipv4_frag_pkt_is_fragmented(const struct rte_ipv4_hdr *hdr)
+{
        uint16_t flag_offset, ip_flag, ip_ofs;
 
        flag_offset = rte_be_to_cpu_16(hdr->fragment_offset);
-       ip_ofs = (uint16_t)(flag_offset & IPV4_HDR_OFFSET_MASK);
-       ip_flag = (uint16_t)(flag_offset & IPV4_HDR_MF_FLAG);
+       ip_ofs = (uint16_t)(flag_offset & RTE_IPV4_HDR_OFFSET_MASK);
+       ip_flag = (uint16_t)(flag_offset & RTE_IPV4_HDR_MF_FLAG);
 
        return ip_flag != 0 || ip_ofs  != 0;
 }
 
-/*
+/**
  * Free mbufs on a given death row.
  *
  * @param dr
@@ -334,7 +327,7 @@ void rte_ip_frag_free_death_row(struct rte_ip_frag_death_row *dr,
                uint32_t prefetch);
 
 
-/*
+/**
  * Dump fragmentation table statistics to file.
  *
  * @param f
@@ -345,4 +338,22 @@ 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);
 
+/**
+ * Delete expired fragments
+ *
+ * @param tbl
+ *   Table to delete expired fragments from
+ * @param dr
+ *   Death row to free buffers to
+ * @param tms
+ *   Current timestamp
+ */
+void __rte_experimental
+rte_frag_table_del_expired_entries(struct rte_ip_frag_tbl *tbl,
+       struct rte_ip_frag_death_row *dr, uint64_t tms);
+
+#ifdef __cplusplus
+}
+#endif
+
 #endif /* _RTE_IP_FRAG_H_ */