rte_flow.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright 2016 6WIND S.A.
 * Copyright 2016 Mellanox Technologies, Ltd
 */

#ifndef RTE_FLOW_H_
#define RTE_FLOW_H_

#include <stddef.h>
#include <stdint.h>

#include <rte_arp.h>
#include <rte_ether.h>
#include <rte_eth_ctrl.h>
#include <rte_icmp.h>
#include <rte_ip.h>
#include <rte_sctp.h>
#include <rte_tcp.h>
#include <rte_udp.h>
#include <rte_byteorder.h>
#include <rte_esp.h>

#ifdef __cplusplus
extern "C" {
#endif

struct rte_flow_attr {
    uint32_t group; 
    uint32_t priority; 
    uint32_t ingress:1; 
    uint32_t egress:1; 
    uint32_t transfer:1;
    uint32_t reserved:29; 
};

enum rte_flow_item_type {
    RTE_FLOW_ITEM_TYPE_END,

    RTE_FLOW_ITEM_TYPE_VOID,

    RTE_FLOW_ITEM_TYPE_INVERT,

    RTE_FLOW_ITEM_TYPE_ANY,

    RTE_FLOW_ITEM_TYPE_PF,

    RTE_FLOW_ITEM_TYPE_VF,

    RTE_FLOW_ITEM_TYPE_PHY_PORT,

    RTE_FLOW_ITEM_TYPE_PORT_ID,

    RTE_FLOW_ITEM_TYPE_RAW,

    RTE_FLOW_ITEM_TYPE_ETH,

    RTE_FLOW_ITEM_TYPE_VLAN,

    RTE_FLOW_ITEM_TYPE_IPV4,

    RTE_FLOW_ITEM_TYPE_IPV6,

    RTE_FLOW_ITEM_TYPE_ICMP,

    RTE_FLOW_ITEM_TYPE_UDP,

    RTE_FLOW_ITEM_TYPE_TCP,

    RTE_FLOW_ITEM_TYPE_SCTP,

    RTE_FLOW_ITEM_TYPE_VXLAN,

    RTE_FLOW_ITEM_TYPE_E_TAG,

    RTE_FLOW_ITEM_TYPE_NVGRE,

    RTE_FLOW_ITEM_TYPE_MPLS,

    RTE_FLOW_ITEM_TYPE_GRE,

    RTE_FLOW_ITEM_TYPE_FUZZY,

    RTE_FLOW_ITEM_TYPE_GTP,

    RTE_FLOW_ITEM_TYPE_GTPC,

    RTE_FLOW_ITEM_TYPE_GTPU,

    RTE_FLOW_ITEM_TYPE_ESP,

    RTE_FLOW_ITEM_TYPE_GENEVE,

    RTE_FLOW_ITEM_TYPE_VXLAN_GPE,

    RTE_FLOW_ITEM_TYPE_ARP_ETH_IPV4,

    RTE_FLOW_ITEM_TYPE_IPV6_EXT,

    RTE_FLOW_ITEM_TYPE_ICMP6,

    RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS,

    RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA,

    RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT,

    RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_SLA_ETH,

    RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_TLA_ETH,

    RTE_FLOW_ITEM_TYPE_MARK,
};

struct rte_flow_item_any {
    uint32_t num; 
};

#ifndef __cplusplus
static const struct rte_flow_item_any rte_flow_item_any_mask = {
    .num = 0x00000000,
};
#endif

struct rte_flow_item_vf {
    uint32_t id; 
};

#ifndef __cplusplus
static const struct rte_flow_item_vf rte_flow_item_vf_mask = {
    .id = 0x00000000,
};
#endif

struct rte_flow_item_phy_port {
    uint32_t index; 
};

#ifndef __cplusplus
static const struct rte_flow_item_phy_port rte_flow_item_phy_port_mask = {
    .index = 0x00000000,
};
#endif

struct rte_flow_item_port_id {
    uint32_t id; 
};

#ifndef __cplusplus
static const struct rte_flow_item_port_id rte_flow_item_port_id_mask = {
    .id = 0xffffffff,
};
#endif

struct rte_flow_item_raw {
    uint32_t relative:1; 
    uint32_t search:1; 
    uint32_t reserved:30; 
    int32_t offset; 
    uint16_t limit; 
    uint16_t length; 
    const uint8_t *pattern; 
};

#ifndef __cplusplus
static const struct rte_flow_item_raw rte_flow_item_raw_mask = {
    .relative = 1,
    .search = 1,
    .reserved = 0x3fffffff,
    .offset = 0xffffffff,
    .limit = 0xffff,
    .length = 0xffff,
    .pattern = NULL,
};
#endif

struct rte_flow_item_eth {
    struct ether_addr dst; 
    struct ether_addr src; 
    rte_be16_t type; 
};

#ifndef __cplusplus
static const struct rte_flow_item_eth rte_flow_item_eth_mask = {
    .dst.addr_bytes = "\xff\xff\xff\xff\xff\xff",
    .src.addr_bytes = "\xff\xff\xff\xff\xff\xff",
    .type = RTE_BE16(0x0000),
};
#endif

struct rte_flow_item_vlan {
    rte_be16_t tci; 
    rte_be16_t inner_type; 
};

#ifndef __cplusplus
static const struct rte_flow_item_vlan rte_flow_item_vlan_mask = {
    .tci = RTE_BE16(0x0fff),
    .inner_type = RTE_BE16(0x0000),
};
#endif

struct rte_flow_item_ipv4 {
    struct ipv4_hdr hdr; 
};

#ifndef __cplusplus
static const struct rte_flow_item_ipv4 rte_flow_item_ipv4_mask = {
    .hdr = {
        .src_addr = RTE_BE32(0xffffffff),
        .dst_addr = RTE_BE32(0xffffffff),
    },
};
#endif

struct rte_flow_item_ipv6 {
    struct ipv6_hdr hdr; 
};

#ifndef __cplusplus
static const struct rte_flow_item_ipv6 rte_flow_item_ipv6_mask = {
    .hdr = {
        .src_addr =
            "\xff\xff\xff\xff\xff\xff\xff\xff"
            "\xff\xff\xff\xff\xff\xff\xff\xff",
        .dst_addr =
            "\xff\xff\xff\xff\xff\xff\xff\xff"
            "\xff\xff\xff\xff\xff\xff\xff\xff",
    },
};
#endif

struct rte_flow_item_icmp {
    struct icmp_hdr hdr; 
};

#ifndef __cplusplus
static const struct rte_flow_item_icmp rte_flow_item_icmp_mask = {
    .hdr = {
        .icmp_type = 0xff,
        .icmp_code = 0xff,
    },
};
#endif

struct rte_flow_item_udp {
    struct udp_hdr hdr; 
};

#ifndef __cplusplus
static const struct rte_flow_item_udp rte_flow_item_udp_mask = {
    .hdr = {
        .src_port = RTE_BE16(0xffff),
        .dst_port = RTE_BE16(0xffff),
    },
};
#endif

struct rte_flow_item_tcp {
    struct tcp_hdr hdr; 
};

#ifndef __cplusplus
static const struct rte_flow_item_tcp rte_flow_item_tcp_mask = {
    .hdr = {
        .src_port = RTE_BE16(0xffff),
        .dst_port = RTE_BE16(0xffff),
    },
};
#endif

struct rte_flow_item_sctp {
    struct sctp_hdr hdr; 
};

#ifndef __cplusplus
static const struct rte_flow_item_sctp rte_flow_item_sctp_mask = {
    .hdr = {
        .src_port = RTE_BE16(0xffff),
        .dst_port = RTE_BE16(0xffff),
    },
};
#endif

struct rte_flow_item_vxlan {
    uint8_t flags; 
    uint8_t rsvd0[3]; 
    uint8_t vni[3]; 
    uint8_t rsvd1; 
};

#ifndef __cplusplus
static const struct rte_flow_item_vxlan rte_flow_item_vxlan_mask = {
    .vni = "\xff\xff\xff",
};
#endif

struct rte_flow_item_e_tag {
    rte_be16_t epcp_edei_in_ecid_b;
    rte_be16_t rsvd_grp_ecid_b;
    uint8_t in_ecid_e; 
    uint8_t ecid_e; 
    rte_be16_t inner_type; 
};

#ifndef __cplusplus
static const struct rte_flow_item_e_tag rte_flow_item_e_tag_mask = {
    .rsvd_grp_ecid_b = RTE_BE16(0x3fff),
};
#endif

struct rte_flow_item_nvgre {
    rte_be16_t c_k_s_rsvd0_ver;
    rte_be16_t protocol; 
    uint8_t tni[3]; 
    uint8_t flow_id; 
};

#ifndef __cplusplus
static const struct rte_flow_item_nvgre rte_flow_item_nvgre_mask = {
    .tni = "\xff\xff\xff",
};
#endif

struct rte_flow_item_mpls {
    uint8_t label_tc_s[3];
    uint8_t ttl; 
};

#ifndef __cplusplus
static const struct rte_flow_item_mpls rte_flow_item_mpls_mask = {
    .label_tc_s = "\xff\xff\xf0",
};
#endif

struct rte_flow_item_gre {
    rte_be16_t c_rsvd0_ver;
    rte_be16_t protocol; 
};

#ifndef __cplusplus
static const struct rte_flow_item_gre rte_flow_item_gre_mask = {
    .protocol = RTE_BE16(0xffff),
};
#endif

struct rte_flow_item_fuzzy {
    uint32_t thresh; 
};

#ifndef __cplusplus
static const struct rte_flow_item_fuzzy rte_flow_item_fuzzy_mask = {
    .thresh = 0xffffffff,
};
#endif

struct rte_flow_item_gtp {
    uint8_t v_pt_rsv_flags;
    uint8_t msg_type; 
    rte_be16_t msg_len; 
    rte_be32_t teid; 
};

#ifndef __cplusplus
static const struct rte_flow_item_gtp rte_flow_item_gtp_mask = {
    .teid = RTE_BE32(0xffffffff),
};
#endif

struct rte_flow_item_esp {
    struct esp_hdr hdr; 
};

#ifndef __cplusplus
static const struct rte_flow_item_esp rte_flow_item_esp_mask = {
    .hdr = {
        .spi = 0xffffffff,
    },
};
#endif

struct rte_flow_item_geneve {
    rte_be16_t ver_opt_len_o_c_rsvd0;
    rte_be16_t protocol; 
    uint8_t vni[3]; 
    uint8_t rsvd1; 
};

#ifndef __cplusplus
static const struct rte_flow_item_geneve rte_flow_item_geneve_mask = {
    .vni = "\xff\xff\xff",
};
#endif

struct rte_flow_item_vxlan_gpe {
    uint8_t flags; 
    uint8_t rsvd0[2]; 
    uint8_t protocol; 
    uint8_t vni[3]; 
    uint8_t rsvd1; 
};

#ifndef __cplusplus
static const struct rte_flow_item_vxlan_gpe rte_flow_item_vxlan_gpe_mask = {
    .vni = "\xff\xff\xff",
};
#endif

struct rte_flow_item_arp_eth_ipv4 {
    rte_be16_t hrd; 
    rte_be16_t pro; 
    uint8_t hln; 
    uint8_t pln; 
    rte_be16_t op; 
    struct ether_addr sha; 
    rte_be32_t spa; 
    struct ether_addr tha; 
    rte_be32_t tpa; 
};

#ifndef __cplusplus
static const struct rte_flow_item_arp_eth_ipv4
rte_flow_item_arp_eth_ipv4_mask = {
    .sha.addr_bytes = "\xff\xff\xff\xff\xff\xff",
    .spa = RTE_BE32(0xffffffff),
    .tha.addr_bytes = "\xff\xff\xff\xff\xff\xff",
    .tpa = RTE_BE32(0xffffffff),
};
#endif

struct rte_flow_item_ipv6_ext {
    uint8_t next_hdr; 
};

#ifndef __cplusplus
static const
struct rte_flow_item_ipv6_ext rte_flow_item_ipv6_ext_mask = {
    .next_hdr = 0xff,
};
#endif

struct rte_flow_item_icmp6 {
    uint8_t type; 
    uint8_t code; 
    uint16_t checksum; 
};

#ifndef __cplusplus
static const struct rte_flow_item_icmp6 rte_flow_item_icmp6_mask = {
    .type = 0xff,
    .code = 0xff,
};
#endif

struct rte_flow_item_icmp6_nd_ns {
    uint8_t type; 
    uint8_t code; 
    rte_be16_t checksum; 
    rte_be32_t reserved; 
    uint8_t target_addr[16]; 
};

#ifndef __cplusplus
static const
struct rte_flow_item_icmp6_nd_ns rte_flow_item_icmp6_nd_ns_mask = {
    .target_addr =
        "\xff\xff\xff\xff\xff\xff\xff\xff"
        "\xff\xff\xff\xff\xff\xff\xff\xff",
};
#endif

struct rte_flow_item_icmp6_nd_na {
    uint8_t type; 
    uint8_t code; 
    rte_be16_t checksum; 
    rte_be32_t rso_reserved;
    uint8_t target_addr[16]; 
};

#ifndef __cplusplus
static const
struct rte_flow_item_icmp6_nd_na rte_flow_item_icmp6_nd_na_mask = {
    .target_addr =
        "\xff\xff\xff\xff\xff\xff\xff\xff"
        "\xff\xff\xff\xff\xff\xff\xff\xff",
};
#endif

struct rte_flow_item_icmp6_nd_opt {
    uint8_t type; 
    uint8_t length; 
};

#ifndef __cplusplus
static const struct rte_flow_item_icmp6_nd_opt
rte_flow_item_icmp6_nd_opt_mask = {
    .type = 0xff,
};
#endif

struct rte_flow_item_icmp6_nd_opt_sla_eth {
    uint8_t type; 
    uint8_t length; 
    struct ether_addr sla; 
};

#ifndef __cplusplus
static const struct rte_flow_item_icmp6_nd_opt_sla_eth
rte_flow_item_icmp6_nd_opt_sla_eth_mask = {
    .sla.addr_bytes = "\xff\xff\xff\xff\xff\xff",
};
#endif

struct rte_flow_item_icmp6_nd_opt_tla_eth {
    uint8_t type; 
    uint8_t length; 
    struct ether_addr tla; 
};

#ifndef __cplusplus
static const struct rte_flow_item_icmp6_nd_opt_tla_eth
rte_flow_item_icmp6_nd_opt_tla_eth_mask = {
    .tla.addr_bytes = "\xff\xff\xff\xff\xff\xff",
};
#endif

struct rte_flow_item_mark {
    uint32_t id; 
};

struct rte_flow_item {
    enum rte_flow_item_type type; 
    const void *spec; 
    const void *last; 
    const void *mask; 
};

enum rte_flow_action_type {
    RTE_FLOW_ACTION_TYPE_END,

    RTE_FLOW_ACTION_TYPE_VOID,

    RTE_FLOW_ACTION_TYPE_PASSTHRU,

    RTE_FLOW_ACTION_TYPE_JUMP,

    RTE_FLOW_ACTION_TYPE_MARK,

    RTE_FLOW_ACTION_TYPE_FLAG,

    RTE_FLOW_ACTION_TYPE_QUEUE,

    RTE_FLOW_ACTION_TYPE_DROP,

    RTE_FLOW_ACTION_TYPE_COUNT,

    RTE_FLOW_ACTION_TYPE_RSS,

    RTE_FLOW_ACTION_TYPE_PF,

    RTE_FLOW_ACTION_TYPE_VF,

    RTE_FLOW_ACTION_TYPE_PHY_PORT,

    RTE_FLOW_ACTION_TYPE_PORT_ID,

    RTE_FLOW_ACTION_TYPE_METER,

    RTE_FLOW_ACTION_TYPE_SECURITY,

    RTE_FLOW_ACTION_TYPE_OF_SET_MPLS_TTL,

    RTE_FLOW_ACTION_TYPE_OF_DEC_MPLS_TTL,

    RTE_FLOW_ACTION_TYPE_OF_SET_NW_TTL,

    RTE_FLOW_ACTION_TYPE_OF_DEC_NW_TTL,

    RTE_FLOW_ACTION_TYPE_OF_COPY_TTL_OUT,

    RTE_FLOW_ACTION_TYPE_OF_COPY_TTL_IN,

    RTE_FLOW_ACTION_TYPE_OF_POP_VLAN,

    RTE_FLOW_ACTION_TYPE_OF_PUSH_VLAN,

    RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_VID,

    RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_PCP,

    RTE_FLOW_ACTION_TYPE_OF_POP_MPLS,

    RTE_FLOW_ACTION_TYPE_OF_PUSH_MPLS,

    RTE_FLOW_ACTION_TYPE_VXLAN_ENCAP,

    RTE_FLOW_ACTION_TYPE_VXLAN_DECAP,

    RTE_FLOW_ACTION_TYPE_NVGRE_ENCAP,

    RTE_FLOW_ACTION_TYPE_NVGRE_DECAP,
};

struct rte_flow_action_mark {
    uint32_t id; 
};

struct rte_flow_action_jump {
    uint32_t group;
};

struct rte_flow_action_queue {
    uint16_t index; 
};


struct rte_flow_action_count {
    uint32_t shared:1; 
    uint32_t reserved:31; 
    uint32_t id; 
};

struct rte_flow_query_count {
    uint32_t reset:1; 
    uint32_t hits_set:1; 
    uint32_t bytes_set:1; 
    uint32_t reserved:29; 
    uint64_t hits; 
    uint64_t bytes; 
};

struct rte_flow_action_rss {
    enum rte_eth_hash_function func; 
    uint32_t level;
    uint64_t types; 
    uint32_t key_len; 
    uint32_t queue_num; 
    const uint8_t *key; 
    const uint16_t *queue; 
};

struct rte_flow_action_vf {
    uint32_t original:1; 
    uint32_t reserved:31; 
    uint32_t id; 
};

struct rte_flow_action_phy_port {
    uint32_t original:1; 
    uint32_t reserved:31; 
    uint32_t index; 
};

struct rte_flow_action_port_id {
    uint32_t original:1; 
    uint32_t reserved:31; 
    uint32_t id; 
};

struct rte_flow_action_meter {
    uint32_t mtr_id; 
};

struct rte_flow_action_security {
    void *security_session; 
};

struct rte_flow_action_of_set_mpls_ttl {
    uint8_t mpls_ttl; 
};

struct rte_flow_action_of_set_nw_ttl {
    uint8_t nw_ttl; 
};

struct rte_flow_action_of_push_vlan {
    rte_be16_t ethertype; 
};

struct rte_flow_action_of_set_vlan_vid {
    rte_be16_t vlan_vid; 
};

struct rte_flow_action_of_set_vlan_pcp {
    uint8_t vlan_pcp; 
};

struct rte_flow_action_of_pop_mpls {
    rte_be16_t ethertype; 
};

struct rte_flow_action_of_push_mpls {
    rte_be16_t ethertype; 
};

struct rte_flow_action_vxlan_encap {
    struct rte_flow_item *definition;
};

struct rte_flow_action_nvgre_encap {
    struct rte_flow_item *definition;
};

/*
 * Definition of a single action.
 *
 * A list of actions is terminated by a END action.
 *
 * For simple actions without a configuration structure, conf remains NULL.
 */
struct rte_flow_action {
    enum rte_flow_action_type type; 
    const void *conf; 
};

struct rte_flow;

enum rte_flow_error_type {
    RTE_FLOW_ERROR_TYPE_NONE, 
    RTE_FLOW_ERROR_TYPE_UNSPECIFIED, 
    RTE_FLOW_ERROR_TYPE_HANDLE, 
    RTE_FLOW_ERROR_TYPE_ATTR_GROUP, 
    RTE_FLOW_ERROR_TYPE_ATTR_PRIORITY, 
    RTE_FLOW_ERROR_TYPE_ATTR_INGRESS, 
    RTE_FLOW_ERROR_TYPE_ATTR_EGRESS, 
    RTE_FLOW_ERROR_TYPE_ATTR_TRANSFER, 
    RTE_FLOW_ERROR_TYPE_ATTR, 
    RTE_FLOW_ERROR_TYPE_ITEM_NUM, 
    RTE_FLOW_ERROR_TYPE_ITEM_SPEC, 
    RTE_FLOW_ERROR_TYPE_ITEM_LAST, 
    RTE_FLOW_ERROR_TYPE_ITEM_MASK, 
    RTE_FLOW_ERROR_TYPE_ITEM, 
    RTE_FLOW_ERROR_TYPE_ACTION_NUM, 
    RTE_FLOW_ERROR_TYPE_ACTION_CONF, 
    RTE_FLOW_ERROR_TYPE_ACTION, 
};

struct rte_flow_error {
    enum rte_flow_error_type type; 
    const void *cause; 
    const char *message; 
};

int
rte_flow_validate(uint16_t port_id,
          const struct rte_flow_attr *attr,
          const struct rte_flow_item pattern[],
          const struct rte_flow_action actions[],
          struct rte_flow_error *error);

struct rte_flow *
rte_flow_create(uint16_t port_id,
        const struct rte_flow_attr *attr,
        const struct rte_flow_item pattern[],
        const struct rte_flow_action actions[],
        struct rte_flow_error *error);

int
rte_flow_destroy(uint16_t port_id,
         struct rte_flow *flow,
         struct rte_flow_error *error);

int
rte_flow_flush(uint16_t port_id,
           struct rte_flow_error *error);

int
rte_flow_query(uint16_t port_id,
           struct rte_flow *flow,
           const struct rte_flow_action *action,
           void *data,
           struct rte_flow_error *error);

int
rte_flow_isolate(uint16_t port_id, int set, struct rte_flow_error *error);

int
rte_flow_error_set(struct rte_flow_error *error,
           int code,
           enum rte_flow_error_type type,
           const void *cause,
           const char *message);

struct rte_flow_desc {
    size_t size; 
    struct rte_flow_attr attr; 
    struct rte_flow_item *items; 
    struct rte_flow_action *actions; 
    uint8_t data[]; 
};

size_t
rte_flow_copy(struct rte_flow_desc *fd, size_t len,
          const struct rte_flow_attr *attr,
          const struct rte_flow_item *items,
          const struct rte_flow_action *actions);

#ifdef __cplusplus
}
#endif

#endif /* RTE_FLOW_H_ */