rte_eth_ctrl.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_ETH_CTRL_H_
#define _RTE_ETH_CTRL_H_

#ifdef __cplusplus
extern "C" {
#endif

/*
 * A packet can be identified by hardware as different flow types. Different
 * NIC hardwares may support different flow types.
 * Basically, the NIC hardware identifies the flow type as deep protocol as
 * possible, and exclusively. For example, if a packet is identified as
 * 'RTE_ETH_FLOW_NONFRAG_IPV4_TCP', it will not be any of other flow types,
 * though it is an actual IPV4 packet.
 * Note that the flow types are used to define RSS offload types in
 * rte_ethdev.h.
 */
#define RTE_ETH_FLOW_UNKNOWN             0
#define RTE_ETH_FLOW_RAW                 1
#define RTE_ETH_FLOW_IPV4                2
#define RTE_ETH_FLOW_FRAG_IPV4           3
#define RTE_ETH_FLOW_NONFRAG_IPV4_TCP    4
#define RTE_ETH_FLOW_NONFRAG_IPV4_UDP    5
#define RTE_ETH_FLOW_NONFRAG_IPV4_SCTP   6
#define RTE_ETH_FLOW_NONFRAG_IPV4_OTHER  7
#define RTE_ETH_FLOW_IPV6                8
#define RTE_ETH_FLOW_FRAG_IPV6           9
#define RTE_ETH_FLOW_NONFRAG_IPV6_TCP   10
#define RTE_ETH_FLOW_NONFRAG_IPV6_UDP   11
#define RTE_ETH_FLOW_NONFRAG_IPV6_SCTP  12
#define RTE_ETH_FLOW_NONFRAG_IPV6_OTHER 13
#define RTE_ETH_FLOW_L2_PAYLOAD         14
#define RTE_ETH_FLOW_IPV6_EX            15
#define RTE_ETH_FLOW_IPV6_TCP_EX        16
#define RTE_ETH_FLOW_IPV6_UDP_EX        17
#define RTE_ETH_FLOW_MAX                18

enum rte_filter_type {
        RTE_ETH_FILTER_NONE = 0,
        RTE_ETH_FILTER_MACVLAN,
        RTE_ETH_FILTER_ETHERTYPE,
        RTE_ETH_FILTER_FLEXIBLE,
        RTE_ETH_FILTER_SYN,
        RTE_ETH_FILTER_NTUPLE,
        RTE_ETH_FILTER_TUNNEL,
        RTE_ETH_FILTER_FDIR,
        RTE_ETH_FILTER_HASH,
        RTE_ETH_FILTER_MAX
};

enum rte_filter_op {
        RTE_ETH_FILTER_NOP = 0,
        RTE_ETH_FILTER_ADD,      
        RTE_ETH_FILTER_UPDATE,   
        RTE_ETH_FILTER_DELETE,   
        RTE_ETH_FILTER_FLUSH,    
        RTE_ETH_FILTER_GET,      
        RTE_ETH_FILTER_SET,      
        RTE_ETH_FILTER_INFO,     
        RTE_ETH_FILTER_STATS,    
        RTE_ETH_FILTER_OP_MAX
};

enum rte_mac_filter_type {
        RTE_MAC_PERFECT_MATCH = 1, 
        RTE_MACVLAN_PERFECT_MATCH, 
        RTE_MAC_HASH_MATCH, 
        RTE_MACVLAN_HASH_MATCH,
};

struct rte_eth_mac_filter {
        uint8_t is_vf; 
        uint16_t dst_id; 
        enum rte_mac_filter_type filter_type; 
        struct ether_addr mac_addr;
};

#define RTE_ETHTYPE_FLAGS_MAC    0x0001 
#define RTE_ETHTYPE_FLAGS_DROP   0x0002 
struct rte_eth_ethertype_filter {
        struct ether_addr mac_addr;   
        uint16_t ether_type;          
        uint16_t flags;               
        uint16_t queue;               
};

#define RTE_FLEX_FILTER_MAXLEN  128     
#define RTE_FLEX_FILTER_MASK_SIZE       \
        (RTE_ALIGN(RTE_FLEX_FILTER_MAXLEN, CHAR_BIT) / CHAR_BIT)

struct rte_eth_flex_filter {
        uint16_t len;
        uint8_t bytes[RTE_FLEX_FILTER_MAXLEN];  
        uint8_t mask[RTE_FLEX_FILTER_MASK_SIZE];    
        uint8_t priority;
        uint16_t queue;       
};

struct rte_eth_syn_filter {
        uint8_t hig_pri;     
        uint16_t queue;      
};

#define RTE_NTUPLE_FLAGS_DST_IP    0x0001 
#define RTE_NTUPLE_FLAGS_SRC_IP    0x0002 
#define RTE_NTUPLE_FLAGS_DST_PORT  0x0004 
#define RTE_NTUPLE_FLAGS_SRC_PORT  0x0008 
#define RTE_NTUPLE_FLAGS_PROTO     0x0010 
#define RTE_NTUPLE_FLAGS_TCP_FLAG  0x0020 
#define RTE_5TUPLE_FLAGS ( \
                RTE_NTUPLE_FLAGS_DST_IP | \
                RTE_NTUPLE_FLAGS_SRC_IP | \
                RTE_NTUPLE_FLAGS_DST_PORT | \
                RTE_NTUPLE_FLAGS_SRC_PORT | \
                RTE_NTUPLE_FLAGS_PROTO)

