rte_ip_frag.h

Go to the documentation of this file.

/*-
 *   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.
 */

#ifndef _RTE_IP_FRAG_H_
#define _RTE_IP_FRAG_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdio.h>

#include <rte_config.h>
#include <rte_malloc.h>
#include <rte_memory.h>
#include <rte_ip.h>
#include <rte_byteorder.h>

struct rte_mbuf;

enum {
    IP_LAST_FRAG_IDX,    
    IP_FIRST_FRAG_IDX,   
    IP_MIN_FRAG_NUM,     
    IP_MAX_FRAG_NUM = RTE_LIBRTE_IP_FRAG_MAX_FRAG,
};

struct ip_frag {
    uint16_t ofs;          
    uint16_t len;          
    struct rte_mbuf *mb;   
};

struct ip_frag_key {
    uint64_t src_dst[4];
    RTE_STD_C11
    union {
        uint64_t id_key_len; 
        __extension__
        struct {
            uint32_t id;       
            uint32_t key_len;  
        };
    };
};

struct ip_frag_pkt {
    TAILQ_ENTRY(ip_frag_pkt) lru;   
    struct ip_frag_key key;           
    uint64_t             start;       
    uint32_t             total_size;  
    uint32_t             frag_size;   
    uint32_t             last_idx;    
    struct ip_frag       frags[IP_MAX_FRAG_NUM]; 
} __rte_cache_aligned;

#define IP_FRAG_DEATH_ROW_LEN 32 
struct rte_ip_frag_death_row {
    uint32_t cnt;          
    struct rte_mbuf *row[IP_FRAG_DEATH_ROW_LEN * (IP_MAX_FRAG_NUM + 1)];
};

TAILQ_HEAD(ip_pkt_list, ip_frag_pkt); 
struct ip_frag_tbl_stat {
    uint64_t find_num;      
    uint64_t add_num;       
    uint64_t del_num;       
    uint64_t reuse_num;     
    uint64_t fail_total;    
    uint64_t fail_nospace;  
} __rte_cache_aligned;

struct rte_ip_frag_tbl {
    uint64_t             max_cycles;      
    uint32_t             entry_mask;      
    uint32_t             max_entries;     
    uint32_t             use_entries;     
    uint32_t             bucket_entries;  
    uint32_t             nb_entries;      
    uint32_t             nb_buckets;      
    struct ip_frag_pkt *last;         
    struct ip_pkt_list lru;           
    struct ip_frag_tbl_stat stat;     
    __extension__ struct ip_frag_pkt pkt[0]; 
};

#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_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;            
    uint8_t reserved;               
    uint16_t frag_data;             
    uint32_t id;                    
} __attribute__((__packed__));



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);

void
rte_ip_frag_table_destroy(struct rte_ip_frag_tbl *tbl);

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);

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);

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;
}

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,
            struct rte_mempool *pool_indirect);

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);

static inline int
rte_ipv4_frag_pkt_is_fragmented(const struct 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);

    return ip_flag != 0 || ip_ofs  != 0;
}

void rte_ip_frag_free_death_row(struct rte_ip_frag_death_row *dr,
        uint32_t prefetch);


void
rte_ip_frag_table_statistics_dump(FILE * f, const struct rte_ip_frag_tbl *tbl);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_IP_FRAG_H_ */