#define RTE_2TUPLE_FLAGS ( \
                RTE_NTUPLE_FLAGS_DST_PORT | \
                RTE_NTUPLE_FLAGS_PROTO)

#define TCP_URG_FLAG 0x20
#define TCP_ACK_FLAG 0x10
#define TCP_PSH_FLAG 0x08
#define TCP_RST_FLAG 0x04
#define TCP_SYN_FLAG 0x02
#define TCP_FIN_FLAG 0x01
#define TCP_FLAG_ALL 0x3F

struct rte_eth_ntuple_filter {
        uint16_t flags;          
        uint32_t dst_ip;         
        uint32_t dst_ip_mask;    
        uint32_t src_ip;         
        uint32_t src_ip_mask;    
        uint16_t dst_port;       
        uint16_t dst_port_mask;  
        uint16_t src_port;       
        uint16_t src_port_mask;  
        uint8_t proto;           
        uint8_t proto_mask;      
        uint8_t tcp_flags;
        uint16_t priority;       
        uint16_t queue;          
};

enum rte_eth_tunnel_type {
        RTE_TUNNEL_TYPE_NONE = 0,
        RTE_TUNNEL_TYPE_VXLAN,
        RTE_TUNNEL_TYPE_GENEVE,
        RTE_TUNNEL_TYPE_TEREDO,
        RTE_TUNNEL_TYPE_NVGRE,
        RTE_TUNNEL_TYPE_MAX,
};

#define ETH_TUNNEL_FILTER_OMAC  0x01 
#define ETH_TUNNEL_FILTER_OIP   0x02 
#define ETH_TUNNEL_FILTER_TENID 0x04 
#define ETH_TUNNEL_FILTER_IMAC  0x08 
#define ETH_TUNNEL_FILTER_IVLAN 0x10 
#define ETH_TUNNEL_FILTER_IIP   0x20 
#define RTE_TUNNEL_FILTER_IMAC_IVLAN (ETH_TUNNEL_FILTER_IMAC | \
                                        ETH_TUNNEL_FILTER_IVLAN)
#define RTE_TUNNEL_FILTER_IMAC_IVLAN_TENID (ETH_TUNNEL_FILTER_IMAC | \
                                        ETH_TUNNEL_FILTER_IVLAN | \
                                        ETH_TUNNEL_FILTER_TENID)
#define RTE_TUNNEL_FILTER_IMAC_TENID (ETH_TUNNEL_FILTER_IMAC | \
                                        ETH_TUNNEL_FILTER_TENID)
#define RTE_TUNNEL_FILTER_OMAC_TENID_IMAC (ETH_TUNNEL_FILTER_OMAC | \
                                        ETH_TUNNEL_FILTER_TENID | \
                                        ETH_TUNNEL_FILTER_IMAC)

enum rte_tunnel_iptype {
        RTE_TUNNEL_IPTYPE_IPV4 = 0, 
        RTE_TUNNEL_IPTYPE_IPV6,     
};

struct rte_eth_tunnel_filter_conf {
        struct ether_addr *outer_mac;  
        struct ether_addr *inner_mac;  
        uint16_t inner_vlan;           
        enum rte_tunnel_iptype ip_type; 
        union {
                uint32_t ipv4_addr;    
                uint32_t ipv6_addr[4]; 
        } ip_addr; 
        uint16_t filter_type;   
        enum rte_eth_tunnel_type tunnel_type; 
        uint32_t tenant_id;     
        uint16_t queue_id;      
};

#define RTE_ETH_FDIR_MAX_FLEXLEN         16 
struct rte_eth_l2_flow {
        uint16_t ether_type;          
};

struct rte_eth_ipv4_flow {
        uint32_t src_ip;      
        uint32_t dst_ip;      
};

struct rte_eth_udpv4_flow {
        struct rte_eth_ipv4_flow ip; 
        uint16_t src_port;           
        uint16_t dst_port;           
};

struct rte_eth_tcpv4_flow {
        struct rte_eth_ipv4_flow ip; 
        uint16_t src_port;           
        uint16_t dst_port;           
};

struct rte_eth_sctpv4_flow {
        struct rte_eth_ipv4_flow ip; 
#ifdef RTE_NEXT_ABI
        uint16_t src_port;           
        uint16_t dst_port;           
#endif
        uint32_t verify_tag;         
};

struct rte_eth_ipv6_flow {
        uint32_t src_ip[4];      
        uint32_t dst_ip[4];      
};

struct rte_eth_udpv6_flow {
        struct rte_eth_ipv6_flow ip; 
        uint16_t src_port;           
        uint16_t dst_port;           
};

struct rte_eth_tcpv6_flow {
        struct rte_eth_ipv6_flow ip; 
        uint16_t src_port;           
        uint16_t dst_port;           
};

struct rte_eth_sctpv6_flow {
        struct rte_eth_ipv6_flow ip; 
#ifdef RTE_NEXT_ABI
        uint16_t src_port;           
        uint16_t dst_port;           
#endif
        uint32_t verify_tag;         
};

union rte_eth_fdir_flow {
        struct rte_eth_l2_flow     l2_flow;
        struct rte_eth_udpv4_flow  udp4_flow;
        struct rte_eth_tcpv4_flow  tcp4_flow;
        struct rte_eth_sctpv4_flow sctp4_flow;
        struct rte_eth_ipv4_flow   ip4_flow;
        struct rte_eth_udpv6_flow  udp6_flow;
        struct rte_eth_tcpv6_flow  tcp6_flow;
        struct rte_eth_sctpv6_flow sctp6_flow;
        struct rte_eth_ipv6_flow   ipv6_flow;
};

struct rte_eth_fdir_flow_ext {
        uint16_t vlan_tci;
        uint8_t flexbytes[RTE_ETH_FDIR_MAX_FLEXLEN];
};

struct rte_eth_fdir_input {
        uint16_t flow_type;
        union rte_eth_fdir_flow flow;
        struct rte_eth_fdir_flow_ext flow_ext;
};

enum rte_eth_fdir_behavior {
        RTE_ETH_FDIR_ACCEPT = 0,
        RTE_ETH_FDIR_REJECT,
};

enum rte_eth_fdir_status {
        RTE_ETH_FDIR_NO_REPORT_STATUS = 0, 
        RTE_ETH_FDIR_REPORT_ID,            
        RTE_ETH_FDIR_REPORT_ID_FLEX_4,     
        RTE_ETH_FDIR_REPORT_FLEX_8,        
};

struct rte_eth_fdir_action {
        uint16_t rx_queue;        
        enum rte_eth_fdir_behavior behavior;     
        enum rte_eth_fdir_status report_status;  
        uint8_t flex_off;
};

struct rte_eth_fdir_filter {
        uint32_t soft_id;
        struct rte_eth_fdir_input input;    
        struct rte_eth_fdir_action action;  
};

struct rte_eth_fdir_masks {
        uint16_t vlan_tci_mask;
        struct rte_eth_ipv4_flow   ipv4_mask;
        struct rte_eth_ipv6_flow   ipv6_mask;
        uint16_t src_port_mask;
        uint16_t dst_port_mask;
};

enum rte_eth_payload_type {
        RTE_ETH_PAYLOAD_UNKNOWN = 0,
        RTE_ETH_RAW_PAYLOAD,
        RTE_ETH_L2_PAYLOAD,
        RTE_ETH_L3_PAYLOAD,
        RTE_ETH_L4_PAYLOAD,
        RTE_ETH_PAYLOAD_MAX = 8,
};

struct rte_eth_flex_payload_cfg {
        enum rte_eth_payload_type type;  
        uint16_t src_offset[RTE_ETH_FDIR_MAX_FLEXLEN];
};

struct rte_eth_fdir_flex_mask {
        uint16_t flow_type;
        uint8_t mask[RTE_ETH_FDIR_MAX_FLEXLEN];
};

struct rte_eth_fdir_flex_conf {
        uint16_t nb_payloads;  
        uint16_t nb_flexmasks; 
        struct rte_eth_flex_payload_cfg flex_set[RTE_ETH_PAYLOAD_MAX];
        struct rte_eth_fdir_flex_mask flex_mask[RTE_ETH_FLOW_MAX];
};

enum rte_fdir_mode {
        RTE_FDIR_MODE_NONE      = 0, 
        RTE_FDIR_MODE_SIGNATURE,     
        RTE_FDIR_MODE_PERFECT,       
};

#define UINT32_BIT (CHAR_BIT * sizeof(uint32_t))
#define RTE_FLOW_MASK_ARRAY_SIZE \
        (RTE_ALIGN(RTE_ETH_FLOW_MAX, UINT32_BIT)/UINT32_BIT)

struct rte_eth_fdir_info {
        enum rte_fdir_mode mode; 
        struct rte_eth_fdir_masks mask;
        struct rte_eth_fdir_flex_conf flex_conf;
        uint32_t guarant_spc; 
        uint32_t best_spc; 
        uint32_t flow_types_mask[RTE_FLOW_MASK_ARRAY_SIZE];
        uint32_t max_flexpayload; 
        uint32_t flex_payload_unit;
        uint32_t max_flex_payload_segment_num;
        uint16_t flex_payload_limit;
        uint32_t flex_bitmask_unit;
        uint32_t max_flex_bitmask_num;
};

struct rte_eth_fdir_stats {
        uint32_t collision;    
        uint32_t free;         
        uint32_t maxhash;
        uint32_t maxlen;       
        uint64_t add;          
        uint64_t remove;       
        uint64_t f_add;        
        uint64_t f_remove;     
        uint32_t guarant_cnt;  
        uint32_t best_cnt;     
};

enum rte_eth_hash_filter_info_type {
        RTE_ETH_HASH_FILTER_INFO_TYPE_UNKNOWN = 0,
        RTE_ETH_HASH_FILTER_SYM_HASH_ENA_PER_PORT,
        RTE_ETH_HASH_FILTER_GLOBAL_CONFIG,
        RTE_ETH_HASH_FILTER_INFO_TYPE_MAX,
};

enum rte_eth_hash_function {
        RTE_ETH_HASH_FUNCTION_DEFAULT = 0,
        RTE_ETH_HASH_FUNCTION_TOEPLITZ, 
        RTE_ETH_HASH_FUNCTION_SIMPLE_XOR, 
        RTE_ETH_HASH_FUNCTION_MAX,
};

#define RTE_SYM_HASH_MASK_ARRAY_SIZE \
        (RTE_ALIGN(RTE_ETH_FLOW_MAX, UINT32_BIT)/UINT32_BIT)

struct rte_eth_hash_global_conf {
        enum rte_eth_hash_function hash_func; 
        uint32_t sym_hash_enable_mask[RTE_SYM_HASH_MASK_ARRAY_SIZE];
        uint32_t valid_bit_mask[RTE_SYM_HASH_MASK_ARRAY_SIZE];
};

struct rte_eth_hash_filter_info {
        enum rte_eth_hash_filter_info_type info_type; 
        union {
                uint8_t enable;
                struct rte_eth_hash_global_conf global_conf;
        } info;
};

#ifdef __cplusplus
}
#endif

#endif /* _RTE_ETH_CTRL_H_ */